Trendsic Platform Service

<back to all web services

PayApplicationListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/pay-apps
PayApplicationListRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectIDpathintNo
PayApplicationListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ProjectIDformintNo
ApplicationsformList<PayApplication>No
PayApplication Parameters:
NameParameterData TypeRequiredDescription
PayApplicationIDformintNo
PayApplicationUIDformGuidNo
ProjectIDformintNo
PeriodNumberformintNo
PeriodStartformDateTime?No
PeriodEndformDateTime?No
StatusformstringNo
BillingTemplateformstringNo
RetainagePctformdecimalNo
OriginalContractSumformdecimalNo
NetChangeByCOformdecimalNo
ContractSumToDateformdecimalNo
CompletedStoredToDateformdecimalNo
RetainageAmountformdecimalNo
EarnedLessRetainageformdecimalNo
LessPreviousCertificatesformdecimalNo
CurrentPaymentDueformdecimalNo
BalanceToFinishformdecimalNo
InvoiceIDformint?No
CertifiedAtformDateTime?No
CertifiedByformstringNo
CreatedByformstringNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No
LinesformList<PayApplicationLine>No
PayApplicationLine Parameters:
NameParameterData TypeRequiredDescription
PayApplicationLineIDformintNo
PayApplicationIDformintNo
CostCodeformstringNo
DescriptionformstringNo
ScheduledValueformdecimalNo
FromPreviousPctformdecimalNo
ThisPeriodPctformdecimalNo
StoredMaterialsformdecimalNo
IsChangeOrderformboolNo
ChangeOrderIDformint?No
SortOrderformintNo

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 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
		}
	},
	ProjectID: 0,
	Applications: 
	[
		{
			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
				}
			]
		}
	]
}