Trendsic Platform Service

<back to all web services

CertifiedPayrollUpdateRequest

Requires Authentication
The following routes are available for this service:
PATCH,PUT,OPTIONS/v1/projects/{ProjectID}/certified-payroll/{Week}

export class CertifiedPayrollLine
{
    public CertifiedPayrollLineID: number;
    public CertifiedPayrollID: number;
    public WorkerName: string;
    public ContactID?: number;
    public Classification: string;
    public HoursST: number;
    public HoursOT: number;
    public BaseRate: number;
    public FringeRate: number;
    public FringeCashRate: number;
    public FringePlanRate: number;
    public GrossPay: number;
    public Flagged: boolean;
    public RestitutionAmount: number;
    public RestitutionNote: string;
    public RequiredBase: number;
    public RequiredFringe: number;
    public SortOrder: number;

    public constructor(init?: Partial<CertifiedPayrollLine>) { (Object as any).assign(this, init); }
}

export class CertifiedPayroll
{
    public CertifiedPayrollID: number;
    public CertifiedPayrollUID: string;
    public ProjectID: number;
    public PayrollNumber: number;
    public WeekEnding?: string;
    public Status: string;
    public DbeParticipationPct: number;
    public DbeGoalPct: number;
    public OjtApprenticeHours: number;
    public OjtApprenticeGoalHours: number;
    public WorkerCount: number;
    public TotalHoursST: number;
    public TotalHoursOT: number;
    public TotalGrossPay: number;
    public FlaggedCount: number;
    public SubmittedBy: string;
    public SubmittedAt?: string;
    public CreatedBy: string;
    public CreatedAt?: string;
    public UpdatedAt?: string;
    public Lines: CertifiedPayrollLine[] = [];
    public DeterminationNo: string;
    public DeterminationType: string;

    public constructor(init?: Partial<CertifiedPayroll>) { (Object as any).assign(this, init); }
}

export class CertifiedPayrollResponse
{
    public ResponseStatus: ResponseStatus;
    public Payroll: CertifiedPayroll;

    public constructor(init?: Partial<CertifiedPayrollResponse>) { (Object as any).assign(this, init); }
}

export class CertifiedPayrollUpdateRequest
{
    public ProjectID: number;
    public Week: string;
    public DbeParticipationPct?: number;
    public DbeGoalPct?: number;
    public OjtApprenticeHours?: number;
    public OjtApprenticeGoalHours?: number;
    public Lines: CertifiedPayrollLine[] = [];
    public SeedFromTime: boolean;

    public constructor(init?: Partial<CertifiedPayrollUpdateRequest>) { (Object as any).assign(this, init); }
}

TypeScript CertifiedPayrollUpdateRequest 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.

PUT /v1/projects/{ProjectID}/certified-payroll/{Week} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CertifiedPayrollUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DbeGoalPct>0</DbeGoalPct>
  <DbeParticipationPct>0</DbeParticipationPct>
  <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>
  <ProjectID>0</ProjectID>
  <SeedFromTime>false</SeedFromTime>
  <Week>String</Week>
</CertifiedPayrollUpdateRequest>
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>