Trendsic Platform Service

<back to all web services

ReleaseRetainageRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/projects/{ProjectID}/closeout/release-retainage
import 'package:servicestack/servicestack.dart';

class CloseoutStatus implements IConvertible
{
    int? ProjectID;
    int? TotalItems;
    int? DoneCount;
    int? OutstandingCount;
    bool? AllClear;
    double? RetainageAmount;
    bool? RetainageReleased;
    int? ReleasedPayApplicationID;
    int? ReleasedInvoiceID;
    DateTime? ReleasedAt;

    CloseoutStatus({this.ProjectID,this.TotalItems,this.DoneCount,this.OutstandingCount,this.AllClear,this.RetainageAmount,this.RetainageReleased,this.ReleasedPayApplicationID,this.ReleasedInvoiceID,this.ReleasedAt});
    CloseoutStatus.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ProjectID = json['ProjectID'];
        TotalItems = json['TotalItems'];
        DoneCount = json['DoneCount'];
        OutstandingCount = json['OutstandingCount'];
        AllClear = json['AllClear'];
        RetainageAmount = JsonConverters.toDouble(json['RetainageAmount']);
        RetainageReleased = json['RetainageReleased'];
        ReleasedPayApplicationID = json['ReleasedPayApplicationID'];
        ReleasedInvoiceID = json['ReleasedInvoiceID'];
        ReleasedAt = JsonConverters.fromJson(json['ReleasedAt'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ProjectID': ProjectID,
        'TotalItems': TotalItems,
        'DoneCount': DoneCount,
        'OutstandingCount': OutstandingCount,
        'AllClear': AllClear,
        'RetainageAmount': RetainageAmount,
        'RetainageReleased': RetainageReleased,
        'ReleasedPayApplicationID': ReleasedPayApplicationID,
        'ReleasedInvoiceID': ReleasedInvoiceID,
        'ReleasedAt': JsonConverters.toJson(ReleasedAt,'DateTime',context!)
    };

    getTypeName() => "CloseoutStatus";
    TypeContext? context = _ctx;
}

class ReleaseRetainageResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    int? ProjectID;
    CloseoutStatus? Status;
    int? PayApplicationID;
    int? InvoiceID;
    double? RetainageReleased;

    ReleaseRetainageResponse({this.ResponseStatus,this.ProjectID,this.Status,this.PayApplicationID,this.InvoiceID,this.RetainageReleased});
    ReleaseRetainageResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        ProjectID = json['ProjectID'];
        Status = JsonConverters.fromJson(json['Status'],'CloseoutStatus',context!);
        PayApplicationID = json['PayApplicationID'];
        InvoiceID = json['InvoiceID'];
        RetainageReleased = JsonConverters.toDouble(json['RetainageReleased']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'ProjectID': ProjectID,
        'Status': JsonConverters.toJson(Status,'CloseoutStatus',context!),
        'PayApplicationID': PayApplicationID,
        'InvoiceID': InvoiceID,
        'RetainageReleased': RetainageReleased
    };

    getTypeName() => "ReleaseRetainageResponse";
    TypeContext? context = _ctx;
}

class ReleaseRetainageRequest implements IConvertible
{
    int? ProjectID;

    ReleaseRetainageRequest({this.ProjectID});
    ReleaseRetainageRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ProjectID = json['ProjectID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ProjectID': ProjectID
    };

    getTypeName() => "ReleaseRetainageRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'CloseoutStatus': TypeInfo(TypeOf.Class, create:() => CloseoutStatus()),
    'ReleaseRetainageResponse': TypeInfo(TypeOf.Class, create:() => ReleaseRetainageResponse()),
    'ReleaseRetainageRequest': TypeInfo(TypeOf.Class, create:() => ReleaseRetainageRequest()),
});

Dart ReleaseRetainageRequest 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/projects/{ProjectID}/closeout/release-retainage HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReleaseRetainageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ProjectID>0</ProjectID>
</ReleaseRetainageRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReleaseRetainageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <InvoiceID>0</InvoiceID>
  <PayApplicationID>0</PayApplicationID>
  <ProjectID>0</ProjectID>
  <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>
  <RetainageReleased>0</RetainageReleased>
  <Status>
    <AllClear>false</AllClear>
    <DoneCount>0</DoneCount>
    <OutstandingCount>0</OutstandingCount>
    <ProjectID>0</ProjectID>
    <ReleasedAt>0001-01-01T00:00:00</ReleasedAt>
    <ReleasedInvoiceID>0</ReleasedInvoiceID>
    <ReleasedPayApplicationID>0</ReleasedPayApplicationID>
    <RetainageAmount>0</RetainageAmount>
    <RetainageReleased>false</RetainageReleased>
    <TotalItems>0</TotalItems>
  </Status>
</ReleaseRetainageResponse>