Trendsic Platform Service

DispatchSettlementGenerateRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/settlements/generate

**DispatchSettlementGenerateRequest** Parameters:
Name	Parameter	Data Type	Required
VendorID	body	int	No
PeriodStart	body	DateTime	No
PeriodEnd	body	DateTime	No

**DispatchSettlementsResponse** Parameters:
Name	Parameter	Data Type	Required
Settlements	form	List<DispatchSettlementView>	No
Settlement	form	DispatchSettlementView	No
Suggestions	form	List<DispatchSettlementSuggestView>	No
ResponseStatus	form	ResponseStatus	No

**DispatchSettlementView** Parameters:
Name	Parameter	Data Type	Required
SettlementId	form	int	No
Code	form	string	No
VendorID	form	int	No
VendorName	form	string	No
PeriodStart	form	DateTime	No
PeriodEnd	form	DateTime	No
LoadCount	form	int	No
GrossRevenue	form	decimal	No
SplitPct	form	decimal	No
CarrierShare	form	decimal	No
DeductionsTotal	form	decimal	No
Net	form	decimal	No
Status	form	string	No
Notes	form	string	No
GeneratedUtc	form	DateTime	No
SentUtc	form	DateTime?	No
ApprovedUtc	form	DateTime?	No
ApprovedBy	form	string	No
PaidUtc	form	DateTime?	No
PaidRef	form	string	No
ContactCount	form	int	No
Deductions	form	List<DispatchSettlementDeductionView>	No
Loads	form	List<DispatchLoadView>	No

**DispatchSettlementDeductionView** Parameters:
Name	Parameter	Data Type	Required
DeductionId	form	int	No
Kind	form	string	No
Label	form	string	No
Amount	form	decimal	No
Note	form	string	No

**DispatchLoadView** Parameters:
Name	Parameter	Data Type	Required
LoadId	form	int	No
Code	form	string	No
Module	form	string	No
TruckLabel	form	string	No
DriverLabel	form	string	No
CarrierLabel	form	string	No
SourceLabel	form	string	No
DestinationLabel	form	string	No
Qty	form	decimal?	No
Unit	form	string	No
QtyText	form	string	No
TicketCode	form	string	No
RateApplied	form	decimal?	No
RateBasis	form	string	No
Revenue	form	decimal?	No
PayPlanLabel	form	string	No
Pay	form	decimal?	No
Status	form	string	No
OpenedUtc	form	DateTime	No
ClosedUtc	form	DateTime?	No
Photos	form	int	No
Stages	form	List<DispatchLoadStageView>	No

**DispatchLoadStageView** Parameters:
Name	Parameter	Data Type	Required
Stage	form	string	No
AtUtc	form	DateTime	No
Note	form	string	No

**DispatchSettlementSuggestView** Parameters:
Name	Parameter	Data Type	Required
VendorID	form	int	No
VendorName	form	string	No
SplitPct	form	decimal	No
Terms	form	string	No
W9OnFile	form	bool	No
CoiExpires	form	DateTime?	No
PeriodStart	form	DateTime	No
PeriodEnd	form	DateTime	No
UnsettledLoads	form	int	No
UnpricedLoads	form	int	No
UnsettledPay	form	decimal	No

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.

POST /v1/dispatch/settlements/generate HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	VendorID: 0,
	PeriodStart: 0001-01-01,
	PeriodEnd: 0001-01-01
}

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
		}
	}
}