Trendsic Platform Service

<back to all web services

DispatchSettlementStatusRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/settlements/{SettlementId}/status
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class DispatchSettlementStatusRequest
{
    open var SettlementId:Int? = null
    open var Status:String? = null
    open var PaidRef:String? = null
}

open class DispatchSettlementsResponse
{
    open var Settlements:ArrayList<DispatchSettlementView> = ArrayList<DispatchSettlementView>()
    open var Settlement:DispatchSettlementView? = null
    open var Suggestions:ArrayList<DispatchSettlementSuggestView> = ArrayList<DispatchSettlementSuggestView>()
    open var ResponseStatus:ResponseStatus? = null
}

open class DispatchSettlementView
{
    open var SettlementId:Int? = null
    open var Code:String? = null
    open var VendorID:Int? = null
    open var VendorName:String? = null
    open var PeriodStart:Date? = null
    open var PeriodEnd:Date? = null
    open var LoadCount:Int? = null
    open var GrossRevenue:BigDecimal? = null
    open var SplitPct:BigDecimal? = null
    open var CarrierShare:BigDecimal? = null
    open var DeductionsTotal:BigDecimal? = null
    open var Net:BigDecimal? = null
    open var Status:String? = null
    open var Notes:String? = null
    open var GeneratedUtc:Date? = null
    open var SentUtc:Date? = null
    open var ApprovedUtc:Date? = null
    open var ApprovedBy:String? = null
    open var PaidUtc:Date? = null
    open var PaidRef:String? = null
    open var ContactCount:Int? = null
    open var Deductions:ArrayList<DispatchSettlementDeductionView> = ArrayList<DispatchSettlementDeductionView>()
    open var Loads:ArrayList<DispatchLoadView> = ArrayList<DispatchLoadView>()
}

open class DispatchSettlementDeductionView
{
    open var DeductionId:Int? = null
    open var Kind:String? = null
    open var Label:String? = null
    open var Amount:BigDecimal? = null
    open var Note:String? = null
}

open class DispatchLoadView
{
    open var LoadId:Int? = null
    open var Code:String? = null
    open var Module:String? = null
    open var TruckLabel:String? = null
    open var DriverLabel:String? = null
    open var CarrierLabel:String? = null
    open var SourceLabel:String? = null
    open var DestinationLabel:String? = null
    open var Qty:BigDecimal? = null
    open var Unit:String? = null
    open var QtyText:String? = null
    open var TicketCode:String? = null
    open var RateApplied:BigDecimal? = null
    open var RateBasis:String? = null
    open var Revenue:BigDecimal? = null
    open var PayPlanLabel:String? = null
    open var Pay:BigDecimal? = null
    open var Status:String? = null
    open var OpenedUtc:Date? = null
    open var ClosedUtc:Date? = null
    open var Photos:Int? = null
    open var Stages:ArrayList<DispatchLoadStageView> = ArrayList<DispatchLoadStageView>()
}

open class DispatchLoadStageView
{
    open var Stage:String? = null
    open var AtUtc:Date? = null
    open var Note:String? = null
}

open class DispatchSettlementSuggestView
{
    open var VendorID:Int? = null
    open var VendorName:String? = null
    open var SplitPct:BigDecimal? = null
    open var Terms:String? = null
    open var W9OnFile:Boolean? = null
    open var CoiExpires:Date? = null
    open var PeriodStart:Date? = null
    open var PeriodEnd:Date? = null
    open var UnsettledLoads:Int? = null
    open var UnpricedLoads:Int? = null
    open var UnsettledPay:BigDecimal? = null
}

Kotlin DispatchSettlementStatusRequest DTOs

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

HTTP + OTHER

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

POST /v1/dispatch/settlements/{SettlementId}/status HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"SettlementId":0,"Status":"String","PaidRef":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}