- Version 3
- Authentication
- Shipments
- Invoice
- Tracking
- StaticData
- Authentication
- Version 2
- Recommended Workflow
- Additional Offerings
- Changelog
- Exports and Webhooks
Get multiple invoices
GET
/api/v3/Invoices
Invoice
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
ProNumber
string
optional
BolNumber
string
optional
LoadId
integer
optional
CreatedStartDate
string
optional
CreatedEndDate
string
optional
PickupStartDate
string
optional
PickupEndDate
string
optional
DeliveredStartDate
string
optional
DeliveredEndDate
string
optional
BillingStartDate
string
optional
BillingEndDate
string
optional
InvoiceStatus
string
optional
ExcludeExported
boolean
optional
OrderBy
string
optional
PageSize
integer
optional
<= 50
Default:
10
PageNumber
integer
optional
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
carrierName
string | null
optional
carrierScac
string | null
optional
clientName
string | null
optional
clientReferenceNumber
string | null
optional
currencyCode
string | null
optional
invoiceStatusCode
string | null
optional
invoiceType
string | null
optional
netAmountDue
number <double> | null
optional
totalCharges
number <double> | null
optional
vendorId
integer <int32> | null
optional
vendorName
string | null
optional
ediType
string | null
optional
ediBillToAccountCode
string | null
optional
hasException
boolean
optional
shipmentCreatedFromInvoice
boolean
optional
createdDate
string <date-time> | null
optional
exportedDate
string <date-time> | null
optional
billingDate
string <date-time> | null
optional
pickupDate
string <date-time> | null
optional
deliveryDate
string <date-time> | null
optional
bolAvailable
boolean | null
optional
podAvailable
boolean | null
optional
batchDetails
object (BanyanWebServices.Domain.Dtos.Invoices.BatchDetailsDto)
optional
batchId
string | null
optional
batchDate
string <date-time> | null
optional
user
string | null
optional
shipmentDetails
object (BanyanWebServices.Domain.Dtos.Invoices.ShipmentDetailsDto)
optional
bolNumber
string | null
optional
customerPo
string | null
optional
proNumber
string | null
optional
loadId
integer <int32> | null
optional
externalLoadId
string <uuid> | null
optional
payType
string | null
optional
totalPieces
integer <int32> | null
optional
totalWeight
number <double> | null
optional
weightUnitOfMeasure
string | null
optional
quoteDetails
object (BanyanWebServices.Domain.Dtos.Invoices.QuoteDetailsDto)
optional
quoteNumber
string | null
optional
date
string <date-time> | null
optional
interline
boolean | null
optional
carrierName
string | null
optional
carrierScac
string | null
optional
discountAmount
number <double> | null
optional
discountPercent
number <double> | null
optional
freightCharge
number <double> | null
optional
grossCharge
number <double> | null
optional
fuelSurcharge
number <double> | null
optional
minimum
number <double> | null
optional
totalAccessorialCharges
number <double> | null
optional
totalOtherCharges
number <double> | null
optional
totalCharge
number <double> | null
optional
variance
number <double> | null
optional
lineItems
array[object (BanyanWebServices.Domain.Dtos.Invoices.InvoiceLineItemDto) {11}] | null
optional
carrierChargeCode
string | null
optional
charge
number <double> | null
optional
description
string | null
optional
extension
string | null
optional
freightClass
string | null
optional
normalizedChargeCode
string | null
optional
packagingCode
string | null
optional
quantity
integer <int32> | null
optional
weight
number <double> | null
optional
ratedAsQuantity
number <double> | null
optional
ratedAsQualifier
string | null
optional
payments
array[object (BanyanWebServices.Domain.Dtos.Invoices.PaymentDto) {6}] | null
optional
amount
number <double> | null
optional
batchId
string | null
optional
identifier
string | null
optional
type
string | null
optional
user
string | null
optional
date
string <date-time> | null
optional
addresses
array[object (BanyanWebServices.Domain.Dtos.Invoices.InvoiceAddressDto) {10}] | null
optional
lineOne
string | null
optional
lineTwo
string | null
optional
city
string | null
optional
stateCode
string | null
optional
postalCode
string | null
optional
countryCode
string | null
optional
glCode
string | null
optional
idCode
string | null
optional
name
string | null
optional
type
string | null
optional
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