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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ReleaseRetainageRequest
    {
        public Integer ProjectID = null;
        
        public Integer getProjectID() { return ProjectID; }
        public ReleaseRetainageRequest setProjectID(Integer value) { this.ProjectID = value; return this; }
    }

    public static class ReleaseRetainageResponse
    {
        public ResponseStatus ResponseStatus = null;
        public Integer ProjectID = null;
        public CloseoutStatus Status = null;
        public Integer PayApplicationID = null;
        public Integer InvoiceID = null;
        public BigDecimal RetainageReleased = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ReleaseRetainageResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public Integer getProjectID() { return ProjectID; }
        public ReleaseRetainageResponse setProjectID(Integer value) { this.ProjectID = value; return this; }
        public CloseoutStatus getStatus() { return Status; }
        public ReleaseRetainageResponse setStatus(CloseoutStatus value) { this.Status = value; return this; }
        public Integer getPayApplicationID() { return PayApplicationID; }
        public ReleaseRetainageResponse setPayApplicationID(Integer value) { this.PayApplicationID = value; return this; }
        public Integer getInvoiceID() { return InvoiceID; }
        public ReleaseRetainageResponse setInvoiceID(Integer value) { this.InvoiceID = value; return this; }
        public BigDecimal getRetainageReleased() { return RetainageReleased; }
        public ReleaseRetainageResponse setRetainageReleased(BigDecimal value) { this.RetainageReleased = value; return this; }
    }

    public static class CloseoutStatus
    {
        public Integer ProjectID = null;
        public Integer TotalItems = null;
        public Integer DoneCount = null;
        public Integer OutstandingCount = null;
        public Boolean AllClear = null;
        public BigDecimal RetainageAmount = null;
        public Boolean RetainageReleased = null;
        public Integer ReleasedPayApplicationID = null;
        public Integer ReleasedInvoiceID = null;
        public Date ReleasedAt = null;
        
        public Integer getProjectID() { return ProjectID; }
        public CloseoutStatus setProjectID(Integer value) { this.ProjectID = value; return this; }
        public Integer getTotalItems() { return TotalItems; }
        public CloseoutStatus setTotalItems(Integer value) { this.TotalItems = value; return this; }
        public Integer getDoneCount() { return DoneCount; }
        public CloseoutStatus setDoneCount(Integer value) { this.DoneCount = value; return this; }
        public Integer getOutstandingCount() { return OutstandingCount; }
        public CloseoutStatus setOutstandingCount(Integer value) { this.OutstandingCount = value; return this; }
        public Boolean isAllClear() { return AllClear; }
        public CloseoutStatus setAllClear(Boolean value) { this.AllClear = value; return this; }
        public BigDecimal getRetainageAmount() { return RetainageAmount; }
        public CloseoutStatus setRetainageAmount(BigDecimal value) { this.RetainageAmount = value; return this; }
        public Boolean isRetainageReleased() { return RetainageReleased; }
        public CloseoutStatus setRetainageReleased(Boolean value) { this.RetainageReleased = value; return this; }
        public Integer getReleasedPayApplicationID() { return ReleasedPayApplicationID; }
        public CloseoutStatus setReleasedPayApplicationID(Integer value) { this.ReleasedPayApplicationID = value; return this; }
        public Integer getReleasedInvoiceID() { return ReleasedInvoiceID; }
        public CloseoutStatus setReleasedInvoiceID(Integer value) { this.ReleasedInvoiceID = value; return this; }
        public Date getReleasedAt() { return ReleasedAt; }
        public CloseoutStatus setReleasedAt(Date value) { this.ReleasedAt = value; return this; }
    }

}

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