Trendsic Platform Service

<back to all web services

PayApplicationUpdateRequest

Requires Authentication
The following routes are available for this service:
PATCH,PUT,OPTIONS/v1/projects/{ProjectID}/pay-apps/{PeriodNumber}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class PayApplicationUpdateRequest
    {
        public Integer ProjectID = null;
        public Integer PeriodNumber = null;
        public Date PeriodStart = null;
        public Date PeriodEnd = null;
        public BigDecimal RetainagePct = null;
        public String BillingTemplate = null;
        public Boolean SubmitForCertification = null;
        public ArrayList<PayApplicationLine> Lines = new ArrayList<PayApplicationLine>();
        public Boolean PullFromWip = null;
        public Boolean AppendApprovedChangeOrders = null;
        
        public Integer getProjectID() { return ProjectID; }
        public PayApplicationUpdateRequest setProjectID(Integer value) { this.ProjectID = value; return this; }
        public Integer getPeriodNumber() { return PeriodNumber; }
        public PayApplicationUpdateRequest setPeriodNumber(Integer value) { this.PeriodNumber = value; return this; }
        public Date getPeriodStart() { return PeriodStart; }
        public PayApplicationUpdateRequest setPeriodStart(Date value) { this.PeriodStart = value; return this; }
        public Date getPeriodEnd() { return PeriodEnd; }
        public PayApplicationUpdateRequest setPeriodEnd(Date value) { this.PeriodEnd = value; return this; }
        public BigDecimal getRetainagePct() { return RetainagePct; }
        public PayApplicationUpdateRequest setRetainagePct(BigDecimal value) { this.RetainagePct = value; return this; }
        public String getBillingTemplate() { return BillingTemplate; }
        public PayApplicationUpdateRequest setBillingTemplate(String value) { this.BillingTemplate = value; return this; }
        public Boolean isSubmitForCertification() { return SubmitForCertification; }
        public PayApplicationUpdateRequest setSubmitForCertification(Boolean value) { this.SubmitForCertification = value; return this; }
        public ArrayList<PayApplicationLine> getLines() { return Lines; }
        public PayApplicationUpdateRequest setLines(ArrayList<PayApplicationLine> value) { this.Lines = value; return this; }
        public Boolean isPullFromWip() { return PullFromWip; }
        public PayApplicationUpdateRequest setPullFromWip(Boolean value) { this.PullFromWip = value; return this; }
        public Boolean isAppendApprovedChangeOrders() { return AppendApprovedChangeOrders; }
        public PayApplicationUpdateRequest setAppendApprovedChangeOrders(Boolean value) { this.AppendApprovedChangeOrders = value; return this; }
    }

    public static class PayApplicationLine
    {
        public Integer PayApplicationLineID = null;
        public Integer PayApplicationID = null;
        public String CostCode = null;
        public String Description = null;
        public BigDecimal ScheduledValue = null;
        public BigDecimal FromPreviousPct = null;
        public BigDecimal ThisPeriodPct = null;
        public BigDecimal StoredMaterials = null;
        public Boolean IsChangeOrder = null;
        public Integer ChangeOrderID = null;
        public Integer SortOrder = null;
        
        public Integer getPayApplicationLineID() { return PayApplicationLineID; }
        public PayApplicationLine setPayApplicationLineID(Integer value) { this.PayApplicationLineID = value; return this; }
        public Integer getPayApplicationID() { return PayApplicationID; }
        public PayApplicationLine setPayApplicationID(Integer value) { this.PayApplicationID = value; return this; }
        public String getCostCode() { return CostCode; }
        public PayApplicationLine setCostCode(String value) { this.CostCode = value; return this; }
        public String getDescription() { return Description; }
        public PayApplicationLine setDescription(String value) { this.Description = value; return this; }
        public BigDecimal getScheduledValue() { return ScheduledValue; }
        public PayApplicationLine setScheduledValue(BigDecimal value) { this.ScheduledValue = value; return this; }
        public BigDecimal getFromPreviousPct() { return FromPreviousPct; }
        public PayApplicationLine setFromPreviousPct(BigDecimal value) { this.FromPreviousPct = value; return this; }
        public BigDecimal getThisPeriodPct() { return ThisPeriodPct; }
        public PayApplicationLine setThisPeriodPct(BigDecimal value) { this.ThisPeriodPct = value; return this; }
        public BigDecimal getStoredMaterials() { return StoredMaterials; }
        public PayApplicationLine setStoredMaterials(BigDecimal value) { this.StoredMaterials = value; return this; }
        public Boolean getIsChangeOrder() { return IsChangeOrder; }
        public PayApplicationLine setIsChangeOrder(Boolean value) { this.IsChangeOrder = value; return this; }
        public Integer getChangeOrderID() { return ChangeOrderID; }
        public PayApplicationLine setChangeOrderID(Integer value) { this.ChangeOrderID = value; return this; }
        public Integer getSortOrder() { return SortOrder; }
        public PayApplicationLine setSortOrder(Integer value) { this.SortOrder = value; return this; }
    }

    public static class PayApplicationResponse
    {
        public ResponseStatus ResponseStatus = null;
        public PayApplication Application = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public PayApplicationResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public PayApplication getApplication() { return Application; }
        public PayApplicationResponse setApplication(PayApplication value) { this.Application = value; return this; }
    }

    public static class PayApplication
    {
        public Integer PayApplicationID = null;
        public UUID PayApplicationUID = null;
        public Integer ProjectID = null;
        public Integer PeriodNumber = null;
        public Date PeriodStart = null;
        public Date PeriodEnd = null;
        public String Status = null;
        public String BillingTemplate = null;
        public BigDecimal RetainagePct = null;
        public BigDecimal OriginalContractSum = null;
        public BigDecimal NetChangeByCO = null;
        public BigDecimal ContractSumToDate = null;
        public BigDecimal CompletedStoredToDate = null;
        public BigDecimal RetainageAmount = null;
        public BigDecimal EarnedLessRetainage = null;
        public BigDecimal LessPreviousCertificates = null;
        public BigDecimal CurrentPaymentDue = null;
        public BigDecimal BalanceToFinish = null;
        public Integer InvoiceID = null;
        public Date CertifiedAt = null;
        public String CertifiedBy = null;
        public String CreatedBy = null;
        public Date CreatedAt = null;
        public Date UpdatedAt = null;
        public ArrayList<PayApplicationLine> Lines = new ArrayList<PayApplicationLine>();
        
        public Integer getPayApplicationID() { return PayApplicationID; }
        public PayApplication setPayApplicationID(Integer value) { this.PayApplicationID = value; return this; }
        public UUID getPayApplicationUID() { return PayApplicationUID; }
        public PayApplication setPayApplicationUID(UUID value) { this.PayApplicationUID = value; return this; }
        public Integer getProjectID() { return ProjectID; }
        public PayApplication setProjectID(Integer value) { this.ProjectID = value; return this; }
        public Integer getPeriodNumber() { return PeriodNumber; }
        public PayApplication setPeriodNumber(Integer value) { this.PeriodNumber = value; return this; }
        public Date getPeriodStart() { return PeriodStart; }
        public PayApplication setPeriodStart(Date value) { this.PeriodStart = value; return this; }
        public Date getPeriodEnd() { return PeriodEnd; }
        public PayApplication setPeriodEnd(Date value) { this.PeriodEnd = value; return this; }
        public String getStatus() { return Status; }
        public PayApplication setStatus(String value) { this.Status = value; return this; }
        public String getBillingTemplate() { return BillingTemplate; }
        public PayApplication setBillingTemplate(String value) { this.BillingTemplate = value; return this; }
        public BigDecimal getRetainagePct() { return RetainagePct; }
        public PayApplication setRetainagePct(BigDecimal value) { this.RetainagePct = value; return this; }
        public BigDecimal getOriginalContractSum() { return OriginalContractSum; }
        public PayApplication setOriginalContractSum(BigDecimal value) { this.OriginalContractSum = value; return this; }
        public BigDecimal getNetChangeByCO() { return NetChangeByCO; }
        public PayApplication setNetChangeByCO(BigDecimal value) { this.NetChangeByCO = value; return this; }
        public BigDecimal getContractSumToDate() { return ContractSumToDate; }
        public PayApplication setContractSumToDate(BigDecimal value) { this.ContractSumToDate = value; return this; }
        public BigDecimal getCompletedStoredToDate() { return CompletedStoredToDate; }
        public PayApplication setCompletedStoredToDate(BigDecimal value) { this.CompletedStoredToDate = value; return this; }
        public BigDecimal getRetainageAmount() { return RetainageAmount; }
        public PayApplication setRetainageAmount(BigDecimal value) { this.RetainageAmount = value; return this; }
        public BigDecimal getEarnedLessRetainage() { return EarnedLessRetainage; }
        public PayApplication setEarnedLessRetainage(BigDecimal value) { this.EarnedLessRetainage = value; return this; }
        public BigDecimal getLessPreviousCertificates() { return LessPreviousCertificates; }
        public PayApplication setLessPreviousCertificates(BigDecimal value) { this.LessPreviousCertificates = value; return this; }
        public BigDecimal getCurrentPaymentDue() { return CurrentPaymentDue; }
        public PayApplication setCurrentPaymentDue(BigDecimal value) { this.CurrentPaymentDue = value; return this; }
        public BigDecimal getBalanceToFinish() { return BalanceToFinish; }
        public PayApplication setBalanceToFinish(BigDecimal value) { this.BalanceToFinish = value; return this; }
        public Integer getInvoiceID() { return InvoiceID; }
        public PayApplication setInvoiceID(Integer value) { this.InvoiceID = value; return this; }
        public Date getCertifiedAt() { return CertifiedAt; }
        public PayApplication setCertifiedAt(Date value) { this.CertifiedAt = value; return this; }
        public String getCertifiedBy() { return CertifiedBy; }
        public PayApplication setCertifiedBy(String value) { this.CertifiedBy = value; return this; }
        public String getCreatedBy() { return CreatedBy; }
        public PayApplication setCreatedBy(String value) { this.CreatedBy = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public PayApplication setCreatedAt(Date value) { this.CreatedAt = value; return this; }
        public Date getUpdatedAt() { return UpdatedAt; }
        public PayApplication setUpdatedAt(Date value) { this.UpdatedAt = value; return this; }
        public ArrayList<PayApplicationLine> getLines() { return Lines; }
        public PayApplication setLines(ArrayList<PayApplicationLine> value) { this.Lines = value; return this; }
    }

}

Java PayApplicationUpdateRequest 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.

PUT /v1/projects/{ProjectID}/pay-apps/{PeriodNumber} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProjectID: 0,
	PeriodNumber: 0,
	PeriodStart: 0001-01-01,
	PeriodEnd: 0001-01-01,
	RetainagePct: 0,
	BillingTemplate: String,
	SubmitForCertification: False,
	Lines: 
	[
		{
			PayApplicationLineID: 0,
			PayApplicationID: 0,
			CostCode: String,
			Description: String,
			ScheduledValue: 0,
			FromPreviousPct: 0,
			ThisPeriodPct: 0,
			StoredMaterials: 0,
			IsChangeOrder: False,
			ChangeOrderID: 0,
			SortOrder: 0
		}
	],
	PullFromWip: False,
	AppendApprovedChangeOrders: False
}
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
			}
		]
	}
}