Rosnet API (1.0.0)

Download OpenAPI specification:Download

Obtain Credentials

Welcome to the Rosnet API. You'll need to obtain API credentials in order to connect. To do this, follow the instructions below:

  • Log in to your Rosnet client site.
  • Open the API Users page.
  • Click the Add User button and follow the on screen instructions.

Authentication

This API uses Basic authentication, a simple authentication scheme built into the HTTP protocol. The client sends HTTP requests with the Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.

See Get Checks for a working example that demonstrates basic authentication.

Paging

On the initial request only the first 100 results will be returned. If there are more results available the response will include a "cursor" header. To fetch the next set of results, send a followup request to the same endpoint and provide the "cursor" value returned from the previous response.

See Get Checks for a working example that demonstrates paging.

Rate Limits

We rate limit the number of API calls you can make to help prevent abuse and protect system stability. If a rate limit is exceeded you will receive a 429 - "Too Many Requests" response along with a Retry-After header containing the number of seconds to wait before making another call.

Outages

From time to time we'll need to take the system down for scheduled maintenance. During these outages you'll receive a 503 - "Service Unavailable" response along with a Retry-After header containing the number of seconds to wait before making another call.

Try It Out!

Visit our hosted Swagger UI or download the OpenAPI specification and import into Postman to make requests and explore the API.

General

List employees

query Parameters
id
integer <int32>

Optional employee id if retrieving a specific employee.

locationId
integer <int32>

Optional location id to filter by.

deleted
boolean

Optional deleted status to filter by.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array ()
Id
required
integer <int32>

Unique id assigned by Rosnet.

Name
string

Employee's name as entered in Rosnet.

LocationId
required
integer <int32>

The location where the employee was entered. See general/locations.

LocationEmployeeId
string

Id assigned by the location's pos system.

PayrollEmployeeId
string

Id assigned by the payroll system.

Deleted
required
boolean

Indicates an employee has been deleted from the pos.

Response samples

Content type
application/json
[
  • {
    }
]

List locations

query Parameters
id
integer <int32>

Optional location id if retrieving a specific location.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array ()
Id
required
integer <int32>

A unique id. Also known as "Location Number" or simply "Location" on Rosnet reports.

Name
string

A recognizable name. Usually a city or street name.

OpenDate
required
string <date-time>

The business date the location opened. yyyy-MM-dd

ClosedDate
string <date-time>

The business date the location closed. yyyy-MM-dd Null for open locations.

TimeZoneName
string

The name of the time zone in the IANA database. See list of time zones

Response samples

Content type
application/json
[
  • {
    }
]

Shifts

List shifts

Returns the list of shifts for a given location and business date.

query Parameters
locationId
required
integer <int32>

The location where the shifts occurred. See general/locations.

businessDate
required
string <date-time>

The business date when the shifts occurred. yyyy-MM-dd.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array ()
LocationId
required
integer <int32>

The location where the shift occurred. See general/locations.

BusinessDate
required
string <date-time>

The business date when the shift occurred. yyyy-MM-dd.

EmployeeId
required
integer <int32>

The employee who worked the shift. See general/employees.

Begin
required
string <date-time>

The time the shift began in the location's local time.

End
string <date-time>

The time the shift ended in the location's local time. May be null if employee hasn't clocked out.

JobId
required
integer <int32>

The job the employee worked during the shift. See labor/definitions/jobs.

BaseRate
required
number <decimal>

The employee's base pay rate for this shift.

PayRate
required
number <decimal>

The actual rate the employee was payed for this shift.

PayTypeId
required
integer <int32>

Identifies the type of pay. See labor/definitions/payTypes.

Response samples

Content type
application/json
[
  • {
    }
]

List shifts by pay period

Returns all shifts for a pay period and location.

query Parameters
locationId
required
integer <int32>

The location where the shifts occurred. See general/locations.

businessDate
required
string <date-time>

Any business date in the pay period. yyyy-MM-dd.

cursor
string

The pagination cursor returned in the previous response header. Leave unset for the initial request. See Paging for more info.

limit
integer <int32>
Default: 100

The maximum number of items to return.

Responses

Response Schema: application/json
Array ()
LocationId
required
integer <int32>

The location where the shift occurred. See general/locations.

BusinessDate
required
string <date-time>

The business date when the shift occurred. yyyy-MM-dd.

EmployeeId
required
integer <int32>

The employee who worked the shift. See general/employees.

Begin
required
string <date-time>

The time the shift began in the location's local time.

End
string <date-time>

The time the shift ended in the location's local time. May be null if employee hasn't clocked out.

JobId
required
integer <int32>

The job the employee worked during the shift. See labor/definitions/jobs.

BaseRate
required
number <decimal>

The employee's base pay rate for this shift.

PayRate
required
number <decimal>

The actual rate the employee was payed for this shift.

PayTypeId
required
integer <int32>

Identifies the type of pay. See labor/definitions/payTypes.

Response samples

Content type
application/json
[
  • {