Trendsic Platform Service

<back to all web services

PayApplicationDetailRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/pay-apps/{PeriodNumber}
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 PayApplicationLine() = 
        member val PayApplicationLineID:Int32 = new Int32() with get,set
        member val PayApplicationID:Int32 = new Int32() with get,set
        member val CostCode:String = null with get,set
        member val Description:String = null with get,set
        member val ScheduledValue:Decimal = new Decimal() with get,set
        member val FromPreviousPct:Decimal = new Decimal() with get,set
        member val ThisPeriodPct:Decimal = new Decimal() with get,set
        member val StoredMaterials:Decimal = new Decimal() with get,set
        member val IsChangeOrder:Boolean = new Boolean() with get,set
        member val ChangeOrderID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SortOrder:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PayApplication() = 
        member val PayApplicationID:Int32 = new Int32() with get,set
        member val PayApplicationUID:Guid = new Guid() with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val PeriodNumber:Int32 = new Int32() with get,set
        member val PeriodStart:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PeriodEnd:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Status:String = null with get,set
        member val BillingTemplate:String = null with get,set
        member val RetainagePct:Decimal = new Decimal() with get,set
        member val OriginalContractSum:Decimal = new Decimal() with get,set
        member val NetChangeByCO:Decimal = new Decimal() with get,set
        member val ContractSumToDate:Decimal = new Decimal() with get,set
        member val CompletedStoredToDate:Decimal = new Decimal() with get,set
        member val RetainageAmount:Decimal = new Decimal() with get,set
        member val EarnedLessRetainage:Decimal = new Decimal() with get,set
        member val LessPreviousCertificates:Decimal = new Decimal() with get,set
        member val CurrentPaymentDue:Decimal = new Decimal() with get,set
        member val BalanceToFinish:Decimal = new Decimal() with get,set
        member val InvoiceID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CertifiedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CertifiedBy:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Lines:ResizeArray<PayApplicationLine> = new ResizeArray<PayApplicationLine>() with get,set

    [<AllowNullLiteral>]
    type PayApplicationResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Application:PayApplication = null with get,set

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

F# PayApplicationDetailRequest 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.

GET /v1/projects/{ProjectID}/pay-apps/{PeriodNumber} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	Application: 
	{
		PayApplicationID: 0,
		PayApplicationUID: 00000000000000000000000000000000,
		ProjectID: 0,
		PeriodNumber: 0,
		PeriodStart: 0001-01-01,
		PeriodEnd: 0001-01-01,
		Status: String,
		BillingTemplate: String,
		RetainagePct: 0,
		OriginalContractSum: 0,
		NetChangeByCO: 0,
		ContractSumToDate: 0,
		CompletedStoredToDate: 0,
		RetainageAmount: 0,
		EarnedLessRetainage: 0,
		LessPreviousCertificates: 0,
		CurrentPaymentDue: 0,
		BalanceToFinish: 0,
		InvoiceID: 0,
		CertifiedAt: 0001-01-01,
		CertifiedBy: String,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		UpdatedAt: 0001-01-01,
		Lines: 
		[
			{
				PayApplicationLineID: 0,
				PayApplicationID: 0,
				CostCode: String,
				Description: String,
				ScheduledValue: 0,
				FromPreviousPct: 0,
				ThisPeriodPct: 0,
				StoredMaterials: 0,
				IsChangeOrder: False,
				ChangeOrderID: 0,
				SortOrder: 0
			}
		]
	}
}