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}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class PayApplicationDetailRequest
{
    open var ProjectID:Int? = null
    open var PeriodNumber:Int? = null
}

open class PayApplicationResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Application:PayApplication? = null
}

open class PayApplication
{
    open var PayApplicationID:Int? = null
    open var PayApplicationUID:UUID? = null
    open var ProjectID:Int? = null
    open var PeriodNumber:Int? = null
    open var PeriodStart:Date? = null
    open var PeriodEnd:Date? = null
    open var Status:String? = null
    open var BillingTemplate:String? = null
    open var RetainagePct:BigDecimal? = null
    open var OriginalContractSum:BigDecimal? = null
    open var NetChangeByCO:BigDecimal? = null
    open var ContractSumToDate:BigDecimal? = null
    open var CompletedStoredToDate:BigDecimal? = null
    open var RetainageAmount:BigDecimal? = null
    open var EarnedLessRetainage:BigDecimal? = null
    open var LessPreviousCertificates:BigDecimal? = null
    open var CurrentPaymentDue:BigDecimal? = null
    open var BalanceToFinish:BigDecimal? = null
    open var InvoiceID:Int? = null
    open var CertifiedAt:Date? = null
    open var CertifiedBy:String? = null
    open var CreatedBy:String? = null
    open var CreatedAt:Date? = null
    open var UpdatedAt:Date? = null
    open var Lines:ArrayList<PayApplicationLine> = ArrayList<PayApplicationLine>()
}

open class PayApplicationLine
{
    open var PayApplicationLineID:Int? = null
    open var PayApplicationID:Int? = null
    open var CostCode:String? = null
    open var Description:String? = null
    open var ScheduledValue:BigDecimal? = null
    open var FromPreviousPct:BigDecimal? = null
    open var ThisPeriodPct:BigDecimal? = null
    open var StoredMaterials:BigDecimal? = null
    open var IsChangeOrder:Boolean? = null
    open var ChangeOrderID:Int? = null
    open var SortOrder:Int? = null
}

Kotlin 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
			}
		]
	}
}