| PATCH,PUT,OPTIONS | /v1/projects/{ProjectID}/pay-apps/{PeriodNumber} |
|---|
"use strict";
export class PayApplicationLine {
/** @param {{PayApplicationLineID?:number,PayApplicationID?:number,CostCode?:string,Description?:string,ScheduledValue?:number,FromPreviousPct?:number,ThisPeriodPct?:number,StoredMaterials?:number,IsChangeOrder?:boolean,ChangeOrderID?:number,SortOrder?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
PayApplicationLineID;
/** @type {number} */
PayApplicationID;
/** @type {string} */
CostCode;
/** @type {string} */
Description;
/** @type {number} */
ScheduledValue;
/** @type {number} */
FromPreviousPct;
/** @type {number} */
ThisPeriodPct;
/** @type {number} */
StoredMaterials;
/** @type {boolean} */
IsChangeOrder;
/** @type {?number} */
ChangeOrderID;
/** @type {number} */
SortOrder;
}
export class PayApplication {
/** @param {{PayApplicationID?:number,PayApplicationUID?:string,ProjectID?:number,PeriodNumber?:number,PeriodStart?:string,PeriodEnd?:string,Status?:string,BillingTemplate?:string,RetainagePct?:number,OriginalContractSum?:number,NetChangeByCO?:number,ContractSumToDate?:number,CompletedStoredToDate?:number,RetainageAmount?:number,EarnedLessRetainage?:number,LessPreviousCertificates?:number,CurrentPaymentDue?:number,BalanceToFinish?:number,InvoiceID?:number,CertifiedAt?:string,CertifiedBy?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string,Lines?:PayApplicationLine[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
PayApplicationID;
/** @type {string} */
PayApplicationUID;
/** @type {number} */
ProjectID;
/** @type {number} */
PeriodNumber;
/** @type {?string} */
PeriodStart;
/** @type {?string} */
PeriodEnd;
/** @type {string} */
Status;
/** @type {string} */
BillingTemplate;
/** @type {number} */
RetainagePct;
/** @type {number} */
OriginalContractSum;
/** @type {number} */
NetChangeByCO;
/** @type {number} */
ContractSumToDate;
/** @type {number} */
CompletedStoredToDate;
/** @type {number} */
RetainageAmount;
/** @type {number} */
EarnedLessRetainage;
/** @type {number} */
LessPreviousCertificates;
/** @type {number} */
CurrentPaymentDue;
/** @type {number} */
BalanceToFinish;
/** @type {?number} */
InvoiceID;
/** @type {?string} */
CertifiedAt;
/** @type {string} */
CertifiedBy;
/** @type {string} */
CreatedBy;
/** @type {?string} */
CreatedAt;
/** @type {?string} */
UpdatedAt;
/** @type {PayApplicationLine[]} */
Lines = [];
}
export class PayApplicationResponse {
/** @param {{ResponseStatus?:ResponseStatus,Application?:PayApplication}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {PayApplication} */
Application;
}
export class PayApplicationUpdateRequest {
/** @param {{ProjectID?:number,PeriodNumber?:number,PeriodStart?:string,PeriodEnd?:string,RetainagePct?:number,BillingTemplate?:string,SubmitForCertification?:boolean,Lines?:PayApplicationLine[],PullFromWip?:boolean,AppendApprovedChangeOrders?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ProjectID;
/** @type {number} */
PeriodNumber;
/** @type {?string} */
PeriodStart;
/** @type {?string} */
PeriodEnd;
/** @type {?number} */
RetainagePct;
/** @type {string} */
BillingTemplate;
/** @type {boolean} */
SubmitForCertification;
/** @type {PayApplicationLine[]} */
Lines = [];
/** @type {boolean} */
PullFromWip;
/** @type {boolean} */
AppendApprovedChangeOrders;
}
JavaScript PayApplicationUpdateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<PayApplicationUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AppendApprovedChangeOrders>false</AppendApprovedChangeOrders>
<BillingTemplate>String</BillingTemplate>
<Lines>
<PayApplicationLine>
<ChangeOrderID>0</ChangeOrderID>
<CostCode>String</CostCode>
<Description>String</Description>
<FromPreviousPct>0</FromPreviousPct>
<IsChangeOrder>false</IsChangeOrder>
<PayApplicationID>0</PayApplicationID>
<PayApplicationLineID>0</PayApplicationLineID>
<ScheduledValue>0</ScheduledValue>
<SortOrder>0</SortOrder>
<StoredMaterials>0</StoredMaterials>
<ThisPeriodPct>0</ThisPeriodPct>
</PayApplicationLine>
</Lines>
<PeriodEnd>0001-01-01T00:00:00</PeriodEnd>
<PeriodNumber>0</PeriodNumber>
<PeriodStart>0001-01-01T00:00:00</PeriodStart>
<ProjectID>0</ProjectID>
<PullFromWip>false</PullFromWip>
<RetainagePct>0</RetainagePct>
<SubmitForCertification>false</SubmitForCertification>
</PayApplicationUpdateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PayApplicationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Application>
<BalanceToFinish>0</BalanceToFinish>
<BillingTemplate>String</BillingTemplate>
<CertifiedAt>0001-01-01T00:00:00</CertifiedAt>
<CertifiedBy>String</CertifiedBy>
<CompletedStoredToDate>0</CompletedStoredToDate>
<ContractSumToDate>0</ContractSumToDate>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<CurrentPaymentDue>0</CurrentPaymentDue>
<EarnedLessRetainage>0</EarnedLessRetainage>
<InvoiceID>0</InvoiceID>
<LessPreviousCertificates>0</LessPreviousCertificates>
<Lines>
<PayApplicationLine>
<ChangeOrderID>0</ChangeOrderID>
<CostCode>String</CostCode>
<Description>String</Description>
<FromPreviousPct>0</FromPreviousPct>
<IsChangeOrder>false</IsChangeOrder>
<PayApplicationID>0</PayApplicationID>
<PayApplicationLineID>0</PayApplicationLineID>
<ScheduledValue>0</ScheduledValue>
<SortOrder>0</SortOrder>
<StoredMaterials>0</StoredMaterials>
<ThisPeriodPct>0</ThisPeriodPct>
</PayApplicationLine>
</Lines>
<NetChangeByCO>0</NetChangeByCO>
<OriginalContractSum>0</OriginalContractSum>
<PayApplicationID>0</PayApplicationID>
<PayApplicationUID>00000000-0000-0000-0000-000000000000</PayApplicationUID>
<PeriodEnd>0001-01-01T00:00:00</PeriodEnd>
<PeriodNumber>0</PeriodNumber>
<PeriodStart>0001-01-01T00:00:00</PeriodStart>
<ProjectID>0</ProjectID>
<RetainageAmount>0</RetainageAmount>
<RetainagePct>0</RetainagePct>
<Status>String</Status>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
</Application>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</PayApplicationResponse>