Trendsic Platform Service

<back to all web services

CertifiedPayrollRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/certified-payroll/{Week}
CertifiedPayrollRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectIDpathintNo
WeekpathstringNo
CertifiedPayrollResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PayrollformCertifiedPayrollNo
CertifiedPayroll Parameters:
NameParameterData TypeRequiredDescription
CertifiedPayrollIDformintNo
CertifiedPayrollUIDformGuidNo
ProjectIDformintNo
PayrollNumberformintNo
WeekEndingformDateTime?No
StatusformstringNo
DbeParticipationPctformdecimalNo
DbeGoalPctformdecimalNo
OjtApprenticeHoursformdecimalNo
OjtApprenticeGoalHoursformdecimalNo
WorkerCountformintNo
TotalHoursSTformdecimalNo
TotalHoursOTformdecimalNo
TotalGrossPayformdecimalNo
FlaggedCountformintNo
SubmittedByformstringNo
SubmittedAtformDateTime?No
CreatedByformstringNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No
LinesformList<CertifiedPayrollLine>No
DeterminationNoformstringNo
DeterminationTypeformstringNo
CertifiedPayrollLine Parameters:
NameParameterData TypeRequiredDescription
CertifiedPayrollLineIDformintNo
CertifiedPayrollIDformintNo
WorkerNameformstringNo
ContactIDformint?No
ClassificationformstringNo
HoursSTformdecimalNo
HoursOTformdecimalNo
BaseRateformdecimalNo
FringeRateformdecimalNo
FringeCashRateformdecimalNo
FringePlanRateformdecimalNo
GrossPayformdecimalNo
FlaggedformboolNo
RestitutionAmountformdecimalNo
RestitutionNoteformstringNo
RequiredBaseformdecimalNo
RequiredFringeformdecimalNo
SortOrderformintNo

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

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