GetInvoices - Banyan Technology LIVE Connect™

This function will return invoices.

Request

Header Params

string

required

Example:

application/json

Body Params application/json

AuthenticationData

object (Authentication Data)

required

Banyan Credentials

Username

string

required

Banyan Username

Password

string

required

Banyan Password

ClientRefNum

string | null

optional

Client Reference Number - Used during multiple client integrations

IgnoreExported

boolean

optional

If set to true, will include exported invoices

ProNumber

string

optional

Pro number used to filter returned invoices

BOLID

string

optional

BOL number used to filter returned invoices

LoadId

integer

optional

Load Id used to filter returned invoices

DateFilterType

enum<string>

optional

Type used to filter with the Start and End Date

Allowed values:

CreatedPickupDeliveryBilling

StartDate

string <date>

optional

Start date for filtering

EndDate

string <date>

optional

End date for filtering

InvoiceStatusFilter

enum<string>

optional

Status used to filter returned invoices

Allowed values:

ApprovedCancelledDuplicatedPostedPrintedPaymentSentPublishedQueuedOpenPartialDisputedPaidClosedWriteOffExportedApprovedDisputedOpenDisputedExportedDisputedOpenRevEngDisputedReview

Example

{
  "AuthenticationData": {
    "Username": "username",
    "Password": "password",
    "ClientRefNum": null
  },
  "IgnoreExported": true,
  "ProNumber": "Pro",
  "BOLID": "BOL",
  "LoadId": 1234567,
  "DateFilterType": "Created",
  "StartDate": "2024-03-06",
  "EndDate": "2024-03-13",
  "InvoiceStatusFilter": "Approved"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200GetInvoices - 200 OK

application/json

Body

Invoices

array[object (InvoiceDetails) {29}]

required

A list of Invoices

ApID

integer

optional

Invoice's primary identifier (Banyan supplied)

EDIBillToAccountCode

string | null

optional

Default:

null

InvoiceType

string

optional

Type of Invoice (AP or AR)

ClientName

string

optional

The client that is linked to this AP

ClientReferenceNumber

string

optional

The referenced number used to refer to this client

InvoiceStatusCode

string

optional

Status of the invoice

NetAmountDue

number <float>

optional

Net amount due on invoice

TotalCharges

number <float>

optional

Total charges on invoice

Variance

number <float>

optional

Difference between actual and expected charges

CurrencyCode

string

optional

Type of currency used for invoice

CarrierName

string

optional

Name of carrier attached to invoice

CarrierSCAC

string

optional

SCAC of carrier attached to invoice

VendorName

string | null

optional

Name of vendor attached to invoice

VendorID

string | null

optional

Reference number used to refer to the vendor attached to the invoice

HasException

boolean

optional

Will return true if the invoice details do not match the load details

ShipmentCreatedFromInvoice

boolean

optional

Will return true if a load was created from this invoice

EDIType

string

optional

CreatedDateTime

string <date-time>

optional

Invoice created date

BillingDateTime

string <date-time>

optional

Invoice billing date

ExportedDateTime

string <date-time>

optional

Invoice exported date

ShipmentDetails

object (InvoiceLoadDetails)

optional

Load details

QuoteDetails

object (InvoiceQuoteDetails)

optional

Quote details

BatchDetails

object (InvoiceBatchDetails)

read-onlyoptional

Batch details

LineItem

array[object (InvoiceLineDetails) {11}]

optional

List of product lines for the shipment

Payment

array[object (InvoicePaymentDetails) {7}]

optional

List of payments for this shipment

Address

array[object (InvoiceAddressDetails) {10}]

optional

List of addresses associated to the invoice

BolAvailable

boolean

optional

True if the BOL is available

PodAvailable

boolean

optional

True if the POD is available

LoadDetails

object (FullLoadDetails)

optional

Included only in response for GetInvoicesWithLoadDetails

Success

boolean

required

Success of the request

Error

object (ErrorObject)

required

Errors related to the request

Message

string

required

Example

{
  "Invoices": [
    {
      "ApID": 3033722,
      "InvoiceType": "AP",
      "ClientName": "Company",
      "ClientReferenceNumber": "",
      "InvoiceStatusCode": "EXP",
      "NetAmountDue": 273.75,
      "TotalCharges": 228.75,
      "Variance": 0,
      "CurrencyCode": "USD",
      "CarrierName": "Trucing Company 3",
      "CarrierSCAC": "TRUK",
      "VendorName": null,
      "VendorID": null,
      "HasException": false,
      "ShipmentCreatedFromInvoice": false,
      "CreatedDateTime": "2018-05-01T14:34:46.81",
      "BillingDateTime": "2018-05-01T00:00:00",
      "ExportedDateTime": "2018-08-10T11:44:53.59",
      "ShipmentDetails": {
        "LoadID": 987654321,
        "GuidLoadID": "46f7-9840-1fc3ebc244a9",
        "ProNumber": "123PRO",
        "BOLID": "BOL18099",
        "CustomerPO": "test",
        "PayType": "Prepaid",
        "TotalWeight": 800,
        "TotalPieces": 1,
        "WeightUnitOfMeasure": "LBS",
        "PickupDateTime": "2018-04-10T00:00:00",
        "DeliveryDateTime": "2018-05-01T00:00:00"
      },
      "QuoteDetails": {
        "CarrierName": "R Trucking",
        "CarrierSCAC": "TRUK",
        "QuoteNumber": "10386905",
        "DateTime": "2018-04-09T06:15:56.553",
        "TotalCharge": 228.75,
        "FreightCharge": 184.33,
        "DiscountPercent": null,
        "DiscountAmount": null,
        "FuelSurcharge": 44.42,
        "Minimum": null,
        "GrossCharge": 1417.9,
        "TotalAccessorialCharges": 0,
        "TotalOtherCharges": 0,
        "Interline": false
      },
      "BatchDetails": {
        "BatchID": "05012018",
        "User": "Mike Jones",
        "DateTime": "2018-05-01T15:16:50.787"
      },
      "LineItem": [
        {
          "CarrierChargeCode": "MISC",
          "NormalizedChargeCode": "MISC",
          "Description": "Total Freight Bill Cost",
          "Quantity": 0,
          "PackagingCode": "",
          "Weight": 0,
          "Charge": 228.75,
          "FreightClass": "",
          "Extension": "Some Text",
          "RatedAsQuantity": 54.005,
          "RatedAsQualifier": "XX"
        },
        {
          "CarrierChargeCode": "MISC",
          "NormalizedChargeCode": "MISC",
          "Description": "test - do not pickup",
          "Quantity": 1,
          "PackagingCode": "Pallets",
          "Weight": 800,
          "Charge": 0,
          "FreightClass": "92.5",
          "Extension": "Some Text",
          "RatedAsQuantity": null,
          "RatedAsQualifier": null
        }
      ],
      "Payment": null,
      "Address": [
        {
          "Type": "SH",
          "Name": "Test Origin",
          "IDCode": null,
          "Address1": "123 Test St",
          "Address2": "",
          "City": "Chicago",
          "StateCode": "IL",
          "PostalCode": "60606",
          "CountryCode": "US",
          "GLCode": null
        },
        {
          "Type": "CN",
          "Name": "Test Destination",
          "IDCode": null,
          "Address1": "456 Test St",
          "Address2": "",
          "City": "Austinburg",
          "StateCode": "OH",
          "PostalCode": "44010",
          "CountryCode": "US",
          "GLCode": null
        },
        {
          "Type": "BT",
          "Name": "Company",
          "IDCode": null,
          "Address1": "123 Main St.",
          "Address2": "",
          "City": "Cleveland",
          "StateCode": "OH",
          "PostalCode": "44115",
          "CountryCode": "US",
          "GLCode": null
        }
      ],
      "BolAvailable": null,
      "PodAvailable": null
    }
  ],
  "Success": false,
  "Error": null
}