GetInvoicesWithLoadDetails
POST/services/api/rest/getInvoicesWithLoadDetailsThis function will return invoices along with shipment details for any associated loads. Each invoice returned will be marked as exported. Up to 100 results may be returned in each response, if more are required multiple requests can be sent.
Request
Header Params
Accept
string
required
Example:
application/json
Body Params application/json
No schema defined
Example
{
"AuthenticationData": {
"Username": "",
"Password": "",
"ClientRefNum": ""
},
"IgnoreExported": "true"
}Request samples
Responses
GetInvoicesWithLoadDetails - 200 OK (200)
GetInvoicesWithLoadDetails - 200 OK
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
No schema defined
ExampleGetInvoicesWithLoadDetails - 200 OK
{
"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,
"LoadDetails": {
"Quotes": [
{
"LoadID": 25098029,
"QuoteID": 219725578,
"CarrierName": "Banyan Test Carrier",
"SCAC": "BTST",
"ThirdPartyName": "",
"ThirdPartySCAC": "",
"ServiceID": "28316781",
"RawPrice": {
"NetPrice": 10,
"FreightCharge": null,
"DiscountAmount": null,
"FuelSurcharge": null,
"Minimum": null,
"GrossCharge": null,
"Tariff": null,
"Interline": 0,
"AccessorialCharges": null,
"OtherCharges": null,
"Charges": null,
"Markup": null
},
"CarrierPrice": {
"NetPrice": 10.53,
"FreightCharge": null,
"DiscountAmount": null,
"FuelSurcharge": null,
"Minimum": null,
"GrossCharge": null,
"Tariff": null,
"Interline": 0,
"AccessorialCharges": null,
"OtherCharges": null,
"Charges": null,
"Markup": null
},
"CustomerPrice": {
"NetPrice": 10.53,
"FreightCharge": null,
"DiscountAmount": null,
"FuelSurcharge": null,
"Minimum": null,
"GrossCharge": null,
"Tariff": null,
"Interline": 0,
"AccessorialCharges": null,
"OtherCharges": null,
"Charges": null,
"Markup": null
},
"TransitTime": 1,
"QuoteNumber": "",
"CarrierPerson": "Test Carrier Automated Quote",
"CarrierNote": "",
"Datestamp": "2019-10-08T10:39:18",
"Interline": false,
"Accepted": true,
"CurrencyType": 0,
"Service": 1,
"InsuranceDetails": null
}
],
"ClientName": "Banyan Automated Testing",
"Status": "Delivered",
"Notes": [
{
"Text": "Exported via accounting export. Export guid: 60278691-289c-4d99-8987-2e6af6a5bcac.",
"User": "John Lee",
"DateStamp": "2019-08-26T12:21:00",
"NoteType": 10
}
],
"Loadinfo": {
"LoadID": 26315274,
"ManifestID": "089527392",
"BOLNumber": "TX1921200016",
"CustomerPO": "246483",
"InvoiceID": "",
"BillingID": "",
"IncoTermID": null,
"UltimateDestinationCountryCode": "",
"PickupNumber": "37286494",
"EstimatedDeliveryDate": "2019-08-06T00:00:00",
"EstimatedPickupDate": "2019-08-02T00:00:00",
"ActualPickupDate": "2019-08-02T00:00:00",
"ActualDeliveryDate": "2019-08-06T00:00:00"
},
"BillTo": {
"Name": "Banyan Automated Testing",
"Note": "",
"ShipType": 2,
"PayType": 1,
"UseDefaultBillTo": false,
"AddressInfo": {
"Address1": "31011 Viking Pkwy",
"Address2": "",
"City": "Westlake",
"CountryName": null,
"CountryCode": "United States",
"State": "OH",
"Zipcode": "44145",
"LocationName": "Banyan HQ"
},
"ContactInfo": {
"FirstName": "",
"LastName": "",
"ContactName": "",
"Phone": "123-456-7890",
"PhoneExt": "",
"Fax": "",
"Email": "test@banyantechnology.com"
},
"UseDefaultShipType": false,
"UseDefaultPayType": false
},
"InsuranceInfo": null,
"RateServices": [
{
"ServiceCode": 1,
"ShippingQty": 1,
"PackageType": 29,
"EquipmentType": 5,
"AdditionalWeight": 0,
"SpecialInstructions": "This is just a test shipment.",
"Length": null,
"Width": null,
"Height": null,
"WeightUom": 1,
"SizeUom": 1
}
],
"Shipper": {
"ContactInfo": {
"FirstName": "Bob",
"LastName": "Wright",
"ContactName": "Bob Wright",
"Phone": "555-555-5555",
"PhoneExt": "",
"Fax": "444-444-4444",
"Email": "example@test.com"
},
"AddressInfo": {
"Address1": "123 Test Dr.",
"Address2": "",
"City": "Chicago",
"CountryName": null,
"CountryCode": "United States",
"State": "IL",
"Zipcode": "60606",
"LocationName": "Test Location"
},
"CompanyName": "Bob's Company",
"Note": "",
"CompanyID": "",
"LocationName": null,
"VendorID": "",
"DCRefNum": null,
"Dock": {
"Name": "Bob's Garage",
"Note": "",
"OpenTime": "2019-11-01T08:00:00",
"ShipmentDateTime": "2019-11-01T12:00:00",
"CloseTime": "2019-11-01T17:00:00",
"ConfirmationNumber": "",
"FCFS": false
}
},
"Consignee": {
"ContactInfo": {
"FirstName": "Joe",
"LastName": "Smith",
"ContactName": "Joe Smith",
"Phone": "333-333-3333",
"PhoneExt": "",
"Fax": "222-222-2222",
"Email": "jsmith@test.com"
},
"AddressInfo": {
"Address1": "123 Test St.",
"Address2": "",
"City": "Cleveland",
"CountryName": null,
"CountryCode": "United States",
"State": "OH",
"Zipcode": "44101",
"LocationName": "Test Location"
},
"CompanyName": "Joe's Company",
"Note": "Note Here",
"CompanyID": "",
"LocationName": null,
"VendorID": "",
"DCRefNum": null,
"Dock": {
"Name": "Garage",
"Note": "",
"OpenTime": "2019-11-04T08:00:00",
"ShipmentDateTime": "2019-11-04T12:00:00",
"CloseTime": "2019-11-04T17:00:00",
"ConfirmationNumber": "",
"FCFS": false
}
},
"ReturnLocation": null,
"PackageInfo": {
"CODAmount": 0,
"DeclaredLiability": 0,
"RouteNumber": ""
},
"Products": [
{
"Quantity": 1,
"PackageType": 7,
"Weight": 800,
"Class": 1,
"NMFC": "",
"SKU": "",
"IsHazmat": false,
"HazmatPhoneNumber": "",
"HazmatPhoneExt": "",
"Description": "",
"Length": 3.33,
"Width": 4,
"Height": 2.5,
"UOM": 0,
"SortOrder": 0,
"ReferenceNumber": "",
"ParcelOptions": {
"DeliveryConfirmation": 0,
"COD": 0,
"CODAmount": 0,
"AdditionalHandling": false,
"LargePackage": false,
"DeclaredValue": 0,
"UnitValue": null,
"UnitWeight": null,
"UnitType": null
},
"UnNumber": "",
"HazMatShippingName": "",
"HazMatPkgGroup": "",
"HazMatClass": "",
"InternationalOptions": {
"ScheduleBCode": null,
"HarmonizedSystemCode": null,
"ECCN": null,
"UnitOriginCountryCode": null
},
"HazMatContact": "",
"HazMatPoison": false
}
],
"ShipperAccessorials": {
"AppointmentRequired": false,
"InsidePickup": false,
"SortSegregate": false,
"PalletJack": false,
"ResidentialPickup": false,
"LiftgatePickup": false,
"MarkingTagging": false,
"TradeShowPickup": false,
"NYCMetro": false,
"NonBusinessHourPickup": false,
"LimitedAccessType": "School"
},
"ConsigneeAccessorials": {
"AppointmentRequired": false,
"InsideDelivery": false,
"SortSegregate": false,
"PalletJack": false,
"ResidentialDelivery": false,
"LiftgateDelivery": false,
"MarkingTagging": false,
"TradeShowDelivery": false,
"NYCMetro": false,
"DeliveryNotification": false,
"TwoHourSpecialDelivery": false,
"NonBusinessHourDelivery": false,
"LimitedAccessType": null
},
"LoadAccessorials": {
"Guaranteed": false,
"TimeDefinite": false,
"Expedited": false,
"HolidayPickup": false,
"HolidayDelivery": false,
"WeightDetermination": false,
"BlindShipment": false,
"BlanketService": false,
"ProtectFromFreezing": false,
"SingleShipment": false,
"CustomsInBond": false,
"OverDimension": false,
"Stackable": false,
"Turnkey": false,
"FoodGradeProducts": false,
"TSA": false,
"Bulkhead": false,
"SignatureRequired": false,
"BlanketServiceChilled": false,
"BlanketServiceFrozen": false,
"SaturdayDelivery": false,
"SecondMan": false,
"ReturnReceipt": false,
"ShipmentHold": false,
"ProactiveResponse": false,
"ShipperRelease": false,
"WhiteGlove": false,
"RestrictedDelivery": false
},
"UserDefined": [],
"ReferenceField": [
{
"Value": "Julie True",
"Type": "Assigned Dispatcher",
"PrintOnBOL": true,
"PrintOnShippingLabel": false
}
]
}
}
],
"Success": false,
"Error": null
}Last modified: 2 months ago