Skip to content
APS API

APS API (1.0)

Download OpenAPI specification:Download

About

Used primarily for service heartbeat checking

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "extra": "string",
  • "commit": "string",
  • "ipAddress": "string"
}

Attendance

Returns a paged list of employee additional earnings

Authorizations:
Bearer
path Parameters
companyCode
required
string

Company Code used to identify the company to return employee additional earnings records for

query Parameters
start
required
string <date>

The start date of the range for employee additional earnings records that are returned

end
required
string <date>

The end date of the range for employee additional earnings that are returned

Page
integer <int32>
Default: 1

The page number

PageSize
integer <int32> [ 1 .. 1000 ]
Default: 100

The page size

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "currentPage": 0,
  • "nextPage": 0,
  • "pageSize": 0,
  • "recordCount": 0,
  • "links": [
    ]
}

Returns a paged list of shifts

Authorizations:
Bearer
path Parameters
companyCode
required
string

Unique identifier assigned to the company

query Parameters
start
required
string <date>

Start date of the shift records that are returned

end
required
string <date>

End date of the shift records that are returned

Page
integer <int32>
Default: 1

The page number

PageSize
integer <int32> [ 1 .. 1000 ]
Default: 100

The page size

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "currentPage": 0,
  • "nextPage": 0,
  • "pageSize": 0,
  • "recordCount": 0,
  • "links": [
    ]
}

Returns a list of breaks for a shift

Authorizations:
Bearer
path Parameters
companyCode
required
string

Unique identifier assigned to the company

shiftId
required
integer <int32> >= 0

Unique identifier for the shift

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Company

Returns a paged list of companies

Authorizations:
Bearer
query Parameters
Page
integer <int32>
Default: 1

The page number

PageSize
integer <int32> [ 1 .. 1000 ]
Default: 100

The page size

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "currentPage": 0,
  • "nextPage": 0,
  • "pageSize": 0,
  • "recordCount": 0,
  • "links": [
    ]
}

Returns the company information

Authorizations:
Bearer
path Parameters
companyCode
required
string

Unique identifier assigned to the company

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "displayName": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "state": "string",
  • "zipCode": "string"
}

Returns a paged list of payroll batches for a company

Authorizations:
Bearer
path Parameters
companyCode
required
string

Unique identifier assigned to the company

query Parameters
Page
integer <int32>
Default: 1

The page number

PageSize
integer <int32> [ 1 .. 1000 ]
Default: 100

The page size

sort
string
Default: "Desc"
Enum: "Asc" "Desc"

Sort the list by batch check date

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "currentPage": 0,
  • "nextPage": 0,
  • "pageSize": 0,
  • "recordCount": 0,
  • "links": [
    ]
}

Get list of custom fields for a company

Authorizations:
Bearer
path Parameters
companyCode
required
string

Unique identifier assigned to the company

query Parameters
Page
integer <int32>
Default: 1

The page number

PageSize
integer <int32> [ 1 .. 1000 ]
Default: 100

The page size

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "currentPage": 0,
  • "nextPage": 0,
  • "pageSize": 0,
  • "recordCount": 0,
  • "links": [
    ]
}

Returns a paged list of departments for a company

Authorizations:
Bearer
path Parameters
companyCode
required
string

Unique identifier assigned to the company

query Parameters
Page
integer <int32>
Default: 1

The page number

PageSize
integer <int32> [ 1 .. 1000 ]
Default: 100

The page size

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "currentPage": 0,
  • "nextPage": 0,
  • "pageSize": 0,
  • "recordCount": 0,
  • "links": [
    ]
}

Returns a paged list of employees for a company

Authorizations:
Bearer
path Parameters
companyCode
required
string

Unique identifier assigned to the company

query Parameters
Page
integer <int32>
Default: 1

The page number

PageSize
integer <int32> [ 1 .. 1000 ]
Default: 100

The page size

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "currentPage": 0,
  • "nextPage": 0,
  • "pageSize": 0,
  • "recordCount": 0,
  • "links": [
    ]
}

Department

Returns department information

Authorizations:
Bearer
path Parameters
departmentId
required
integer <int32>

Department Id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "number": "string"
}

Employee

Returns employee information

Authorizations:
Bearer
path Parameters
employeeId
required
integer <int32>

Employee Id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "companyId": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "middleName": "string",
  • "suffix": "string",
  • "employmentStatus": "string",
  • "employeeNumber": "string",
  • "workEmail": "string",
  • "personalEmail": "string",
  • "workPhone": 0,
  • "workPhoneExt": "string",
  • "hireDate": "2019-08-24T14:15:22Z",
  • "terminationDate": "2019-08-24T14:15:22Z",
  • "rehireDate": "2019-08-24T14:15:22Z",
  • "baseDepartmentId": 0,
  • "baseLocation": "string",
  • "employmentType": "string",
  • "employeeType": "string",
  • "workersCompensationCode": "string",
  • "title": "string",
  • "withholdingState": "string",
  • "unemploymentState": "string",
  • "socCode": "string",
  • "wageType": "string",
  • "customFields": {
    }
}

Returns list of employee's scheduled earnings

Authorizations:
Bearer
path Parameters
employeeId
required
integer <int32>

Employee Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns list of employee's pay rates

Authorizations:
Bearer
path Parameters
employeeId
required
integer <int32>

Employee Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pay

Get all pay information for a company for a given date

Authorizations:
Bearer
path Parameters
companyCode
required
string

Company Code to load pay information

query Parameters
date
string

Pay date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get pay information for a single employee for a given date

Authorizations:
Bearer
path Parameters
employeeId
required
integer <int32>

Single employee to load pay information

query Parameters
date
string

Pay date

Responses

Response samples

Content type
application/json
[
  • {
    }
]