Reference lists

Fixed values that some fields accept. Read them instead of hard-coding them.

Both lists put the values in records at the top level, in display order, with no total and no paging. These calls read no account data, so they are also a good way to check a new key.

Back to the index · Conventions · Errors

GET /reporting-types

The values that a Job's reportingType accepts. A Job with no reporting type has null, which is not listed.

The values are Prevailing Wages, Certified Payroll, CCIP, OCIP, ROCIP, ACIP, PSI and HUD.

Scope: activity:read

No parameters.

Example request

curl "$TIMECARD_BASE_URL/reporting-types" \
  -H "X-API-Key: $TIMECARD_API_KEY"

Example response 200 OK

{
  "status": 200,
  "message": "Success: reporting types retrieved.",
  "records": [
    "Prevailing Wages",
    "Certified Payroll",
    "CCIP",
    "OCIP",
    "ROCIP",
    "ACIP",
    "PSI",
    "HUD"
  ]
}

Errors

GET /reporting-frequencies

The values that a Job's reportingFrequency accepts. A Job with no reporting frequency has null, which is not listed.

The values are Monthly, Weekly, Annual and Submission Not Required.

Scope: activity:read

No parameters.

Example request

curl "$TIMECARD_BASE_URL/reporting-frequencies" \
  -H "X-API-Key: $TIMECARD_API_KEY"

Example response 200 OK

{
  "status": 200,
  "message": "Success: reporting frequencies retrieved.",
  "records": ["Monthly", "Weekly", "Annual", "Submission Not Required"]
}

Errors