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 Foundation
import ServiceStack

public class ReleaseRetainageRequest : Codable
{
    public var projectID:Int

    required public init(){}
}

public class ReleaseRetainageResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var projectID:Int
    public var status:CloseoutStatus
    public var payApplicationID:Int?
    public var invoiceID:Int?
    public var retainageReleased:Double

    required public init(){}
}

public class CloseoutStatus : Codable
{
    public var projectID:Int
    public var totalItems:Int
    public var doneCount:Int
    public var outstandingCount:Int
    public var allClear:Bool
    public var retainageAmount:Double
    public var retainageReleased:Bool
    public var releasedPayApplicationID:Int?
    public var releasedInvoiceID:Int?
    public var releasedAt:Date?

    required public init(){}
}


Swift ReleaseRetainageRequest DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ProjectID":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ProjectID":0,"Status":{"ProjectID":0,"TotalItems":0,"DoneCount":0,"OutstandingCount":0,"AllClear":false,"RetainageAmount":0,"RetainageReleased":false,"ReleasedPayApplicationID":0,"ReleasedInvoiceID":0,"ReleasedAt":"0001-01-01T00:00:00.0000000"},"PayApplicationID":0,"InvoiceID":0,"RetainageReleased":0}