Trendsic Platform Service

<back to all web services

DispatchSettlementsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/settlements
DispatchSettlementsResponse Parameters:
NameParameterData TypeRequiredDescription
SettlementsformList<DispatchSettlementView>No
SettlementformDispatchSettlementViewNo
SuggestionsformList<DispatchSettlementSuggestView>No
ResponseStatusformResponseStatusNo
DispatchSettlementView Parameters:
NameParameterData TypeRequiredDescription
SettlementIdformintNo
CodeformstringNo
VendorIDformintNo
VendorNameformstringNo
PeriodStartformDateTimeNo
PeriodEndformDateTimeNo
LoadCountformintNo
GrossRevenueformdecimalNo
SplitPctformdecimalNo
CarrierShareformdecimalNo
DeductionsTotalformdecimalNo
NetformdecimalNo
StatusformstringNo
NotesformstringNo
GeneratedUtcformDateTimeNo
SentUtcformDateTime?No
ApprovedUtcformDateTime?No
ApprovedByformstringNo
PaidUtcformDateTime?No
PaidRefformstringNo
ContactCountformintNo
DeductionsformList<DispatchSettlementDeductionView>No
LoadsformList<DispatchLoadView>No
DispatchSettlementDeductionView Parameters:
NameParameterData TypeRequiredDescription
DeductionIdformintNo
KindformstringNo
LabelformstringNo
AmountformdecimalNo
NoteformstringNo
DispatchLoadView Parameters:
NameParameterData TypeRequiredDescription
LoadIdformintNo
CodeformstringNo
ModuleformstringNo
TruckLabelformstringNo
DriverLabelformstringNo
CarrierLabelformstringNo
SourceLabelformstringNo
DestinationLabelformstringNo
Qtyformdecimal?No
UnitformstringNo
QtyTextformstringNo
TicketCodeformstringNo
RateAppliedformdecimal?No
RateBasisformstringNo
Revenueformdecimal?No
PayPlanLabelformstringNo
Payformdecimal?No
StatusformstringNo
OpenedUtcformDateTimeNo
ClosedUtcformDateTime?No
PhotosformintNo
StagesformList<DispatchLoadStageView>No
DispatchLoadStageView Parameters:
NameParameterData TypeRequiredDescription
StageformstringNo
AtUtcformDateTimeNo
NoteformstringNo
DispatchSettlementSuggestView Parameters:
NameParameterData TypeRequiredDescription
VendorIDformintNo
VendorNameformstringNo
SplitPctformdecimalNo
TermsformstringNo
W9OnFileformboolNo
CoiExpiresformDateTime?No
PeriodStartformDateTimeNo
PeriodEndformDateTimeNo
UnsettledLoadsformintNo
UnpricedLoadsformintNo
UnsettledPayformdecimalNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/dispatch/settlements HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Settlements":[{"SettlementId":0,"Code":"String","VendorID":0,"VendorName":"String","PeriodStart":"0001-01-01T00:00:00.0000000","PeriodEnd":"0001-01-01T00:00:00.0000000","LoadCount":0,"GrossRevenue":0,"SplitPct":0,"CarrierShare":0,"DeductionsTotal":0,"Net":0,"Status":"String","Notes":"String","GeneratedUtc":"0001-01-01T00:00:00.0000000","SentUtc":"0001-01-01T00:00:00.0000000","ApprovedUtc":"0001-01-01T00:00:00.0000000","ApprovedBy":"String","PaidUtc":"0001-01-01T00:00:00.0000000","PaidRef":"String","ContactCount":0,"Deductions":[{"DeductionId":0,"Kind":"String","Label":"String","Amount":0,"Note":"String"}],"Loads":[{"LoadId":0,"Code":"String","Module":"String","TruckLabel":"String","DriverLabel":"String","CarrierLabel":"String","SourceLabel":"String","DestinationLabel":"String","Qty":0,"Unit":"String","QtyText":"String","TicketCode":"String","RateApplied":0,"RateBasis":"String","Revenue":0,"PayPlanLabel":"String","Pay":0,"Status":"String","OpenedUtc":"0001-01-01T00:00:00.0000000","ClosedUtc":"0001-01-01T00:00:00.0000000","Photos":0,"Stages":[{"Stage":"String","AtUtc":"0001-01-01T00:00:00.0000000","Note":"String"}]}]}],"Settlement":{"SettlementId":0,"Code":"String","VendorID":0,"VendorName":"String","PeriodStart":"0001-01-01T00:00:00.0000000","PeriodEnd":"0001-01-01T00:00:00.0000000","LoadCount":0,"GrossRevenue":0,"SplitPct":0,"CarrierShare":0,"DeductionsTotal":0,"Net":0,"Status":"String","Notes":"String","GeneratedUtc":"0001-01-01T00:00:00.0000000","SentUtc":"0001-01-01T00:00:00.0000000","ApprovedUtc":"0001-01-01T00:00:00.0000000","ApprovedBy":"String","PaidUtc":"0001-01-01T00:00:00.0000000","PaidRef":"String","ContactCount":0,"Deductions":[{"DeductionId":0,"Kind":"String","Label":"String","Amount":0,"Note":"String"}],"Loads":[{"LoadId":0,"Code":"String","Module":"String","TruckLabel":"String","DriverLabel":"String","CarrierLabel":"String","SourceLabel":"String","DestinationLabel":"String","Qty":0,"Unit":"String","QtyText":"String","TicketCode":"String","RateApplied":0,"RateBasis":"String","Revenue":0,"PayPlanLabel":"String","Pay":0,"Status":"String","OpenedUtc":"0001-01-01T00:00:00.0000000","ClosedUtc":"0001-01-01T00:00:00.0000000","Photos":0,"Stages":[{"Stage":"String","AtUtc":"0001-01-01T00:00:00.0000000","Note":"String"}]}]},"Suggestions":[{"VendorID":0,"VendorName":"String","SplitPct":0,"Terms":"String","W9OnFile":false,"CoiExpires":"0001-01-01T00:00:00.0000000","PeriodStart":"0001-01-01T00:00:00.0000000","PeriodEnd":"0001-01-01T00:00:00.0000000","UnsettledLoads":0,"UnpricedLoads":0,"UnsettledPay":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}