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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CloseoutStatus() = 
        member val ProjectID:Int32 = new Int32() with get,set
        member val TotalItems:Int32 = new Int32() with get,set
        member val DoneCount:Int32 = new Int32() with get,set
        member val OutstandingCount:Int32 = new Int32() with get,set
        member val AllClear:Boolean = new Boolean() with get,set
        member val RetainageAmount:Decimal = new Decimal() with get,set
        member val RetainageReleased:Boolean = new Boolean() with get,set
        member val ReleasedPayApplicationID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ReleasedInvoiceID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ReleasedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type ReleaseRetainageResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val Status:CloseoutStatus = null with get,set
        member val PayApplicationID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val InvoiceID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RetainageReleased:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type ReleaseRetainageRequest() = 
        member val ProjectID:Int32 = new Int32() with get,set

F# 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
}