Trendsic Platform Service

<back to all web services

DispatchSettlementGenerateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/settlements/generate
"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 DispatchSettlementGenerateRequest {
    /** @param {{VendorID?:number,PeriodStart?:string,PeriodEnd?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    VendorID;
    /** @type {string} */
    PeriodStart;
    /** @type {string} */
    PeriodEnd;
}

JavaScript DispatchSettlementGenerateRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchSettlementGenerateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <PeriodEnd>0001-01-01T00:00:00</PeriodEnd>
  <PeriodStart>0001-01-01T00:00:00</PeriodStart>
  <VendorID>0</VendorID>
</DispatchSettlementGenerateRequest>

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

<DispatchSettlementsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Settlement>
    <ApprovedBy>String</ApprovedBy>
    <ApprovedUtc>0001-01-01T00:00:00</ApprovedUtc>
    <CarrierShare>0</CarrierShare>
    <Code>String</Code>
    <ContactCount>0</ContactCount>
    <Deductions>
      <DispatchSettlementDeductionView>
        <Amount>0</Amount>
        <DeductionId>0</DeductionId>
        <Kind>String</Kind>
        <Label>String</Label>
        <Note>String</Note>
      </DispatchSettlementDeductionView>
    </Deductions>
    <DeductionsTotal>0</DeductionsTotal>
    <GeneratedUtc>0001-01-01T00:00:00</GeneratedUtc>
    <GrossRevenue>0</GrossRevenue>
    <LoadCount>0</LoadCount>
    <Loads>
      <DispatchLoadView>
        <CarrierLabel>String</CarrierLabel>
        <ClosedUtc>0001-01-01T00:00:00</ClosedUtc>
        <Code>String</Code>
        <DestinationLabel>String</DestinationLabel>
        <DriverLabel>String</DriverLabel>
        <LoadId>0</LoadId>
        <Module>String</Module>
        <OpenedUtc>0001-01-01T00:00:00</OpenedUtc>
        <Pay>0</Pay>
        <PayPlanLabel>String</PayPlanLabel>
        <Photos>0</Photos>
        <Qty>0</Qty>
        <QtyText>String</QtyText>
        <RateApplied>0</RateApplied>
        <RateBasis>String</RateBasis>
        <Revenue>0</Revenue>
        <SourceLabel>String</SourceLabel>
        <Stages>
          <DispatchLoadStageView>
            <AtUtc>0001-01-01T00:00:00</AtUtc>
            <Note>String</Note>
            <Stage>String</Stage>
          </DispatchLoadStageView>
        </Stages>
        <Status>String</Status>
        <TicketCode>String</TicketCode>
        <TruckLabel>String</TruckLabel>
        <Unit>String</Unit>
      </DispatchLoadView>
    </Loads>
    <Net>0</Net>
    <Notes>String</Notes>
    <PaidRef>String</PaidRef>
    <PaidUtc>0001-01-01T00:00:00</PaidUtc>
    <PeriodEnd>0001-01-01T00:00:00</PeriodEnd>
    <PeriodStart>0001-01-01T00:00:00</PeriodStart>
    <SentUtc>0001-01-01T00:00:00</SentUtc>
    <SettlementId>0</SettlementId>
    <SplitPct>0</SplitPct>
    <Status>String</Status>
    <VendorID>0</VendorID>
    <VendorName>String</VendorName>
  </Settlement>
  <Settlements>
    <DispatchSettlementView>
      <ApprovedBy>String</ApprovedBy>
      <ApprovedUtc>0001-01-01T00:00:00</ApprovedUtc>
      <CarrierShare>0</CarrierShare>
      <Code>String</Code>
      <ContactCount>0</ContactCount>
      <Deductions>
        <DispatchSettlementDeductionView>
          <Amount>0</Amount>
          <DeductionId>0</DeductionId>
          <Kind>String</Kind>
          <Label>String</Label>
          <Note>String</Note>
        </DispatchSettlementDeductionView>
      </Deductions>
      <DeductionsTotal>0</DeductionsTotal>
      <GeneratedUtc>0001-01-01T00:00:00</GeneratedUtc>
      <GrossRevenue>0</GrossRevenue>
      <LoadCount>0</LoadCount>
      <Loads>
        <DispatchLoadView>
          <CarrierLabel>String</CarrierLabel>
          <ClosedUtc>0001-01-01T00:00:00</ClosedUtc>
          <Code>String</Code>
          <DestinationLabel>String</DestinationLabel>
          <DriverLabel>String</DriverLabel>
          <LoadId>0</LoadId>
          <Module>String</Module>
          <OpenedUtc>0001-01-01T00:00:00</OpenedUtc>
          <Pay>0</Pay>
          <PayPlanLabel>String</PayPlanLabel>
          <Photos>0</Photos>
          <Qty>0</Qty>
          <QtyText>String</QtyText>
          <RateApplied>0</RateApplied>
          <RateBasis>String</RateBasis>
          <Revenue>0</Revenue>
          <SourceLabel>String</SourceLabel>
          <Stages>
            <DispatchLoadStageView>
              <AtUtc>0001-01-01T00:00:00</AtUtc>
              <Note>String</Note>
              <Stage>String</Stage>
            </DispatchLoadStageView>
          </Stages>
          <Status>String</Status>
          <TicketCode>String</TicketCode>
          <TruckLabel>String</TruckLabel>
          <Unit>String</Unit>
        </DispatchLoadView>
      </Loads>
      <Net>0</Net>
      <Notes>String</Notes>
      <PaidRef>String</PaidRef>
      <PaidUtc>0001-01-01T00:00:00</PaidUtc>
      <PeriodEnd>0001-01-01T00:00:00</PeriodEnd>
      <PeriodStart>0001-01-01T00:00:00</PeriodStart>
      <SentUtc>0001-01-01T00:00:00</SentUtc>
      <SettlementId>0</SettlementId>
      <SplitPct>0</SplitPct>
      <Status>String</Status>
      <VendorID>0</VendorID>
      <VendorName>String</VendorName>
    </DispatchSettlementView>
  </Settlements>
  <Suggestions>
    <DispatchSettlementSuggestView>
      <CoiExpires>0001-01-01T00:00:00</CoiExpires>
      <PeriodEnd>0001-01-01T00:00:00</PeriodEnd>
      <PeriodStart>0001-01-01T00:00:00</PeriodStart>
      <SplitPct>0</SplitPct>
      <Terms>String</Terms>
      <UnpricedLoads>0</UnpricedLoads>
      <UnsettledLoads>0</UnsettledLoads>
      <UnsettledPay>0</UnsettledPay>
      <VendorID>0</VendorID>
      <VendorName>String</VendorName>
      <W9OnFile>false</W9OnFile>
    </DispatchSettlementSuggestView>
  </Suggestions>
</DispatchSettlementsResponse>