Banyan Technology LIVE Connect™
  1. Invoices
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
      • Mark as Exported
    • 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
    • Insurance
      • Get Vendors
  • 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
  • Schemas
    • Schemas
      • v2
        • Enums
          • Package Type Enum
          • Freight Class Enum
          • Document Types Enum
          • Limited Access Types Enum
          • Equipment Type Enum
          • Service Code Enum
          • Size UOM Enum
          • Weight UOM Enum
          • Inco Terms Enum
          • Ship Type Enum
          • Pay Type Enum
          • Note Type Enum
          • Failure Reason Codes Enum
          • Currency Types Enum
          • Image Format Enum
          • Date Filter Types Enum
          • Invoice Status Enum
          • Load Status Enum
        • common
          • Authentication Data
          • ErrorObject
        • Invoices
          • objects
            • InvoiceBatchDetails
            • InvoiceLoadDetails
            • InvoiceQuoteDetails
            • InvoiceLineDetails
            • InvoicePaymentDetails
            • InvoiceAddressDetails
            • InvoiceDetails
          • GetInvoicesResponse
          • GetInvoicesRequest
        • Import
          • ImportAsBookedRequest
          • ImportForRatingAndPendingRequest
          • ImportAsBookedResponse
          • ImportForRatingAndPendingResponse
        • tracking
          • GetTrackingStatusesResponse
          • GetTrackingStatusesRequest
          • GetTrackingByLoadRequest
          • GetTrackingByLoadResponse
        • documents
          • objects
            • Document
          • GetDocumentsRequest
          • GetDocumentResponse
        • booking/dispatching
          • DispatchRequest
          • BookLoadRequest
          • DispatchResponse
          • BookLoadResponse
          • DispatchLoadRequest
          • DispatchLoadResponse
        • updates
          • UpdateLoadRequest
          • UpdateLoadResponse
          • UpdateLoadStatusRequest
          • UpdateLoadStatusResponse
          • UpdateShipmentExportRequest
          • UpdateShipmentExportResponse
        • quotes
          • objects
            • FailedQuote
            • PendingQuote
            • QuoteCharge
            • PriceBreakout
            • Quote
            • ManualQuote
          • AddManualQuoteRequest
          • AddManualQuoteResponse
          • GetQuotesResponse
          • GetQuotesRequest
        • ezrates
          • EZRateRequest
          • EZRateResponse
        • accessorials
          • ShipperAccessorials
          • ConsigneeAccessorials
          • LoadAccessorials
        • notes
          • GetNotesRequest
          • GetNotesResponse
        • load details
          • GetLoadDetailsRequest
          • GetLoadDetailsResponse
        • AddressInfo
        • ContactInfo
        • Dock
        • PackageInfo
        • Product
        • ParcelOptions
        • InternationalOptions
        • Shipper
        • Consignee
        • BillTo
        • Loadinfo
        • RateServices
        • ReturnLocation
        • InsuranceInfo
        • ReferenceField
        • UserDefined
        • Note
        • InsuranceDetails
        • FullLoadDetails
      • Webhooks
        • Tracking Event
      • v3
        • Enums
          • ClientDocumentTypesEnum
          • ImportStatusEnum
          • LimitedAccessEnum
          • DocumentTypesEnum
          • CurrencyEnum
          • PackageTypesEnum
          • FreightClassEnum
          • Weight UOM Enum
          • ShipTypeEnum
          • PayTypeEnum
          • ServiceModeEnum
          • EquipmentTypeEnum
          • LoadStatusEnum
          • ExportReasonsEnum
          • InternationalTermsEnum
          • ShipmentAccessorialsAbbrevEnum
          • ShipmentAccessorialsDescEnum
          • ShipperAccessorialsDescEnum
          • ShipperAccessorialsAbbrevEnum
          • ConsigneeAccessorialsAbbrevEnum
          • ConsigneeAccessorialsDescEnum
          • Size UOM Enum
          • Web Tracking codes
          • EDI Tracking Codes
        • DocumentPostDto
        • BrokerDto
        • ClientDto
        • ManualQuoteDto
        • BanyanWebServices.Domain.Dtos.CreateShipment.ShipmentDataDto
        • BanyanWebServices.Domain.Dtos.DocumentDto
        • BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto
        • BanyanWebServices.Domain.Dtos.ErrorWrapperDto
        • BanyanWebServices.Domain.Dtos.GetQuotesDto
        • AwardedQuotePricingDto
        • ContactPersonDto
        • InsuranceDetailsDto
        • QuoteChargeDto
        • QuoteDto
        • QuotePriceDto
        • BanyanWebServices.Domain.Dtos.GetShipment.UpdateShipmentResponseDto
        • BanyanWebServices.Domain.Dtos.Invoices.BatchDetailsDto
        • BanyanWebServices.Domain.Dtos.Invoices.InvoiceAddressDto
        • BanyanWebServices.Domain.Dtos.Invoices.InvoiceDto
        • BanyanWebServices.Domain.Dtos.Invoices.InvoiceLineItemDto
        • BanyanWebServices.Domain.Dtos.Invoices.PaymentDto
        • BanyanWebServices.Domain.Dtos.Invoices.QuoteDetailsDto
        • BanyanWebServices.Domain.Dtos.Invoices.ShipmentDetailsDto
        • NoteDto
        • BanyanWebServices.Domain.Dtos.Quotes.FailedQuoteDto
        • BanyanWebServices.Domain.Dtos.Quotes.PendingQuoteDto
        • ShipmentAccessorialDto
        • ShipperAccessorialDto
        • ConsigneeAccessorialDto
        • AddressDto
        • BillToDto
        • BanyanWebServices.Domain.Dtos.Shipment.CarbonQuoteDto
        • ContactMethodsDto
        • DimensionsDto
        • BanyanWebServices.Domain.Dtos.Shipment.DispatchResponseDto
        • DockDetailsDto
        • HandlingUnitDto
        • HazmatDetailsDto
        • BanyanWebServices.Domain.Dtos.Shipment.InsuranceDto
        • InternationalDetailDto
        • LocationDto
        • BanyanWebServices.Domain.Dtos.Shipment.MarketRateDto
        • PackageInfoDto
        • ProductDto
        • ReferenceFieldDto
        • ShipmentServiceDto
        • StaticData.AccessorialsDto
        • TimeZoneDto
        • TrackingDto
        • TrackingStatusDto
        • BanyanWebServices.Domain.Enums.LoadStatus
        • BanyanWebServices.Domain.Enums.NoteFilter
        • BanyanWebServices.Domain.Enums.QuoteFilter
        • BanyanWebServices.Domain.Requests.BookQuoteRequest
        • BanyanWebServices.Domain.Requests.Common.IdListRequest
        • BanyanWebServices.Domain.Requests.Common.IdRequest
        • BanyanWebServices.Domain.Requests.CreateReferenceNumberRequest
        • BanyanWebServices.Domain.Requests.MarkTrackingExportedRequest
        • CreateShipmentRequest
        • GetDocumentsRequest
        • BanyanWebServices.Domain.Requests.Version3.GetInvoicesRequest
        • BanyanWebServices.Domain.Requests.Version3.GetShipmentsRequest
        • BanyanWebServices.Domain.Requests.Version3.GetTrackingByLoadRequest
        • BanyanWebServices.Domain.Requests.Version3.UpdateShipmentRequest
        • ErrorResponse
  1. Invoices

GetInvoicesResponse

{
    "Invoices": [
        {
            "ApID": 0,
            "EDIBillToAccountCode": "null",
            "InvoiceType": "string",
            "ClientName": "string",
            "ClientReferenceNumber": "string",
            "InvoiceStatusCode": "string",
            "NetAmountDue": 0,
            "TotalCharges": 0,
            "Variance": 0,
            "CurrencyCode": "string",
            "CarrierName": "string",
            "CarrierSCAC": "string",
            "VendorName": "string",
            "VendorID": "string",
            "HasException": true,
            "ShipmentCreatedFromInvoice": true,
            "EDIType": "string",
            "CreatedDateTime": "2019-08-24T14:15:22Z",
            "BillingDateTime": "2019-08-24T14:15:22Z",
            "ExportedDateTime": "2019-08-24T14:15:22Z",
            "ShipmentDetails": {
                "LoadId": 0,
                "GuidLoadID": "string",
                "ProNumber": "string",
                "BOLID": "string",
                "CustomerPO": "string",
                "PayType": "string",
                "TotalWeight": 0,
                "WeightUnitOfMeasure": "string",
                "TotalPieces": 0,
                "PickupDateTime": "2019-08-24T14:15:22Z",
                "DeliveryDateTime": "2019-08-24T14:15:22Z"
            },
            "QuoteDetails": {
                "CarrierName": "string",
                "CarrierSCAC": "string",
                "QuoteNumber": "string",
                "DateTime": "2019-08-24T14:15:22Z",
                "TotalCharge": 0,
                "FreightCharge": 0,
                "DiscountPercent": 0,
                "DiscountAmount": 0,
                "FuelSurcharge": 0,
                "Minimum": 0,
                "GrossCharge": 0,
                "TotalAccessorialCharges": 0,
                "TotalOtherCharges": 0,
                "Interline": true
            },
            "BatchDetails": {
                "BatchID": "string",
                "User": "string",
                "DateTime": "2019-08-24T14:15:22Z"
            },
            "LineItem": [
                {
                    "CarrierChargeCode": "string",
                    "NormalizedChargeCode": "string",
                    "Description": "string",
                    "Quantity": 0,
                    "PackagingCode": "string",
                    "Weight": 0,
                    "Charge": 0,
                    "FreightClass": "string",
                    "Extension": "string",
                    "RatedAsQuantity": null,
                    "RatedAsQualifier": "string"
                }
            ],
            "Payment": [
                {
                    "BatchID": "string",
                    "Amount": 0,
                    "Identifier": "string",
                    "Type": "string",
                    "Description": "string",
                    "UsersName": "string",
                    "DateTime": "2019-08-24T14:15:22Z"
                }
            ],
            "Address": [
                {
                    "Type": "string",
                    "Name": "string",
                    "IDCode": "null",
                    "Address1": "string",
                    "Address2": "string",
                    "City": "string",
                    "StateCode": "string",
                    "PostalCode": "string",
                    "CountryCode": "string",
                    "GLCode": "null"
                }
            ],
            "BolAvailable": true,
            "PodAvailable": true,
            "LoadDetails": {
                "ClientName\t": "string",
                "Status": "string",
                "LoadInfo": {
                    "LoadID": 0,
                    "ManifestID": "string",
                    "BOLNumber": "string",
                    "CustomerPO": "string",
                    "InvoiceID": "string",
                    "BillingID": "string",
                    "IncoTermID": "Free Alongside Ship",
                    "UltimateDestinationCountryCode": "string",
                    "PickupNumber": "string",
                    "EstimatedDeliveryDate": "2019-08-24T14:15:22Z",
                    "EstimatedPickupDate": "2019-08-24T14:15:22Z",
                    "ActualPickupDate": "2019-08-24T14:15:22Z",
                    "ActualDeliveryDate": "2019-08-24T14:15:22Z"
                },
                "BillTo": {
                    "Name": "string",
                    "Note": "string",
                    "ShipType": "Shipper",
                    "PayType": "Collect",
                    "AddressInfo": {
                        "Address1": "string",
                        "Address2": "string",
                        "City": "string",
                        "CountryName": "string",
                        "CountryCode": "string",
                        "State": "string",
                        "Zipcode": "string",
                        "LocationName": "string"
                    },
                    "ContactInfo": {
                        "FirstName": "string",
                        "LastName": "string",
                        "ContactName": "string",
                        "Phone": "string",
                        "PhoneExt": "string",
                        "Fax": "string",
                        "Email": "string"
                    },
                    "UseDefaultBillTo": true,
                    "UseDefaultShipType": true,
                    "UseDefaultPayType": true
                },
                "RateServices": [
                    {
                        "ServiceCode": "Parcel",
                        "ShippingQty": 0,
                        "PackageType": "Accessorials",
                        "EquipmentType": "Trailer_28ft",
                        "AdditionalWeight": 0,
                        "SpecialInstructions": "string",
                        "Length": 0,
                        "Width": 0,
                        "Height": 0,
                        "WeightUom": "LBS",
                        "SizeUom": "IN"
                    }
                ],
                "Shipper": {
                    "ContactInfo": {
                        "FirstName": "string",
                        "LastName": "string",
                        "ContactName": "string",
                        "Phone": "string",
                        "PhoneExt": "string",
                        "Fax": "string",
                        "Email": "string"
                    },
                    "AddressInfo": {
                        "Address1": "string",
                        "Address2": "string",
                        "City": "string",
                        "CountryName": "string",
                        "CountryCode": "string",
                        "State": "string",
                        "Zipcode": "string",
                        "LocationName": "string"
                    },
                    "LocationName": "string",
                    "CompanyName": "string",
                    "Note": "string",
                    "CompanyID": "string",
                    "VendorID": "string",
                    "DCRefNum": "string",
                    "Dock": {
                        "Name": "string",
                        "Note": "string",
                        "OpenTime": "string",
                        "ShipmentDateTime": "string",
                        "CloseTime": "string",
                        "ConfirmationNumber": "string",
                        "FCFS": true
                    }
                },
                "Consignee": {
                    "ContactInfo": {
                        "FirstName": "string",
                        "LastName": "string",
                        "ContactName": "string",
                        "Phone": "string",
                        "PhoneExt": "string",
                        "Fax": "string",
                        "Email": "string"
                    },
                    "AddressInfo": {
                        "Address1": "string",
                        "Address2": "string",
                        "City": "string",
                        "CountryName": "string",
                        "CountryCode": "string",
                        "State": "string",
                        "Zipcode": "string",
                        "LocationName": "string"
                    },
                    "LocationName": "string",
                    "CompanyName": "string",
                    "Note": "string",
                    "CompanyID": "string",
                    "VendorID": "string",
                    "DCRefNum": "string",
                    "Dock": {
                        "Name": "string",
                        "Note": "string",
                        "OpenTime": "string",
                        "ShipmentDateTime": "string",
                        "CloseTime": "string",
                        "ConfirmationNumber": "string",
                        "FCFS": true
                    }
                },
                "PackageInfo": {
                    "CODAmount": 0,
                    "DeclaredLiability": 0,
                    "RouteNumber": "string"
                },
                "Products": [
                    {
                        "Quantity": 0,
                        "PackageType": "Accessorials",
                        "Weight": 0,
                        "Class": "Unspecified",
                        "NMFC": "string",
                        "SKU": "string",
                        "IsHazmat": true,
                        "UnNumber": "string",
                        "HazMatShippingName": "string",
                        "HazMatClass": "string",
                        "HazMatPkgGroup": "string",
                        "HazmatPhoneNumber": "string",
                        "HazmatPhoneExt": "string",
                        "HazMatContact": "string",
                        "HazMatPoison": true,
                        "Description": "string",
                        "Length": 0,
                        "Width": 0,
                        "Height": 0,
                        "UOM": "English",
                        "SortOrder": 0,
                        "ReferenceNumber": "string",
                        "ParcelOptions": {
                            "DeliveryConfirmation": "None",
                            "COD": "None",
                            "CODAmount": 0,
                            "AdditionalHandling": true,
                            "LargePackage": true,
                            "DeclaredValue": 0,
                            "UnitValue": 0,
                            "UnitWeight": 0,
                            "UnitType": "string"
                        },
                        "InternationalOptions": {
                            "ScheduleBCode": "string",
                            "HarmonizedSystemCode": "string",
                            "ECCN": "string",
                            "UnitOriginCountryCode": "string"
                        }
                    }
                ],
                "ShipperAccessorials": {
                    "AppointmentRequired": true,
                    "InsidePickup": true,
                    "SortSegregate": true,
                    "PalletJack": true,
                    "ResidentialPickup": true,
                    "LiftgatePickup": true,
                    "MarkingTagging": true,
                    "TradeShowPickup": true,
                    "NYCMetro": true,
                    "NonBusinessHourPickup": true,
                    "LimitedAccessType": "Military Base"
                },
                "ConsigneeAccessorials": {
                    "AppointmentRequired": true,
                    "InsideDelivery": true,
                    "SortSegregate": true,
                    "PalletJack": true,
                    "ResidentialDelivery": true,
                    "LiftgateDelivery": true,
                    "MarkingTagging": true,
                    "TradeShowDelivery": true,
                    "NYCMetro": true,
                    "DeliveryNotification": true,
                    "TwoHourSpecialDelivery": true,
                    "NonBusinessHourDelivery": true,
                    "LimitedAccessType": "Military Base"
                },
                "LoadAccessorials": {
                    "Guaranteed": true,
                    "TimeDefinite": true,
                    "Expedited": true,
                    "HolidayPickup": true,
                    "HolidayDelivery": true,
                    "WeightDetermination": true,
                    "BlindShipment": true,
                    "BlanketService": true,
                    "SingleShipment": true,
                    "CustomsInBond": true,
                    "OverDimension": true,
                    "Stackable": true,
                    "Turnkey": true,
                    "FoodGradeProducts": true,
                    "TSA": true,
                    "Bulkhead": true,
                    "SignatureRequired": true,
                    "BlanketServiceChilled": true,
                    "BlanketServiceFrozen": true,
                    "SaturdayDelivery": true,
                    "SecondMan": true,
                    "ReturnReceipt": true,
                    "ShipmentHold": true,
                    "ProactiveResponse": true,
                    "ShipperRelease": true,
                    "WhiteGlove": true,
                    "RestrictedDelivery": true,
                    "TankerEndorsedDriverRequired": true
                },
                "Return Location": {
                    "CompanyName": "string",
                    "ContactInfo": {
                        "FirstName": "string",
                        "LastName": "string",
                        "ContactName": "string",
                        "Phone": "string",
                        "PhoneExt": "string",
                        "Fax": "string",
                        "Email": "string"
                    },
                    "AddressInfo": {
                        "Address1": "string",
                        "Address2": "string",
                        "City": "string",
                        "CountryName": "string",
                        "CountryCode": "string",
                        "State": "string",
                        "Zipcode": "string",
                        "LocationName": "string"
                    }
                },
                "UserDefined": [
                    {
                        "Name": "string",
                        "Value": "string"
                    }
                ],
                "ReferenceField": [
                    {
                        "Type": "string",
                        "Value": "string",
                        "PrintOnBOL": true,
                        "PrintOnShippingLabel": true
                    }
                ],
                "InsuranceInfo": {
                    "InsuranceWanted": true,
                    "VendorCode": "string",
                    "CommodityTypeCode": "string",
                    "CommodityConditionCode": "string",
                    "InsuredValue": 0
                },
                "Quotes": [
                    {
                        "LoadID": 0,
                        "QuoteID": 0,
                        "CarrierName": "string",
                        "SCAC": "string",
                        "ThirdPartyName": "string",
                        "ThirdPartySCAC": "string",
                        "ServiceID": "string",
                        "RawPrice": {
                            "NetPrice": 0,
                            "FreightCharge": 0,
                            "DiscountAmount": 0,
                            "FuelSurcharge": 0,
                            "Minimum": 0,
                            "GrossCharge": 0,
                            "Tariff": 0,
                            "Interline": 0,
                            "AccessorialCharges": 0,
                            "OtherCharges": 0,
                            "Charges": [
                                {
                                    "Name": "string",
                                    "Amount": 0,
                                    "Code": "string"
                                }
                            ],
                            "Markup": 0
                        },
                        "CarrierPrice": {
                            "NetPrice": 0,
                            "FreightCharge": 0,
                            "DiscountAmount": 0,
                            "FuelSurcharge": 0,
                            "Minimum": 0,
                            "GrossCharge": 0,
                            "Tariff": 0,
                            "Interline": 0,
                            "AccessorialCharges": 0,
                            "OtherCharges": 0,
                            "Charges": [
                                {
                                    "Name": "string",
                                    "Amount": 0,
                                    "Code": "string"
                                }
                            ],
                            "Markup": 0
                        },
                        "CustomerPrice": {
                            "NetPrice": 0,
                            "FreightCharge": 0,
                            "DiscountAmount": 0,
                            "FuelSurcharge": 0,
                            "Minimum": 0,
                            "GrossCharge": 0,
                            "Tariff": 0,
                            "Interline": 0,
                            "AccessorialCharges": 0,
                            "OtherCharges": 0,
                            "Charges": [
                                {
                                    "Name": "string",
                                    "Amount": 0,
                                    "Code": "string"
                                }
                            ],
                            "Markup": 0
                        },
                        "TransitTime": 0,
                        "QuoteNumber": "string",
                        "AccountNumber": "string",
                        "CarrierPerson": "string",
                        "CarrierNote": "string",
                        "Datestamp": "string",
                        "Interline": true,
                        "Accepted": true,
                        "CurrencyType": "US_Dollar",
                        "Service": "Parcel",
                        "InsuranceDetails": {
                            "Price": 0,
                            "Confirmation": "string",
                            "InsuranceNote": "string",
                            "ExpirationDate": "2019-08-24T14:15:22Z",
                            "DeductibleNote": "string",
                            "TermsAndConditions": "string"
                        }
                    }
                ],
                "Notes": [
                    {
                        "Text": "string",
                        "User": "string",
                        "DateStamp": "string",
                        "NoteType": "AccountingAdjustment"
                    }
                ]
            }
        }
    ],
    "Success": true,
    "Error": {
        "Message": "string"
    }
}
Built with