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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class DispatchLoadStageView
    {
        public virtual string Stage { get; set; }
        public virtual DateTime AtUtc { get; set; }
        public virtual string Note { get; set; }
    }

    public partial class DispatchLoadView
    {
        public virtual int LoadId { get; set; }
        public virtual string Code { get; set; }
        public virtual string Module { get; set; }
        public virtual string TruckLabel { get; set; }
        public virtual string DriverLabel { get; set; }
        public virtual string CarrierLabel { get; set; }
        public virtual string SourceLabel { get; set; }
        public virtual string DestinationLabel { get; set; }
        public virtual decimal? Qty { get; set; }
        public virtual string Unit { get; set; }
        public virtual string QtyText { get; set; }
        public virtual string TicketCode { get; set; }
        public virtual decimal? RateApplied { get; set; }
        public virtual string RateBasis { get; set; }
        public virtual decimal? Revenue { get; set; }
        public virtual string PayPlanLabel { get; set; }
        public virtual decimal? Pay { get; set; }
        public virtual string Status { get; set; }
        public virtual DateTime OpenedUtc { get; set; }
        public virtual DateTime? ClosedUtc { get; set; }
        public virtual int Photos { get; set; }
        public virtual List<DispatchLoadStageView> Stages { get; set; } = [];
    }

    public partial class DispatchSettlementDeductionView
    {
        public virtual int DeductionId { get; set; }
        public virtual string Kind { get; set; }
        public virtual string Label { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string Note { get; set; }
    }

    public partial class DispatchSettlementsResponse
    {
        public virtual List<DispatchSettlementView> Settlements { get; set; } = [];
        public virtual DispatchSettlementView Settlement { get; set; }
        public virtual List<DispatchSettlementSuggestView> Suggestions { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class DispatchSettlementStatusRequest
    {
        public virtual int SettlementId { get; set; }
        public virtual string Status { get; set; }
        public virtual string PaidRef { get; set; }
    }

    public partial class DispatchSettlementSuggestView
    {
        public virtual int VendorID { get; set; }
        public virtual string VendorName { get; set; }
        public virtual decimal SplitPct { get; set; }
        public virtual string Terms { get; set; }
        public virtual bool W9OnFile { get; set; }
        public virtual DateTime? CoiExpires { get; set; }
        public virtual DateTime PeriodStart { get; set; }
        public virtual DateTime PeriodEnd { get; set; }
        public virtual int UnsettledLoads { get; set; }
        public virtual int UnpricedLoads { get; set; }
        public virtual decimal UnsettledPay { get; set; }
    }

    public partial class DispatchSettlementView
    {
        public virtual int SettlementId { get; set; }
        public virtual string Code { get; set; }
        public virtual int VendorID { get; set; }
        public virtual string VendorName { get; set; }
        public virtual DateTime PeriodStart { get; set; }
        public virtual DateTime PeriodEnd { get; set; }
        public virtual int LoadCount { get; set; }
        public virtual decimal GrossRevenue { get; set; }
        public virtual decimal SplitPct { get; set; }
        public virtual decimal CarrierShare { get; set; }
        public virtual decimal DeductionsTotal { get; set; }
        public virtual decimal Net { get; set; }
        public virtual string Status { get; set; }
        public virtual string Notes { get; set; }
        public virtual DateTime GeneratedUtc { get; set; }
        public virtual DateTime? SentUtc { get; set; }
        public virtual DateTime? ApprovedUtc { get; set; }
        public virtual string ApprovedBy { get; set; }
        public virtual DateTime? PaidUtc { get; set; }
        public virtual string PaidRef { get; set; }
        public virtual int ContactCount { get; set; }
        public virtual List<DispatchSettlementDeductionView> Deductions { get; set; } = [];
        public virtual List<DispatchLoadView> Loads { get; set; } = [];
    }

}

C# DispatchSettlementStatusRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"SettlementId":0,"Status":"String","PaidRef":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}