Trendsic Platform Service

DispatchSettlementRequest

The following routes are available for this service:
GET,OPTIONS	/v1/dispatch/settlements/{SettlementId}

"use strict";
export class DispatchSettlementDeductionView {
    /** @param {{DeductionId?:number,Kind?:string,Label?:string,Amount?:number,Note?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DeductionId;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Label;
    /** @type {number} */
    Amount;
    /** @type {string} */
    Note;
}
export class DispatchLoadStageView {
    /** @param {{Stage?:string,AtUtc?:string,Note?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Stage;
    /** @type {string} */
    AtUtc;
    /** @type {string} */
    Note;
}
export class DispatchLoadView {
    /** @param {{LoadId?:number,Code?:string,Module?:string,TruckLabel?:string,DriverLabel?:string,CarrierLabel?:string,SourceLabel?:string,DestinationLabel?:string,Qty?:number,Unit?:string,QtyText?:string,TicketCode?:string,RateApplied?:number,RateBasis?:string,Revenue?:number,PayPlanLabel?:string,Pay?:number,Status?:string,OpenedUtc?:string,ClosedUtc?:string,Photos?:number,Stages?:DispatchLoadStageView[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    LoadId;
    /** @type {string} */
    Code;
    /** @type {string} */
    Module;
    /** @type {string} */
    TruckLabel;
    /** @type {string} */
    DriverLabel;
    /** @type {string} */
    CarrierLabel;
    /** @type {string} */
    SourceLabel;
    /** @type {string} */
    DestinationLabel;
    /** @type {?number} */
    Qty;
    /** @type {string} */
    Unit;
    /** @type {string} */
    QtyText;
    /** @type {string} */
    TicketCode;
    /** @type {?number} */
    RateApplied;
    /** @type {string} */
    RateBasis;
    /** @type {?number} */
    Revenue;
    /** @type {string} */
    PayPlanLabel;
    /** @type {?number} */
    Pay;
    /** @type {string} */
    Status;
    /** @type {string} */
    OpenedUtc;
    /** @type {?string} */
    ClosedUtc;
    /** @type {number} */
    Photos;
    /** @type {DispatchLoadStageView[]} */
    Stages = [];
}
export class DispatchSettlementView {
    /** @param {{SettlementId?:number,Code?:string,VendorID?:number,VendorName?:string,PeriodStart?:string,PeriodEnd?:string,LoadCount?:number,GrossRevenue?:number,SplitPct?:number,CarrierShare?:number,DeductionsTotal?:number,Net?:number,Status?:string,Notes?:string,GeneratedUtc?:string,SentUtc?:string,ApprovedUtc?:string,ApprovedBy?:string,PaidUtc?:string,PaidRef?:string,ContactCount?:number,Deductions?:DispatchSettlementDeductionView[],Loads?:DispatchLoadView[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SettlementId;
    /** @type {string} */
    Code;
    /** @type {number} */
    VendorID;
    /** @type {string} */
    VendorName;
    /** @type {string} */
    PeriodStart;
    /** @type {string} */
    PeriodEnd;
    /** @type {number} */
    LoadCount;
    /** @type {number} */
    GrossRevenue;
    /** @type {number} */
    SplitPct;
    /** @type {number} */
    CarrierShare;
    /** @type {number} */
    DeductionsTotal;
    /** @type {number} */
    Net;
    /** @type {string} */
    Status;
    /** @type {string} */
    Notes;
    /** @type {string} */
    GeneratedUtc;
    /** @type {?string} */
    SentUtc;
    /** @type {?string} */
    ApprovedUtc;
    /** @type {string} */
    ApprovedBy;
    /** @type {?string} */
    PaidUtc;
    /** @type {string} */
    PaidRef;
    /** @type {number} */
    ContactCount;
    /** @type {DispatchSettlementDeductionView[]} */
    Deductions = [];
    /** @type {DispatchLoadView[]} */
    Loads = [];
}
export class DispatchSettlementSuggestView {
    /** @param {{VendorID?:number,VendorName?:string,SplitPct?:number,Terms?:string,W9OnFile?:boolean,CoiExpires?:string,PeriodStart?:string,PeriodEnd?:string,UnsettledLoads?:number,UnpricedLoads?:number,UnsettledPay?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    VendorID;
    /** @type {string} */
    VendorName;
    /** @type {number} */
    SplitPct;
    /** @type {string} */
    Terms;
    /** @type {boolean} */
    W9OnFile;
    /** @type {?string} */
    CoiExpires;
    /** @type {string} */
    PeriodStart;
    /** @type {string} */
    PeriodEnd;
    /** @type {number} */
    UnsettledLoads;
    /** @type {number} */
    UnpricedLoads;
    /** @type {number} */
    UnsettledPay;
}
export class DispatchSettlementsResponse {
    /** @param {{Settlements?:DispatchSettlementView[],Settlement?:DispatchSettlementView,Suggestions?:DispatchSettlementSuggestView[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DispatchSettlementView[]} */
    Settlements = [];
    /** @type {DispatchSettlementView} */
    Settlement;
    /** @type {DispatchSettlementSuggestView[]} */
    Suggestions = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DispatchSettlementRequest {
    /** @param {{SettlementId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SettlementId;
}

JavaScript DispatchSettlementRequest DTOs

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

HTTP + JSV

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

GET /v1/dispatch/settlements/{SettlementId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Settlements: 
	[
		{
			SettlementId: 0,
			Code: String,
			VendorID: 0,
			VendorName: String,
			PeriodStart: 0001-01-01,
			PeriodEnd: 0001-01-01,
			LoadCount: 0,
			GrossRevenue: 0,
			SplitPct: 0,
			CarrierShare: 0,
			DeductionsTotal: 0,
			Net: 0,
			Status: String,
			Notes: String,
			GeneratedUtc: 0001-01-01,
			SentUtc: 0001-01-01,
			ApprovedUtc: 0001-01-01,
			ApprovedBy: String,
			PaidUtc: 0001-01-01,
			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-01,
					ClosedUtc: 0001-01-01,
					Photos: 0,
					Stages: 
					[
						{
							Stage: String,
							AtUtc: 0001-01-01,
							Note: String
						}
					]
				}
			]
		}
	],
	Settlement: 
	{
		SettlementId: 0,
		Code: String,
		VendorID: 0,
		VendorName: String,
		PeriodStart: 0001-01-01,
		PeriodEnd: 0001-01-01,
		LoadCount: 0,
		GrossRevenue: 0,
		SplitPct: 0,
		CarrierShare: 0,
		DeductionsTotal: 0,
		Net: 0,
		Status: String,
		Notes: String,
		GeneratedUtc: 0001-01-01,
		SentUtc: 0001-01-01,
		ApprovedUtc: 0001-01-01,
		ApprovedBy: String,
		PaidUtc: 0001-01-01,
		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-01,
				ClosedUtc: 0001-01-01,
				Photos: 0,
				Stages: 
				[
					{
						Stage: String,
						AtUtc: 0001-01-01,
						Note: String
					}
				]
			}
		]
	},
	Suggestions: 
	[
		{
			VendorID: 0,
			VendorName: String,
			SplitPct: 0,
			Terms: String,
			W9OnFile: False,
			CoiExpires: 0001-01-01,
			PeriodStart: 0001-01-01,
			PeriodEnd: 0001-01-01,
			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
		}
	}
}