Trendsic Platform Service

<back to all web services

PayApplicationDetailRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/pay-apps/{PeriodNumber}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PayApplicationLine() = 
        member val PayApplicationLineID:Int32 = new Int32() with get,set
        member val PayApplicationID:Int32 = new Int32() with get,set
        member val CostCode:String = null with get,set
        member val Description:String = null with get,set
        member val ScheduledValue:Decimal = new Decimal() with get,set
        member val FromPreviousPct:Decimal = new Decimal() with get,set
        member val ThisPeriodPct:Decimal = new Decimal() with get,set
        member val StoredMaterials:Decimal = new Decimal() with get,set
        member val IsChangeOrder:Boolean = new Boolean() with get,set
        member val ChangeOrderID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SortOrder:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PayApplication() = 
        member val PayApplicationID:Int32 = new Int32() with get,set
        member val PayApplicationUID:Guid = new Guid() with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val PeriodNumber:Int32 = new Int32() with get,set
        member val PeriodStart:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PeriodEnd:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Status:String = null with get,set
        member val BillingTemplate:String = null with get,set
        member val RetainagePct:Decimal = new Decimal() with get,set
        member val OriginalContractSum:Decimal = new Decimal() with get,set
        member val NetChangeByCO:Decimal = new Decimal() with get,set
        member val ContractSumToDate:Decimal = new Decimal() with get,set
        member val CompletedStoredToDate:Decimal = new Decimal() with get,set
        member val RetainageAmount:Decimal = new Decimal() with get,set
        member val EarnedLessRetainage:Decimal = new Decimal() with get,set
        member val LessPreviousCertificates:Decimal = new Decimal() with get,set
        member val CurrentPaymentDue:Decimal = new Decimal() with get,set
        member val BalanceToFinish:Decimal = new Decimal() with get,set
        member val InvoiceID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CertifiedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CertifiedBy:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Lines:ResizeArray<PayApplicationLine> = new ResizeArray<PayApplicationLine>() with get,set

    [<AllowNullLiteral>]
    type PayApplicationResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Application:PayApplication = null with get,set

    [<AllowNullLiteral>]
    type PayApplicationDetailRequest() = 
        member val ProjectID:Int32 = new Int32() with get,set
        member val PeriodNumber:Int32 = new Int32() with get,set

F# PayApplicationDetailRequest 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/{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>