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
"use strict";
export class CloseoutStatus {
    /** @param {{ProjectID?:number,TotalItems?:number,DoneCount?:number,OutstandingCount?:number,AllClear?:boolean,RetainageAmount?:number,RetainageReleased?:boolean,ReleasedPayApplicationID?:number,ReleasedInvoiceID?:number,ReleasedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {number} */
    TotalItems;
    /** @type {number} */
    DoneCount;
    /** @type {number} */
    OutstandingCount;
    /** @type {boolean} */
    AllClear;
    /** @type {number} */
    RetainageAmount;
    /** @type {boolean} */
    RetainageReleased;
    /** @type {?number} */
    ReleasedPayApplicationID;
    /** @type {?number} */
    ReleasedInvoiceID;
    /** @type {?string} */
    ReleasedAt;
}
export class ReleaseRetainageResponse {
    /** @param {{ResponseStatus?:ResponseStatus,ProjectID?:number,Status?:CloseoutStatus,PayApplicationID?:number,InvoiceID?:number,RetainageReleased?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {number} */
    ProjectID;
    /** @type {CloseoutStatus} */
    Status;
    /** @type {?number} */
    PayApplicationID;
    /** @type {?number} */
    InvoiceID;
    /** @type {number} */
    RetainageReleased;
}
export class ReleaseRetainageRequest {
    /** @param {{ProjectID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
}

JavaScript ReleaseRetainageRequest DTOs

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

HTTP + JSV

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

{
	ProjectID: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01
	},
	PayApplicationID: 0,
	InvoiceID: 0,
	RetainageReleased: 0
}