Trendsic Platform Service

<back to all web services

CertifiedPayrollSubmitRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/projects/{ProjectID}/certified-payroll/{Week}/submit
CertifiedPayrollSubmitRequest 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 .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.

POST /v1/projects/{ProjectID}/certified-payroll/{Week}/submit HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProjectID: 0,
	Week: String
}
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
	}
}