Trendsic Platform Service

<back to all web services

CertifiedPayrollListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/certified-payroll
"use strict";
export class CertifiedPayrollLine {
    /** @param {{CertifiedPayrollLineID?:number,CertifiedPayrollID?:number,WorkerName?:string,ContactID?:number,Classification?:string,HoursST?:number,HoursOT?:number,BaseRate?:number,FringeRate?:number,FringeCashRate?:number,FringePlanRate?:number,GrossPay?:number,Flagged?:boolean,RestitutionAmount?:number,RestitutionNote?:string,RequiredBase?:number,RequiredFringe?:number,SortOrder?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CertifiedPayrollLineID;
    /** @type {number} */
    CertifiedPayrollID;
    /** @type {string} */
    WorkerName;
    /** @type {?number} */
    ContactID;
    /** @type {string} */
    Classification;
    /** @type {number} */
    HoursST;
    /** @type {number} */
    HoursOT;
    /** @type {number} */
    BaseRate;
    /** @type {number} */
    FringeRate;
    /** @type {number} */
    FringeCashRate;
    /** @type {number} */
    FringePlanRate;
    /** @type {number} */
    GrossPay;
    /** @type {boolean} */
    Flagged;
    /** @type {number} */
    RestitutionAmount;
    /** @type {string} */
    RestitutionNote;
    /** @type {number} */
    RequiredBase;
    /** @type {number} */
    RequiredFringe;
    /** @type {number} */
    SortOrder;
}
export class CertifiedPayroll {
    /** @param {{CertifiedPayrollID?:number,CertifiedPayrollUID?:string,ProjectID?:number,PayrollNumber?:number,WeekEnding?:string,Status?:string,DbeParticipationPct?:number,DbeGoalPct?:number,OjtApprenticeHours?:number,OjtApprenticeGoalHours?:number,WorkerCount?:number,TotalHoursST?:number,TotalHoursOT?:number,TotalGrossPay?:number,FlaggedCount?:number,SubmittedBy?:string,SubmittedAt?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string,Lines?:CertifiedPayrollLine[],DeterminationNo?:string,DeterminationType?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CertifiedPayrollID;
    /** @type {string} */
    CertifiedPayrollUID;
    /** @type {number} */
    ProjectID;
    /** @type {number} */
    PayrollNumber;
    /** @type {?string} */
    WeekEnding;
    /** @type {string} */
    Status;
    /** @type {number} */
    DbeParticipationPct;
    /** @type {number} */
    DbeGoalPct;
    /** @type {number} */
    OjtApprenticeHours;
    /** @type {number} */
    OjtApprenticeGoalHours;
    /** @type {number} */
    WorkerCount;
    /** @type {number} */
    TotalHoursST;
    /** @type {number} */
    TotalHoursOT;
    /** @type {number} */
    TotalGrossPay;
    /** @type {number} */
    FlaggedCount;
    /** @type {string} */
    SubmittedBy;
    /** @type {?string} */
    SubmittedAt;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
    /** @type {CertifiedPayrollLine[]} */
    Lines = [];
    /** @type {string} */
    DeterminationNo;
    /** @type {string} */
    DeterminationType;
}
export class CertifiedPayrollListResponse {
    /** @param {{ResponseStatus?:ResponseStatus,ProjectID?:number,Payrolls?:CertifiedPayroll[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {number} */
    ProjectID;
    /** @type {CertifiedPayroll[]} */
    Payrolls = [];
}
export class CertifiedPayrollListRequest {
    /** @param {{ProjectID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
}

JavaScript CertifiedPayrollListRequest 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}/certified-payroll HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CertifiedPayrollListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Payrolls>
    <CertifiedPayroll>
      <CertifiedPayrollID>0</CertifiedPayrollID>
      <CertifiedPayrollUID>00000000-0000-0000-0000-000000000000</CertifiedPayrollUID>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <DbeGoalPct>0</DbeGoalPct>
      <DbeParticipationPct>0</DbeParticipationPct>
      <DeterminationNo>String</DeterminationNo>
      <DeterminationType>String</DeterminationType>
      <FlaggedCount>0</FlaggedCount>
      <Lines>
        <CertifiedPayrollLine>
          <BaseRate>0</BaseRate>
          <CertifiedPayrollID>0</CertifiedPayrollID>
          <CertifiedPayrollLineID>0</CertifiedPayrollLineID>
          <Classification>String</Classification>
          <ContactID>0</ContactID>
          <Flagged>false</Flagged>
          <FringeCashRate>0</FringeCashRate>
          <FringePlanRate>0</FringePlanRate>
          <FringeRate>0</FringeRate>
          <GrossPay>0</GrossPay>
          <HoursOT>0</HoursOT>
          <HoursST>0</HoursST>
          <RequiredBase>0</RequiredBase>
          <RequiredFringe>0</RequiredFringe>
          <RestitutionAmount>0</RestitutionAmount>
          <RestitutionNote>String</RestitutionNote>
          <SortOrder>0</SortOrder>
          <WorkerName>String</WorkerName>
        </CertifiedPayrollLine>
      </Lines>
      <OjtApprenticeGoalHours>0</OjtApprenticeGoalHours>
      <OjtApprenticeHours>0</OjtApprenticeHours>
      <PayrollNumber>0</PayrollNumber>
      <ProjectID>0</ProjectID>
      <Status>String</Status>
      <SubmittedAt>0001-01-01T00:00:00</SubmittedAt>
      <SubmittedBy>String</SubmittedBy>
      <TotalGrossPay>0</TotalGrossPay>
      <TotalHoursOT>0</TotalHoursOT>
      <TotalHoursST>0</TotalHoursST>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <WeekEnding>0001-01-01T00:00:00</WeekEnding>
      <WorkerCount>0</WorkerCount>
    </CertifiedPayroll>
  </Payrolls>
  <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>
</CertifiedPayrollListResponse>