| PUT,OPTIONS | /v1/dispatch/settlements/{SettlementId}/deduction |
|---|
namespace CRM.AgencyPlatform.API.Internal
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type DispatchSettlementDeductionView() =
member val DeductionId:Int32 = new Int32() with get,set
member val Kind:String = null with get,set
member val Label:String = null with get,set
member val Amount:Decimal = new Decimal() with get,set
member val Note:String = null with get,set
[<AllowNullLiteral>]
type DispatchLoadStageView() =
member val Stage:String = null with get,set
member val AtUtc:DateTime = new DateTime() with get,set
member val Note:String = null with get,set
[<AllowNullLiteral>]
type DispatchLoadView() =
member val LoadId:Int32 = new Int32() with get,set
member val Code:String = null with get,set
member val Module:String = null with get,set
member val TruckLabel:String = null with get,set
member val DriverLabel:String = null with get,set
member val CarrierLabel:String = null with get,set
member val SourceLabel:String = null with get,set
member val DestinationLabel:String = null with get,set
member val Qty:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val Unit:String = null with get,set
member val QtyText:String = null with get,set
member val TicketCode:String = null with get,set
member val RateApplied:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val RateBasis:String = null with get,set
member val Revenue:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val PayPlanLabel:String = null with get,set
member val Pay:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val Status:String = null with get,set
member val OpenedUtc:DateTime = new DateTime() with get,set
member val ClosedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Photos:Int32 = new Int32() with get,set
member val Stages:ResizeArray<DispatchLoadStageView> = new ResizeArray<DispatchLoadStageView>() with get,set
[<AllowNullLiteral>]
type DispatchSettlementView() =
member val SettlementId:Int32 = new Int32() with get,set
member val Code:String = null with get,set
member val VendorID:Int32 = new Int32() with get,set
member val VendorName:String = null with get,set
member val PeriodStart:DateTime = new DateTime() with get,set
member val PeriodEnd:DateTime = new DateTime() with get,set
member val LoadCount:Int32 = new Int32() with get,set
member val GrossRevenue:Decimal = new Decimal() with get,set
member val SplitPct:Decimal = new Decimal() with get,set
member val CarrierShare:Decimal = new Decimal() with get,set
member val DeductionsTotal:Decimal = new Decimal() with get,set
member val Net:Decimal = new Decimal() with get,set
member val Status:String = null with get,set
member val Notes:String = null with get,set
member val GeneratedUtc:DateTime = new DateTime() with get,set
member val SentUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val ApprovedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val ApprovedBy:String = null with get,set
member val PaidUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val PaidRef:String = null with get,set
member val ContactCount:Int32 = new Int32() with get,set
member val Deductions:ResizeArray<DispatchSettlementDeductionView> = new ResizeArray<DispatchSettlementDeductionView>() with get,set
member val Loads:ResizeArray<DispatchLoadView> = new ResizeArray<DispatchLoadView>() with get,set
[<AllowNullLiteral>]
type DispatchSettlementSuggestView() =
member val VendorID:Int32 = new Int32() with get,set
member val VendorName:String = null with get,set
member val SplitPct:Decimal = new Decimal() with get,set
member val Terms:String = null with get,set
member val W9OnFile:Boolean = new Boolean() with get,set
member val CoiExpires:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val PeriodStart:DateTime = new DateTime() with get,set
member val PeriodEnd:DateTime = new DateTime() with get,set
member val UnsettledLoads:Int32 = new Int32() with get,set
member val UnpricedLoads:Int32 = new Int32() with get,set
member val UnsettledPay:Decimal = new Decimal() with get,set
[<AllowNullLiteral>]
type DispatchSettlementsResponse() =
member val Settlements:ResizeArray<DispatchSettlementView> = new ResizeArray<DispatchSettlementView>() with get,set
member val Settlement:DispatchSettlementView = null with get,set
member val Suggestions:ResizeArray<DispatchSettlementSuggestView> = new ResizeArray<DispatchSettlementSuggestView>() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type DispatchSettlementDeductionRequest() =
member val SettlementId:Int32 = new Int32() with get,set
member val Deduction:DispatchSettlementDeductionView = null with get,set
member val Delete:Boolean = new Boolean() with get,set
F# DispatchSettlementDeductionRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /v1/dispatch/settlements/{SettlementId}/deduction HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SettlementId: 0,
Deduction:
{
DeductionId: 0,
Kind: String,
Label: String,
Amount: 0,
Note: String
},
Delete: False
}
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
}
}
}