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
import Foundation
import ServiceStack

public class PayApplicationListRequest : Codable
{
    public var projectID:Int

    required public init(){}
}

public class PayApplicationListResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var projectID:Int
    public var applications:[PayApplication] = []

    required public init(){}
}

public class PayApplication : Codable
{
    public var payApplicationID:Int
    public var payApplicationUID:String
    public var projectID:Int
    public var periodNumber:Int
    public var periodStart:Date?
    public var periodEnd:Date?
    public var status:String
    public var billingTemplate:String
    public var retainagePct:Double
    public var originalContractSum:Double
    public var netChangeByCO:Double
    public var contractSumToDate:Double
    public var completedStoredToDate:Double
    public var retainageAmount:Double
    public var earnedLessRetainage:Double
    public var lessPreviousCertificates:Double
    public var currentPaymentDue:Double
    public var balanceToFinish:Double
    public var invoiceID:Int?
    public var certifiedAt:Date?
    public var certifiedBy:String
    public var createdBy:String
    public var createdAt:Date?
    public var updatedAt:Date?
    public var lines:[PayApplicationLine] = []

    required public init(){}
}

public class PayApplicationLine : Codable
{
    public var payApplicationLineID:Int
    public var payApplicationID:Int
    public var costCode:String
    public var Description:String
    public var scheduledValue:Double
    public var fromPreviousPct:Double
    public var thisPeriodPct:Double
    public var storedMaterials:Double
    public var isChangeOrder:Bool
    public var changeOrderID:Int?
    public var sortOrder:Int

    required public init(){}
}


Swift PayApplicationListRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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 HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PayApplicationListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Applications>
    <PayApplication>
      <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>
    </PayApplication>
  </Applications>
  <ProjectID>0</ProjectID>
  <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>
</PayApplicationListResponse>