GetInvoices - Banyan Technology LIVE Connect™

Request

Header Params

Body Params application/json

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 Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://ws.integration.banyantechnology.com/services/api/rest/getInvoices' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"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"
}'

Responses

🟢200GetInvoices - 200 OK

application/json

Body

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.0050,
                    "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
}