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}
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 CertifiedPayrollLine() = 
        member val CertifiedPayrollLineID:Int32 = new Int32() with get,set
        member val CertifiedPayrollID:Int32 = new Int32() with get,set
        member val WorkerName:String = null with get,set
        member val ContactID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Classification:String = null with get,set
        member val HoursST:Decimal = new Decimal() with get,set
        member val HoursOT:Decimal = new Decimal() with get,set
        member val BaseRate:Decimal = new Decimal() with get,set
        member val FringeRate:Decimal = new Decimal() with get,set
        member val FringeCashRate:Decimal = new Decimal() with get,set
        member val FringePlanRate:Decimal = new Decimal() with get,set
        member val GrossPay:Decimal = new Decimal() with get,set
        member val Flagged:Boolean = new Boolean() with get,set
        member val RestitutionAmount:Decimal = new Decimal() with get,set
        member val RestitutionNote:String = null with get,set
        member val RequiredBase:Decimal = new Decimal() with get,set
        member val RequiredFringe:Decimal = new Decimal() with get,set
        member val SortOrder:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CertifiedPayroll() = 
        member val CertifiedPayrollID:Int32 = new Int32() with get,set
        member val CertifiedPayrollUID:Guid = new Guid() with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val PayrollNumber:Int32 = new Int32() with get,set
        member val WeekEnding:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Status:String = null with get,set
        member val DbeParticipationPct:Decimal = new Decimal() with get,set
        member val DbeGoalPct:Decimal = new Decimal() with get,set
        member val OjtApprenticeHours:Decimal = new Decimal() with get,set
        member val OjtApprenticeGoalHours:Decimal = new Decimal() with get,set
        member val WorkerCount:Int32 = new Int32() with get,set
        member val TotalHoursST:Decimal = new Decimal() with get,set
        member val TotalHoursOT:Decimal = new Decimal() with get,set
        member val TotalGrossPay:Decimal = new Decimal() with get,set
        member val FlaggedCount:Int32 = new Int32() with get,set
        member val SubmittedBy:String = null with get,set
        member val SubmittedAt:Nullable<DateTime> = new Nullable<DateTime>() 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<CertifiedPayrollLine> = new ResizeArray<CertifiedPayrollLine>() with get,set
        member val DeterminationNo:String = null with get,set
        member val DeterminationType:String = null with get,set

    [<AllowNullLiteral>]
    type CertifiedPayrollResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Payroll:CertifiedPayroll = null with get,set

    [<AllowNullLiteral>]
    type CertifiedPayrollRequest() = 
        member val ProjectID:Int32 = new Int32() with get,set
        member val Week:String = null with get,set

F# CertifiedPayrollRequest DTOs

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Payroll: 
	{
		CertifiedPayrollID: 0,
		CertifiedPayrollUID: 00000000000000000000000000000000,
		ProjectID: 0,
		PayrollNumber: 0,
		WeekEnding: 0001-01-01,
		Status: String,
		DbeParticipationPct: 0,
		DbeGoalPct: 0,
		OjtApprenticeHours: 0,
		OjtApprenticeGoalHours: 0,
		WorkerCount: 0,
		TotalHoursST: 0,
		TotalHoursOT: 0,
		TotalGrossPay: 0,
		FlaggedCount: 0,
		SubmittedBy: String,
		SubmittedAt: 0001-01-01,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		UpdatedAt: 0001-01-01,
		Lines: 
		[
			{
				CertifiedPayrollLineID: 0,
				CertifiedPayrollID: 0,
				WorkerName: String,
				ContactID: 0,
				Classification: String,
				HoursST: 0,
				HoursOT: 0,
				BaseRate: 0,
				FringeRate: 0,
				FringeCashRate: 0,
				FringePlanRate: 0,
				GrossPay: 0,
				Flagged: False,
				RestitutionAmount: 0,
				RestitutionNote: String,
				RequiredBase: 0,
				RequiredFringe: 0,
				SortOrder: 0
			}
		],
		DeterminationNo: String,
		DeterminationType: String
	}
}