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

export class CloseoutStatus
{
    public ProjectID: number;
    public TotalItems: number;
    public DoneCount: number;
    public OutstandingCount: number;
    public AllClear: boolean;
    public RetainageAmount: number;
    public RetainageReleased: boolean;
    public ReleasedPayApplicationID?: number;
    public ReleasedInvoiceID?: number;
    public ReleasedAt?: string;

    public constructor(init?: Partial<CloseoutStatus>) { (Object as any).assign(this, init); }
}

export class ReleaseRetainageResponse
{
    public ResponseStatus: ResponseStatus;
    public ProjectID: number;
    public Status: CloseoutStatus;
    public PayApplicationID?: number;
    public InvoiceID?: number;
    public RetainageReleased: number;

    public constructor(init?: Partial<ReleaseRetainageResponse>) { (Object as any).assign(this, init); }
}

export class ReleaseRetainageRequest
{
    public ProjectID: number;

    public constructor(init?: Partial<ReleaseRetainageRequest>) { (Object as any).assign(this, init); }
}

TypeScript ReleaseRetainageRequest DTOs

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

HTTP + CSV

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

{"ProjectID":0}
HTTP/1.1 200 OK
Content-Type: text/csv
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}