| GET,OPTIONS | /v1/projects/{ProjectID}/certified-payroll/{Week} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProjectID | path | int | No | |
| Week | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Payroll | form | CertifiedPayroll | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CertifiedPayrollID | form | int | No | |
| CertifiedPayrollUID | form | Guid | No | |
| ProjectID | form | int | No | |
| PayrollNumber | form | int | No | |
| WeekEnding | form | DateTime? | No | |
| Status | form | string | No | |
| DbeParticipationPct | form | decimal | No | |
| DbeGoalPct | form | decimal | No | |
| OjtApprenticeHours | form | decimal | No | |
| OjtApprenticeGoalHours | form | decimal | No | |
| WorkerCount | form | int | No | |
| TotalHoursST | form | decimal | No | |
| TotalHoursOT | form | decimal | No | |
| TotalGrossPay | form | decimal | No | |
| FlaggedCount | form | int | No | |
| SubmittedBy | form | string | No | |
| SubmittedAt | form | DateTime? | No | |
| CreatedBy | form | string | No | |
| CreatedAt | form | DateTime? | No | |
| UpdatedAt | form | DateTime? | No | |
| Lines | form | List<CertifiedPayrollLine> | No | |
| DeterminationNo | form | string | No | |
| DeterminationType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CertifiedPayrollLineID | form | int | No | |
| CertifiedPayrollID | form | int | No | |
| WorkerName | form | string | No | |
| ContactID | form | int? | No | |
| Classification | form | string | No | |
| HoursST | form | decimal | No | |
| HoursOT | form | decimal | No | |
| BaseRate | form | decimal | No | |
| FringeRate | form | decimal | No | |
| FringeCashRate | form | decimal | No | |
| FringePlanRate | form | decimal | No | |
| GrossPay | form | decimal | No | |
| Flagged | form | bool | No | |
| RestitutionAmount | form | decimal | No | |
| RestitutionNote | form | string | No | |
| RequiredBase | form | decimal | No | |
| RequiredFringe | form | decimal | No | |
| SortOrder | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}