| GET,OPTIONS | /v1/projects/{ProjectID}/pay-apps/{PeriodNumber} |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class PayApplicationLine implements JsonSerializable
{
public function __construct(
/** @var int */
public int $PayApplicationLineID=0,
/** @var int */
public int $PayApplicationID=0,
/** @var string|null */
public ?string $CostCode=null,
/** @var string|null */
public ?string $Description=null,
/** @var float */
public float $ScheduledValue=0.0,
/** @var float */
public float $FromPreviousPct=0.0,
/** @var float */
public float $ThisPeriodPct=0.0,
/** @var float */
public float $StoredMaterials=0.0,
/** @var bool|null */
public ?bool $IsChangeOrder=null,
/** @var int|null */
public ?int $ChangeOrderID=null,
/** @var int */
public int $SortOrder=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['PayApplicationLineID'])) $this->PayApplicationLineID = $o['PayApplicationLineID'];
if (isset($o['PayApplicationID'])) $this->PayApplicationID = $o['PayApplicationID'];
if (isset($o['CostCode'])) $this->CostCode = $o['CostCode'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['ScheduledValue'])) $this->ScheduledValue = $o['ScheduledValue'];
if (isset($o['FromPreviousPct'])) $this->FromPreviousPct = $o['FromPreviousPct'];
if (isset($o['ThisPeriodPct'])) $this->ThisPeriodPct = $o['ThisPeriodPct'];
if (isset($o['StoredMaterials'])) $this->StoredMaterials = $o['StoredMaterials'];
if (isset($o['IsChangeOrder'])) $this->IsChangeOrder = $o['IsChangeOrder'];
if (isset($o['ChangeOrderID'])) $this->ChangeOrderID = $o['ChangeOrderID'];
if (isset($o['SortOrder'])) $this->SortOrder = $o['SortOrder'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->PayApplicationLineID)) $o['PayApplicationLineID'] = $this->PayApplicationLineID;
if (isset($this->PayApplicationID)) $o['PayApplicationID'] = $this->PayApplicationID;
if (isset($this->CostCode)) $o['CostCode'] = $this->CostCode;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->ScheduledValue)) $o['ScheduledValue'] = $this->ScheduledValue;
if (isset($this->FromPreviousPct)) $o['FromPreviousPct'] = $this->FromPreviousPct;
if (isset($this->ThisPeriodPct)) $o['ThisPeriodPct'] = $this->ThisPeriodPct;
if (isset($this->StoredMaterials)) $o['StoredMaterials'] = $this->StoredMaterials;
if (isset($this->IsChangeOrder)) $o['IsChangeOrder'] = $this->IsChangeOrder;
if (isset($this->ChangeOrderID)) $o['ChangeOrderID'] = $this->ChangeOrderID;
if (isset($this->SortOrder)) $o['SortOrder'] = $this->SortOrder;
return empty($o) ? new class(){} : $o;
}
}
class PayApplication implements JsonSerializable
{
public function __construct(
/** @var int */
public int $PayApplicationID=0,
/** @var string */
public string $PayApplicationUID='',
/** @var int */
public int $ProjectID=0,
/** @var int */
public int $PeriodNumber=0,
/** @var DateTime|null */
public ?DateTime $PeriodStart=null,
/** @var DateTime|null */
public ?DateTime $PeriodEnd=null,
/** @var string|null */
public ?string $Status=null,
/** @var string|null */
public ?string $BillingTemplate=null,
/** @var float */
public float $RetainagePct=0.0,
/** @var float */
public float $OriginalContractSum=0.0,
/** @var float */
public float $NetChangeByCO=0.0,
/** @var float */
public float $ContractSumToDate=0.0,
/** @var float */
public float $CompletedStoredToDate=0.0,
/** @var float */
public float $RetainageAmount=0.0,
/** @var float */
public float $EarnedLessRetainage=0.0,
/** @var float */
public float $LessPreviousCertificates=0.0,
/** @var float */
public float $CurrentPaymentDue=0.0,
/** @var float */
public float $BalanceToFinish=0.0,
/** @var int|null */
public ?int $InvoiceID=null,
/** @var DateTime|null */
public ?DateTime $CertifiedAt=null,
/** @var string|null */
public ?string $CertifiedBy=null,
/** @var string|null */
public ?string $CreatedBy=null,
/** @var DateTime|null */
public ?DateTime $CreatedAt=null,
/** @var DateTime|null */
public ?DateTime $UpdatedAt=null,
/** @var array<PayApplicationLine>|null */
public ?array $Lines=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['PayApplicationID'])) $this->PayApplicationID = $o['PayApplicationID'];
if (isset($o['PayApplicationUID'])) $this->PayApplicationUID = $o['PayApplicationUID'];
if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
if (isset($o['PeriodNumber'])) $this->PeriodNumber = $o['PeriodNumber'];
if (isset($o['PeriodStart'])) $this->PeriodStart = JsonConverters::from('DateTime', $o['PeriodStart']);
if (isset($o['PeriodEnd'])) $this->PeriodEnd = JsonConverters::from('DateTime', $o['PeriodEnd']);
if (isset($o['Status'])) $this->Status = $o['Status'];
if (isset($o['BillingTemplate'])) $this->BillingTemplate = $o['BillingTemplate'];
if (isset($o['RetainagePct'])) $this->RetainagePct = $o['RetainagePct'];
if (isset($o['OriginalContractSum'])) $this->OriginalContractSum = $o['OriginalContractSum'];
if (isset($o['NetChangeByCO'])) $this->NetChangeByCO = $o['NetChangeByCO'];
if (isset($o['ContractSumToDate'])) $this->ContractSumToDate = $o['ContractSumToDate'];
if (isset($o['CompletedStoredToDate'])) $this->CompletedStoredToDate = $o['CompletedStoredToDate'];
if (isset($o['RetainageAmount'])) $this->RetainageAmount = $o['RetainageAmount'];
if (isset($o['EarnedLessRetainage'])) $this->EarnedLessRetainage = $o['EarnedLessRetainage'];
if (isset($o['LessPreviousCertificates'])) $this->LessPreviousCertificates = $o['LessPreviousCertificates'];
if (isset($o['CurrentPaymentDue'])) $this->CurrentPaymentDue = $o['CurrentPaymentDue'];
if (isset($o['BalanceToFinish'])) $this->BalanceToFinish = $o['BalanceToFinish'];
if (isset($o['InvoiceID'])) $this->InvoiceID = $o['InvoiceID'];
if (isset($o['CertifiedAt'])) $this->CertifiedAt = JsonConverters::from('DateTime', $o['CertifiedAt']);
if (isset($o['CertifiedBy'])) $this->CertifiedBy = $o['CertifiedBy'];
if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
if (isset($o['UpdatedAt'])) $this->UpdatedAt = JsonConverters::from('DateTime', $o['UpdatedAt']);
if (isset($o['Lines'])) $this->Lines = JsonConverters::fromArray('PayApplicationLine', $o['Lines']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->PayApplicationID)) $o['PayApplicationID'] = $this->PayApplicationID;
if (isset($this->PayApplicationUID)) $o['PayApplicationUID'] = $this->PayApplicationUID;
if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
if (isset($this->PeriodNumber)) $o['PeriodNumber'] = $this->PeriodNumber;
if (isset($this->PeriodStart)) $o['PeriodStart'] = JsonConverters::to('DateTime', $this->PeriodStart);
if (isset($this->PeriodEnd)) $o['PeriodEnd'] = JsonConverters::to('DateTime', $this->PeriodEnd);
if (isset($this->Status)) $o['Status'] = $this->Status;
if (isset($this->BillingTemplate)) $o['BillingTemplate'] = $this->BillingTemplate;
if (isset($this->RetainagePct)) $o['RetainagePct'] = $this->RetainagePct;
if (isset($this->OriginalContractSum)) $o['OriginalContractSum'] = $this->OriginalContractSum;
if (isset($this->NetChangeByCO)) $o['NetChangeByCO'] = $this->NetChangeByCO;
if (isset($this->ContractSumToDate)) $o['ContractSumToDate'] = $this->ContractSumToDate;
if (isset($this->CompletedStoredToDate)) $o['CompletedStoredToDate'] = $this->CompletedStoredToDate;
if (isset($this->RetainageAmount)) $o['RetainageAmount'] = $this->RetainageAmount;
if (isset($this->EarnedLessRetainage)) $o['EarnedLessRetainage'] = $this->EarnedLessRetainage;
if (isset($this->LessPreviousCertificates)) $o['LessPreviousCertificates'] = $this->LessPreviousCertificates;
if (isset($this->CurrentPaymentDue)) $o['CurrentPaymentDue'] = $this->CurrentPaymentDue;
if (isset($this->BalanceToFinish)) $o['BalanceToFinish'] = $this->BalanceToFinish;
if (isset($this->InvoiceID)) $o['InvoiceID'] = $this->InvoiceID;
if (isset($this->CertifiedAt)) $o['CertifiedAt'] = JsonConverters::to('DateTime', $this->CertifiedAt);
if (isset($this->CertifiedBy)) $o['CertifiedBy'] = $this->CertifiedBy;
if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
if (isset($this->UpdatedAt)) $o['UpdatedAt'] = JsonConverters::to('DateTime', $this->UpdatedAt);
if (isset($this->Lines)) $o['Lines'] = JsonConverters::toArray('PayApplicationLine', $this->Lines);
return empty($o) ? new class(){} : $o;
}
}
class PayApplicationResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var PayApplication|null */
public ?PayApplication $Application=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['Application'])) $this->Application = JsonConverters::from('PayApplication', $o['Application']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->Application)) $o['Application'] = JsonConverters::to('PayApplication', $this->Application);
return empty($o) ? new class(){} : $o;
}
}
class PayApplicationDetailRequest implements JsonSerializable
{
public function __construct(
/** @var int */
public int $ProjectID=0,
/** @var int */
public int $PeriodNumber=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
if (isset($o['PeriodNumber'])) $this->PeriodNumber = $o['PeriodNumber'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
if (isset($this->PeriodNumber)) $o['PeriodNumber'] = $this->PeriodNumber;
return empty($o) ? new class(){} : $o;
}
}
PHP PayApplicationDetailRequest 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.
GET /v1/projects/{ProjectID}/pay-apps/{PeriodNumber} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
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>