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
ClientReferenceNumber
string 
optional
Filter by client reference number
ProNumber
string 
optional
Filter by pro number.
BolNumber
string 
optional
Filter by bol number.
LoadId
integer 
optional
Filter by load id.
CreatedStartDate
string 
optional
Filter by created date range start
CreatedEndDate
string 
optional
Filter by created date range end
PickupStartDate
string 
optional
Filter by pickup date range start
PickupEndDate
string 
optional
Filter by pickup date range end
DeliveredStartDate
string 
optional
Filter by delivered date range start
DeliveredEndDate
string 
optional
Filter by delivered date range end
BillingStartDate
string 
optional
Filter by billing date range start
BillingEndDate
string 
optional
Filter by billing date range end
InvoiceStatus
string 
optional
Filter by invoice status.
ExcludeExported
boolean 
optional
True if exported invoices should be excluded, otherwise false.
OrderBy
string 
optional
Order by field
PageSize
integer 
optional
The number of items to return.
<= 50
Default:
10
PageNumber
integer 
optional
The page number of the results.

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

Responses

🟢200Success
application/json
Body
array of:
apId
integer <int32>
optional
Gets or sets the ap id.
carrierName
string  | null 
optional
Gets or sets carrier name.
carrierScac
string  | null 
optional
Gets or sets the carrier scac.
clientName
string  | null 
optional
Gets or sets the client name.
clientReferenceNumber
string  | null 
optional
Gets or sets the client reference number.
currencyCode
string  | null 
optional
Gets or sets the currency code.
invoiceStatusCode
string  | null 
optional
Gets or sets the invoice status code.
invoiceType
string  | null 
optional
Gets or sets the invoice type.
netAmountDue
number <double> | null 
optional
Gets or sets the net amount due.
totalCharges
number <double> | null 
optional
Gets or sets the total charges.
vendorId
integer <int32> | null 
optional
Gets or sets the vendor id.
vendorName
string  | null 
optional
Gets or sets the vendor name.
ediType
string  | null 
optional
Gets or sets the edi type.
ediBillToAccountCode
string  | null 
optional
Gets or sets the edit bill to account code.
hasException
boolean 
optional
True if the invoice has an exception, otherwise false.
shipmentCreatedFromInvoice
boolean 
optional
True if a shipment was created from the invoice, otherwise false.
createdDate
string <date-time> | null 
optional
Gets or sets the created date.
exportedDate
string <date-time> | null 
optional
Gets or sets the exported date.
billingDate
string <date-time> | null 
optional
Gets or sets the billing date.
pickupDate
string <date-time> | null 
optional
Gets or sets the pickup date.
deliveryDate
string <date-time> | null 
optional
Gets or sets the delivery date.
bolAvailable
boolean  | null 
optional
True if the bill of lading is available, otherwise false.
podAvailable
boolean  | null 
optional
True if the proof of delivery is available, otherwise false.
batchDetails
object (BanyanWebServices.Domain.Dtos.Invoices.BatchDetailsDto) 
optional
The batch details dto.
batchId
string  | null 
optional
Gets or sets the batch id.
batchDate
string <date-time> | null 
optional
Gets or sets the batch date.
user
string  | null 
optional
Gets or sets the user.
shipmentDetails
object (BanyanWebServices.Domain.Dtos.Invoices.ShipmentDetailsDto) 
optional
The shipment details dto.
bolNumber
string  | null 
optional
Gets or sets the bol number.
customerPo
string  | null 
optional
Gets or sets the customer po.
proNumber
string  | null 
optional
Gets or sets the pro number.
loadId
integer <int32> | null 
optional
Gets or sets the load id.
externalLoadId
string <uuid> | null 
optional
Gets or sets the external load id.
payType
string  | null 
optional
Gets or sets the pay type.
totalPieces
integer <int32> | null 
optional
Gets or sets the total pieces.
totalWeight
number <double> | null 
optional
Gets or sets the total weight.
weightUnitOfMeasure
string  | null 
optional
Gets or sets the weight unit of measure.
quoteDetails
object (BanyanWebServices.Domain.Dtos.Invoices.QuoteDetailsDto) 
optional
The quote details dto.
quoteNumber
string  | null 
optional
Gets or sets the quote number.
date
string <date-time> | null 
optional
Gets or sets the date.
interline
boolean  | null 
optional
True if the quote is interline, otherwise false.
carrierName
string  | null 
optional
Gets or sets the carrier name.
carrierScac
string  | null 
optional
Gets or sets the carrier scac.
discountAmount
number <double> | null 
optional
Gets or sets the discount amount.
discountPercent
number <double> | null 
optional
Gets or sets the discount percent.
freightCharge
number <double> | null 
optional
Gets or sets the freight charge.
grossCharge
number <double> | null 
optional
Gets or sets the gross charge.
fuelSurcharge
number <double> | null 
optional
The fuel surcharge.
minimum
number <double> | null 
optional
Gets or sets the minimum.
totalAccessorialCharges
number <double> | null 
optional
Gets or sets the total accessorial charges.
totalOtherCharges
number <double> | null 
optional
Gets or sets the total other charges.
totalCharge
number <double> | null 
optional
Gets or sets the total charge.
variance
number <double> | null 
optional
Gets or sets the variance.
lineItems
array[object (BanyanWebServices.Domain.Dtos.Invoices.InvoiceLineItemDto) {11}]  | null 
optional
Gets or sets the line items.
carrierChargeCode
string  | null 
optional
Gets or sets the carrier charge code.
charge
number <double> | null 
optional
Gets or sets the charge.
description
string  | null 
optional
Gets or sets the description.
extension
string  | null 
optional
Gets or sets the extension.
freightClass
string  | null 
optional
Gets or sets the freight class.
normalizedChargeCode
string  | null 
optional
Gets or sets the normalized charge code.
packagingCode
string  | null 
optional
Gets or sets the packaging code.
quantity
integer <int32> | null 
optional
Gets or sets the quantity.
weight
number <double> | null 
optional
Gets or sets the weight.
ratedAsQuantity
number <double> | null 
optional
Gets or sets the rated as quantity.
ratedAsQualifier
string  | null 
optional
Gets or sets the rated as qualifier.
payments
array[object (BanyanWebServices.Domain.Dtos.Invoices.PaymentDto) {6}]  | null 
optional
Gets or sets the payments.
amount
number <double> | null 
optional
Gets or sets the amount.
batchId
string  | null 
optional
Gets or sets the batch id.
identifier
string  | null 
optional
Gets or sets the identifier.
type
string  | null 
optional
Gets or sets the type.
user
string  | null 
optional
Gets or sets the user.
date
string <date-time> | null 
optional
Gets or sets the date.
addresses
array[object (BanyanWebServices.Domain.Dtos.Invoices.InvoiceAddressDto) {10}]  | null 
optional
Gets or sets the addresses.
lineOne
string  | null 
optional
Gets or sets line one.
lineTwo
string  | null 
optional
Gets or sets line two.
city
string  | null 
optional
Gets or sets the city.
stateCode
string  | null 
optional
Gets or sets the state code.
postalCode
string  | null 
optional
Gets or sets the postal code.
countryCode
string  | null 
optional
Gets or sets the country code.
glCode
string  | null 
optional
Gets or sets the GL code.
idCode
string  | null 
optional
Gets or sets the id code.
name
string  | null 
optional
Gets or sets the name.
type
string  | null 
optional
Gets or sets the type.
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