Aladtec API Documentation

Base URL: https://secure#.aladtec.com/example/api/v3

New OpenAPI Version

We're excited to announce a brand new version of the Aladtec API which brings full support for the widely adopted OpenAPI industry standard. OpenAPI empowers developers to rapidly develop new integrations with a low-code approach.

Our new API version comes with other improvements:

Overview

The Aladtec API can be used to retrieve, create, or update information contained in an Aladtec system.

The API is implemented as a JSON web service that accepts authenticated HTTP requests then returns a response with an HTTP status code and a JSON payload. No separate installation is required to use the Aladtec API.

General

Date/Time Formats

Date/Time (RFC 3339 format)

YYYY-MM-DDTHH:MM:SS±HH:MM

Date

YYYY-MM-DD

Time

HH:MM


The following table describes each of the date/time format specifiers that we use in the API.

Format Description Example
"YYYY" year 2019
"MM" month 01
"DD" date 22
"T" separator character N/A
"HH" hours expressed in 24 hour notation 23
"MM" minutes 42
"SS" seconds 59
"±HH:MM" UTC offset (hours and minutes from UTC time) -06:00

System Timezone

Every Aladtec system is configured to one timezone.

The IANA, aka Olson, timezone (e.g. "America/Chicago") can be queried from the /configuration resource.

Responses

HTTP Status Codes

The Aladtec API will attempt to return an appropriate HTTP status code for every request.

Code Text Description
200 Ok Request was successful
201 Created Resource was created successfully
204 No Content Request was successful and no response content was returned
400 Bad Request Request was invalid, most likely due to missing or incorrect parameters
401 Unauthorized Authorization credentials were invalid or missing
403 Forbidden The API credentials used do not have access to the resource requested.
404 Not Found The URL path was not found.
405 Method Not Allowed An invalid HTTP method was specified for the resource. For example, a GET request was made to /oauth/token which only supports POST requests.
429 Too Many Requests The rate limit for the Aladtec system was reached, and the request cannot be completed.
500 Internal Server Error A problem has occurred on Aladtec servers. If the error continues, contact Aladtec Support for additional assistance.

Response Shapes

Each API response will contain a JSON object that matches one of two standard schemas.

Success Example

Returned for responses sent with a 200 level HTTP Status Code.

{
  "data": [ ... ],
  "meta": { ... }
}

Error Example

Returned for responses sent with a 400 or 500 level HTTP Status Code.

{
  "errors": [
    {
      "error": "Time Off is not enabled in this system.",
      "detail": ""
    }
  ]
}

OpenAPI Description

The Aladtec API supports the widely adopted OpenAPI standard and allows customers to rapidly develop integrations without having to fully understand the implementation of our API.

Our OpenAPI description will allow customers to:

Aladtec has implemented version 3 of the OpenAPI specification in YML format for all operations.

File URL

Directly link the OpenAPI YML into compatible software to automatically get all future updates to this API version.

https://developer.aladtec.com/downloads/json_api_v3_openapi_spec.yml

File Download

Download the OpenAPI YML to use with compatible SDK code generators and with software that requires the specification to be imported by file upload.

Download OpenAPI

API Rate Limits

An Aladtec subscription provides 50 requests per minute and 2500 requests per rolling 24 hour period. Once the rate limit has been reached, a status code of 429 (Too Many Requests), will be returned until the rate limit automatically resets.

If a higher rate limit is required, please contact Aladtec Support at 888.749.5550.

API Profiles

Aladtec can create multiple API profiles for your organization, each with access to different data. Not all data is available by default.

If you would like to configure API profiles, please contact Aladtec Support at 888.749.5550.

Authentication

Aladtec follows OAuth 2.0 standards for authentication. All API endpoints require authentication using a valid, non-expired access token. To get API tokens for an Aladtec system, you must have received a client ID and a client secret for that system by contacting Aladtec Support. The client secret must remain confidential as it allows unrestricted access to an Aladtec system's data. All access tokens will expire one hour after they are created.

Getting an Access Token

Aladtec has implemented Client Credentials authentication for obtaining access tokens. Tokens obtained using Client Credentials will give unrestricted access to a system's data.

/oauth

post

Generates new API access tokens given valid credentials.

post https://secure#.aladtec.com/example/api/v3/oauth/token

Description

Generates new API access tokens given valid credentials.

Request Body

{} application/json

grant_type string required Method for obtaining an access token, Possible values: [ client_credentials ]
client_id string required Client ID used to identify your software interacting with Aladtec
client_secret string required Confidential secret to authenticate your software

Example: 

{
  "grant_type": "client_credentials",
  "client_id": "sys-234F3SFSE",
  "client_secret": "ERIOBNSLWVNUIEW3843H3B3B3B3N2MN2"
}

HTTP status code 200

Successful response containing a new access token and the permissions granted to the token

Response Body

{} application/json

access_token string

The new API token

token_type string

The token type (Bearer)

expires_in integer

The number of seconds until the token expires

scope string

All permissions granted to the API token

Example: 

{
  "access_token": "GdreEkwMnZUcU1tcmQ3aHJ1cXM1LmZDR05neUc4WklTcE44SHlyNHNwe",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "view_members edit_members"
}

HTTP status code 400

Error response containing one or more errors returned as a result of invalid request data.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "An example error message 1.",
      "detail": "More details about the specific error 1."
    },
    {
      "error": "An example error message 2.",
      "detail": "More details about the specific error 2."
    }
  ]
}

HTTP status code 401

Error response containing one or more errors returned as a result of user unauthorized.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "An example error message 1.",
      "detail": "More details about the specific error 1."
    },
    {
      "error": "An example error message 2.",
      "detail": "More details about the specific error 2."
    }
  ]
}

HTTP status code 415

Error response when the request does not contain a valid content type

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "Invalid Content-Type",
      "detail": "The Content-Type header must be set to one of the following values: [application/json, application/x-www-form-urlencoded]"
    }
  ]
}
<?php

/* Set your system URL, client ID, and client secret here. */
$base_url = 'https://secure#.aladtec.com/example/api/v3';
$client_id = 'sys-rBa946I1Zj64';
$client_secret = 'lJ1y7nrfDHHgdEqYB77pixxNHtasXK5lsNDWmFancgu3MIh4hGETWv2kaMD1iEOd';

$url = $base_url . '/oauth/token';
$ch = curl_init( $url );

/* Set options */
curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'POST' );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Content-Type: application/json'
) );
curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( array(
	'grant_type' => 'client_credentials',
	'client_id' => $client_id,
	'client_secret' => $client_secret
) ) );

/* Invoke the API and get the response */
$response_body = curl_exec( $ch );

$error = curl_error( $ch );
if ( $error ) {
	echo 'Error: ' . $error;
}

print( $response_body );

curl_close( $ch );
/* Set your system URL, client ID, and client secret here. */
var base_url = 'https://secure#.aladtec.com/example/api/v3';
var client_id = 'sys-rBa946I1Zj64';
var client_secret = 'lJ1y7nrfDHHgdEqYB77pixxNHtasXK5lsNDWmFancgu3MIh4hGETWv2kaMD1iEOd';

var xhr = new XMLHttpRequest();

/* Set options */
var url = base_url + '/oauth/token';
xhr.open( 'POST', url );

xhr.setRequestHeader( 'Content-Type', 'application/json' );

/* Invoke the API and get response */
xhr.send( JSON.stringify( {
	grant_type: 'client_credentials',
	client_id: client_id,
	client_secret: client_secret,
} ) );

xhr.addEventListener( 'load', function () {
	console.log( xhr.responseText );
});

Resources

/members

get

Returns members and the members' associated Member Database attributes. Attributes must be...

post

Creates a new member in the Member Database.

post https://secure#.aladtec.com/example/api/v3/members

Description

Creates a new member in the Member Database.

Headers

Authorization string required API access token to authenticate the request. The token value must be prefaced with the word "Bearer" and a single space.

Request Body

{} application/json

is_active boolean optional Members are either active or inactive.
first_name string required Member given name
last_name string required Member family name
login string required Member login name
mobile_phone string optional Mobile phone number
primary_email string required Primary email address
secondary_emails array optional Email addresses not considered the primary_email
date_hired string optional Date the member was hired
employee_type_id integer optional ID of the employee type assigned to the member
work_group_id integer optional ID of the work group assigned to the member
schedule_ids array optional List of schedule IDs the member is qualified to work on
position_qualification_ids array optional List of position qualification IDs a member is qualified for
custom_attributes array optional Attributes in the Member Database, defined per Aladtec system.

attribute_id integer required

The ID of this attribute in Aladtec.

value string or array or number required

The value can be Text (string), Date (string), Number (int or float), Single Option (array of IDs), or Multi Option (array of IDs).

Example: 

{
  "is_active": true,
  "first_name": "John",
  "last_name": "Smith",
  "login": "johnsmith",
  "mobile_phone": "555-555-5555",
  "primary_email": "jsmith@company.com",
  "secondary_emails": [
    "jsmith@example.com",
    "jsmith2@example.com"
  ],
  "employee_type_id": 7,
  "work_group_id": 5,
  "date_hired": "2019-01-01",
  "schedule_ids": [
    1,
    2
  ],
  "position_qualification_ids": [
    1,
    2,
    3
  ],
  "custom_attributes": [
    {
      "attribute_id": 11,
      "value": ""
    },
    {
      "attribute_id": 10,
      "value": [
        2,
        3
      ]
    }
  ]
}

HTTP status code 201

Successful response with new member

Response Body

{} application/json

data object

member_id integer

ID assigned to a member by Aladtec

is_active boolean

Members are either active or inactive.

first_name string

Member given name

last_name string

Member family name

login string

Member login name

mobile_phone string

Mobile phone number

primary_email string

Primary email address

secondary_emails array

Email addresses not considered the primary_email

date_hired string

Date the member was hired

employee_type_id integer

ID of the employee type assigned to the member

work_group_id integer

ID of the work group assigned to the member

schedule_ids array

List of schedule IDs the member is qualified to work on

position_qualification_ids array

List of position qualification IDs a member is qualified for

custom_attributes array

Attributes in the Member Database, defined per Aladtec system.

attribute_id integer

The ID of this attribute in Aladtec.

value string or array or number

The value can be Text (string), Date (string), Number (int), Single Option (array of IDs), or Multi Option (array of IDs).

meta object

Additional properties describing the record set within data

generated_at_datetime string

RFC 3339 formatted datetime at which data was generated

Example: 

{
  "data": {
    "member_id": 3,
    "is_active": true,
    "first_name": "John",
    "last_name": "Smith",
    "login": "johnsmith",
    "mobile_phone": "555-555-5555",
    "primary_email": "jsmith@company.com",
    "secondary_emails": [
      "jsmith@example.com",
      "jsmith2@example.com"
    ],
    "employee_type_id": 7,
    "work_group_id": 5,
    "date_hired": "2019-01-01",
    "schedule_ids": [
      1,
      2
    ],
    "position_qualification_ids": [
      1,
      2,
      3
    ],
    "custom_attributes": [
      {
        "attribute_id": 11,
        "value": ""
      },
      {
        "attribute_id": 10,
        "value": [
          2,
          3
        ]
      }
    ]
  },
  "meta": {
    "generated_at_datetime": "2022-01-01T07:42:33-06:00"
  }
}

HTTP status code 400

Error response containing one or more errors returned as a result of invalid request data.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "An example error message 1.",
      "detail": "More details about the specific error 1."
    },
    {
      "error": "An example error message 2.",
      "detail": "More details about the specific error 2."
    }
  ]
}

HTTP status code 403

Error response returned when the API token does not have permission to perform this action.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "Your API token does not have permission to perform this action.",
      "detail": "If you believe this is in error, please talk to your system contact."
    }
  ]
}

HTTP status code 409

Error response when the route cannot be used due to a conflict with the system configuration. Please contact Aladtec Support (support@aladtec.com, 888.749.5550) for help if this error is received.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "An example error message 1.",
      "detail": "More details about the specific error 1."
    },
    {
      "error": "An example error message 2.",
      "detail": "More details about the specific error 2."
    }
  ]
}
<?php

/* Set your system URL and API token here. */
$base_url = 'https://secure#.aladtec.com/example/api/v3';
$api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

$url = $base_url . '/members?';

$ch = curl_init( $url );

/* Set curl options */
curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'POST' );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Authorization: Bearer ' . $api_token,
	'Content-Type: application/json'
));

$new_member = array(
	'first_name' => 'John',
	'last_name' => 'Doe',
	'login' => 'johndoe',
	'primary_email' => 'example@email.com'
);

curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $new_member ) );

/* Invoke the API and get the response */
$response_body = curl_exec( $ch );

$error = curl_error( $ch );
if ( $error ) {
	echo 'Error: ' . $error;
}

print( $response_body );

curl_close( $ch );

/* Set your system URL and API token here. */
var base_url = 'https://secure#.aladtec.com/example/api/v3';
var api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

var xhr = new XMLHttpRequest();

/* Set the options */
var url = base_url + '/members?';
xhr.open( 'POST', url );
xhr.setRequestHeader( 'Authorization', 'Bearer ' + api_token );
xhr.setRequestHeader( 'Content-Type', 'application/json' );

var new_member = {
	first_name: 'John',
	last_name: 'Doe',
	login: 'johndoe',
	primary_email: 'email@example.com'
};

/* Invoke the API and get the response */
xhr.send( JSON.stringify( new_member ) );

xhr.addEventListener( 'load', function () {
	console.log( xhr.responseText );
});
post

Creates multiple new members in the Member Database.

patch

Updates a subset of existing members given a list of IDs and new attribute values.

post https://secure#.aladtec.com/example/api/v3/members/batch

Description

Creates multiple new members in the Member Database.

Headers

Authorization string required API access token to authenticate the request. The token value must be prefaced with the word "Bearer" and a single space.

Request Body

{} application/json

is_active boolean optional Members are either active or inactive.
first_name string required Member given name
last_name string required Member family name
login string required Member login name
mobile_phone string optional Mobile phone number
primary_email string required Primary email address
secondary_emails array optional Email addresses not considered the primary_email
date_hired string optional Date the member was hired
employee_type_id integer optional ID of the employee type assigned to the member
work_group_id integer optional ID of the work group assigned to the member
schedule_ids array optional List of schedule IDs the member is qualified to work on
position_qualification_ids array optional List of position qualification IDs a member is qualified for
custom_attributes array optional Attributes in the Member Database, defined per Aladtec system.

attribute_id integer required

The ID of this attribute in Aladtec.

value string or array or number required

The value can be Text (string), Date (string), Number (int or float), Single Option (array of IDs), or Multi Option (array of IDs).

Example: 

[
  {
    "is_active": true,
    "first_name": "Bob",
    "last_name": "Smith",
    "login": "bsmith",
    "mobile_phone": "555-555-5555",
    "primary_email": "bsmith@company.com",
    "secondary_emails": [
      "bsmith@example.com",
      "bsmith2@example.com"
    ],
    "date_hired": "2019-01-01",
    "employee_type_id": 7,
    "work_group_id": 5,
    "schedule_ids": [
      1,
      2
    ],
    "position_qualification_ids": [
      1,
      2,
      3
    ],
    "custom_attributes": [
      {
        "attribute_id": 11,
        "value": ""
      },
      {
        "attribute_id": 10,
        "value": [
          2,
          3
        ]
      }
    ]
  },
  {
    "first_name": "John",
    "last_name": "Doe",
    "login": "jdoe",
    "primary_email": "jdoe@company.com"
  }
]

HTTP status code 201

Successful response with new members.

Response Body

{} application/json

data array

member_id integer

ID assigned to a member by Aladtec

is_active boolean

Members are either active or inactive.

first_name string

Member given name

last_name string

Member family name

login string

Member login name

mobile_phone string

Mobile phone number

primary_email string

Primary email address

secondary_emails array

Email addresses not considered the primary_email

date_hired string

Date the member was hired

employee_type_id integer

ID of the employee type assigned to the member

work_group_id integer

ID of the work group assigned to the member

schedule_ids array

List of schedule IDs the member is qualified to work on

position_qualification_ids array

List of position qualification IDs a member is qualified for

custom_attributes array

Attributes in the Member Database, defined per Aladtec system.

attribute_id integer

The ID of this attribute in Aladtec.

value string or array or number

The value can be Text (string), Date (string), Number (int), Single Option (array of IDs), or Multi Option (array of IDs).

meta object

Additional properties describing the record set within data.

generated_at_datetime string

RFC 3339 formatted datetime at which data was generated.

Example: 

{
  "data": [
    {
      "member_id": 1,
      "is_active": true,
      "first_name": "Bob",
      "last_name": "Smith",
      "login": "bsmith",
      "mobile_phone": "555-555-5555",
      "primary_email": "bsmith@company.com",
      "secondary_emails": [
        "bsmith@example.com",
        "bsmith2@example.com"
      ],
      "date_hired": "2019-01-01",
      "employee_type_id": 7,
      "work_group_id": 5,
      "schedule_ids": [
        1,
        2
      ],
      "position_qualification_ids": [
        1,
        2,
        3
      ],
      "custom_attributes": [
        {
          "attribute_id": 11,
          "value": ""
        },
        {
          "attribute_id": 10,
          "value": [
            2,
            3
          ]
        }
      ]
    },
    {
      "member_id": 2,
      "is_active": true,
      "first_name": "John",
      "last_name": "Doe",
      "login": "jdoe",
      "mobile_phone": "",
      "primary_email": "jdoe@company.com",
      "secondary_emails": [],
      "date_hired": "",
      "employee_type_id": 0,
      "work_group_id": 1,
      "schedule_ids": [],
      "position_qualification_ids": [],
      "custom_attributes": []
    }
  ],
  "meta": {
    "generated_at_datetime": "2022-01-01T07:42:33-06:00"
  }
}

HTTP status code 400

Error response containing one or more errors returned as a result of invalid request data.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "An example error message 1.",
      "detail": "More details about the specific error 1."
    },
    {
      "error": "An example error message 2.",
      "detail": "More details about the specific error 2."
    }
  ]
}

HTTP status code 403

Error response returned when the API token does not have permission to perform this action.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "Your API token does not have permission to perform this action.",
      "detail": "If you believe this is in error, please talk to your system contact."
    }
  ]
}

HTTP status code 409

Error response when the route cannot be used due to a conflict with the system configuration. Please contact Aladtec Support (support@aladtec.com, 888.749.5550) for help if this error is received.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "An example error message 1.",
      "detail": "More details about the specific error 1."
    },
    {
      "error": "An example error message 2.",
      "detail": "More details about the specific error 2."
    }
  ]
}
<?php

/* Set your system URL and API token here. */
$base_url = 'https://secure#.aladtec.com/example/api/v3';
$api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

$url = $base_url . '/members/batch?';

$ch = curl_init( $url );

/* Set curl options */
curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'POST' );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Authorization: Bearer ' . $api_token,
	'Content-Type: application/json'
));

$members = array(
	array(
		'is_active' => true,
		'first_name' => 'Bob',
		'last_name' => 'Smith',
		'login' => 'bsmith',
		'primary_email' => 'bsmith@company.com',
		'mobile_phone' => '555-555-5555',
		'schedule_ids' => array(
			1,
			2,
		),
	),
	array(
		'first_name' => 'John',
		'last_name' => 'Doe',
		'login' => 'jdoe',
		'primary_email' => 'jdoe@company.com',
	),
);

curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $members ) );

/* Invoke the API and get the response */
$response_body = curl_exec( $ch );

$error = curl_error( $ch );
if ( $error ) {
	echo 'Error: ' . $error;
}

print( $response_body );

curl_close( $ch );
/* Set your system URL and API token here. */
var base_url = 'https://secure#.aladtec.com/example/api/v3';
var api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

var xhr = new XMLHttpRequest();

/* Set the options */
var url = base_url + '/members/batch?';
xhr.open( 'POST', url );
xhr.setRequestHeader( 'Authorization', 'Bearer ' + api_token );
xhr.setRequestHeader( 'Content-Type', 'application/json' );

var members = [
    {
        is_active: true,
        first_name: 'Bob',
        last_name: 'Smith',
        login: 'bsmith',
        primary_email: 'bsmith@company.com',
        mobile_phone: '555-555-5555',
        schedule_ids: [
            1,
            2,
        ],
    },
    {
        first_name: 'John',
        last_name: 'Doe',
        login: 'jdoe',
        primary_email: 'jdoe@company.com',
    },
];

/* Invoke the API and get the response */
xhr.send( JSON.stringify( members ) );

xhr.addEventListener( 'load', function () {
    console.log( xhr.responseText );
});
patch

Updates an existing member using a subset of attributes or the entire member.

get

Returns all employee types. These can be customized per Aladtec system. Examples: part...

get

Returns all customer created Member Database attribute definitions.

/availability

get

Returns Member Availability for the requested date/time range.

/time-off

get

Approved and pending Time Off ranges for the requested date/time range. Note: By default,...

get

Returns all active Time Off Types.

post

Creates new Time Off Types given a list of names.

patch

Updates a subset of existing Time Off Types given a list of IDs and corresponding new...

delete

Deletes a subset of Time Off Types given a list of IDs.

post https://secure#.aladtec.com/example/api/v3/time-off/types

Description

Creates new Time Off Types given a list of names.

Headers

Authorization string required API access token to authenticate the request. The token value must be prefaced with the word "Bearer" and a single space.

Request Body

{} application/json

name string required Name to be assigned to the Time Off Type

Example: 

[
  {
    "name": "Sick Leave"
  },
  {
    "name": "Paid Time Off"
  },
  {
    "name": "Short Term Leave of Absence"
  }
]

HTTP status code 201

Successful response with the new Time Off Types

Response Body

{} application/json

data array

time_off_type_id integer

ID assigned to the Time Off Type

name string

Name of the Time Off Type

meta object

Additional properties describing the record set within data

generated_at_datetime string

RFC 3339 formatted datetime at which data was generated

Example: 

{
  "data": [
    {
      "time_off_type_id": 1,
      "name": "Sick Leave"
    },
    {
      "time_off_type_id": 2,
      "name": "Paid Time Off"
    },
    {
      "time_off_type_id": 3,
      "name": "Short Term Leave of Absence"
    }
  ],
  "meta": {
    "generated_at_datetime": "2022-01-01T07:42:33-06:00"
  }
}

HTTP status code 400

Error response containing one or more errors returned as a result of invalid request data.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "An example error message 1.",
      "detail": "More details about the specific error 1."
    },
    {
      "error": "An example error message 2.",
      "detail": "More details about the specific error 2."
    }
  ]
}

HTTP status code 403

Error response returned when the API token does not have permission to perform this action.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "Your API token does not have permission to perform this action.",
      "detail": "If you believe this is in error, please talk to your system contact."
    }
  ]
}

HTTP status code 404

Error response when Time Off is not enabled in the system.
Please contact Aladtec Support (support@aladtec.com, 888.749.5550) for help if this error is received.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "Time Off is not enabled in this system."
    }
  ]
}

HTTP status code 409

Error response when the route cannot be used due to a conflict with the system configuration. Please contact Aladtec Support (support@aladtec.com, 888.749.5550) for help if this error is received.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "An example error message 1.",
      "detail": "More details about the specific error 1."
    },
    {
      "error": "An example error message 2.",
      "detail": "More details about the specific error 2."
    }
  ]
}
<?php

/* Set your system URL and API token here. */
$base_url = 'https://secure#.aladtec.com/example/api/v3';
$api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

$url = $base_url . '/time-off/types?';

$ch = curl_init( $url );

/* Set curl options */
curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'POST' );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Authorization: Bearer ' . $api_token,
	'Content-Type: application/json'
) );

$time_off_types = array(
	array(
		'name' => 'Sick Leave'
	),
	array(
		'name' => 'Paid Time Off'
	),
	array(
		'name' => 'Short Term Leave of Absence'
	)
);

curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $time_off_types ) );

/* Invoke the API and get the response */
$response_body = curl_exec( $ch );

$error = curl_error( $ch );
if ( $error ) {
	echo 'Error: ' . $error;
}

print( $response_body );

curl_close( $ch );
/* Set your system URL and API token here. */
var base_url = 'https://secure#.aladtec.com/example/api/v3';
var api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

var xhr = new XMLHttpRequest();

/* Set the options */
var url = base_url + '/time-off/types?';
xhr.open( 'POST', url );
xhr.setRequestHeader( 'Authorization', 'Bearer ' + api_token );
xhr.setRequestHeader( 'Content-Type', 'application/json' );

var time_off_types_json = [
	{
		name: 'Sick Leave'
	},
	{
		name: 'Paid Time Off'
	},
	{
		name: 'Short Term Leave of Absence'
	}
];

/* Invoke the API and get the response */
xhr.send( JSON.stringify( time_off_types_json ) );

xhr.addEventListener( 'load', function () {
	console.log( xhr.responseText );
} );

/schedules

get

Schedule configuration defined in an Aladtec system. Data is sorted by the order defined...

get

Returns a list of unique position qualifications.

post

Creates new position qualifications given a list of names.

patch

Updates a subset of existing position qualifications given a list of IDs and corresponding...

delete

Deletes a subset of position qualifications given a list of IDs.

post https://secure#.aladtec.com/example/api/v3/schedules/position-qualifications

Description

Creates new position qualifications given a list of names.

Headers

Authorization string required API access token to authenticate the request. The token value must be prefaced with the word "Bearer" and a single space.

Request Body

{} application/json

name string required Name to be assigned to the position qualification

Example: 

[
  {
    "name": "Driver"
  },
  {
    "name": "Firefighter"
  },
  {
    "name": "EMT"
  }
]

HTTP status code 201

Successful response with the new position qualifications

Response Body

{} application/json

data array

position_qualification_id integer

ID assigned to a position qualification in Aladtec

name string

Name assigned to the qualification

meta object

Additional properties describing the record set within data

generated_at_datetime string

RFC 3339 formatted datetime at which data was generated

Example: 

{
  "data": [
    {
      "position_qualification_id": 1,
      "name": "Driver"
    },
    {
      "position_qualification_id": 2,
      "name": "Firefighter"
    },
    {
      "position_qualification_id": 3,
      "name": "EMT"
    }
  ],
  "meta": {
    "generated_at_datetime": "2022-01-01T07:42:33-06:00"
  }
}

HTTP status code 400

Error response containing one or more errors returned as a result of invalid request data.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "An example error message 1.",
      "detail": "More details about the specific error 1."
    },
    {
      "error": "An example error message 2.",
      "detail": "More details about the specific error 2."
    }
  ]
}

HTTP status code 403

Error response returned when the API token does not have permission to perform this action.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "Your API token does not have permission to perform this action.",
      "detail": "If you believe this is in error, please talk to your system contact."
    }
  ]
}

HTTP status code 409

Error response when the route cannot be used due to a conflict with the system configuration. Please contact Aladtec Support (support@aladtec.com, 888.749.5550) for help if this error is received.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "An example error message 1.",
      "detail": "More details about the specific error 1."
    },
    {
      "error": "An example error message 2.",
      "detail": "More details about the specific error 2."
    }
  ]
}
<?php

/* Set your system URL and API token here. */
$base_url = 'https://secure#.aladtec.com/example/api/v3';
$api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

$url = $base_url . '/schedules/position-qualifications?';

$ch = curl_init( $url );

/* Set curl options */
curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'POST' );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Authorization: Bearer ' . $api_token,
	'Content-Type: application/json'
) );

$position_qualifications = array(
	array(
		'name' => 'Driver'
	),
	array(
		'name' => 'Firefighter'
	),
	array(
		'name' => 'EMT'
	)
);

curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $position_qualifications ) );

/* Invoke the API and get the response */
$response_body = curl_exec( $ch );

$error = curl_error( $ch );
if ( $error ) {
	echo 'Error: ' . $error;
}

print( $response_body );

curl_close( $ch );
/* Set your system URL and API token here. */
var base_url = 'https://secure#.aladtec.com/example/api/v3';
var api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

var xhr = new XMLHttpRequest();

/* Set the options */
var url = base_url + '/schedules/position-qualifications?';
xhr.open( 'POST', url );
xhr.setRequestHeader( 'Authorization', 'Bearer ' + api_token );
xhr.setRequestHeader( 'Content-Type', 'application/json' );

var position_qualifications_json = [
	{
		name: 'Driver'
	},
	{
		name: 'Firefighter'
	},
	{
		name: 'EMT'
	}
];

/* Invoke the API and get the response */
xhr.send( JSON.stringify( position_qualifications_json ) );

xhr.addEventListener( 'load', function () {
	console.log( xhr.responseText );
} );

/scheduled-time

get

Returns scheduled time ranges for a specified period of time

get

Returns time ranges where no member is scheduled. Typically used for finding shifts...

get

Schedule and position for each member scheduled at the time of the request.

get

Returns Schedule Notes grouped by calendar date. Up to one year can be retrieved in a...

get

Returns scheduled time ranges that end within a specified period of time. Adjacent blocks...

/extra-hours

get

Returns extra hours ranges for a specified period of time in the past.

/time-clock

get

Returns a list of unique, active Paycodes which can be applied to time clock time.

get

Returns a list of unique, active Kiosks used to clock in and out.

/time-clock-time

get

Time Clock records for the requested date/time range. If a member is clocked in at the...

get

Members clocked in at the time of the request.

post

Clocks a member in given a valid member ID.

post https://secure#.aladtec.com/example/api/v3/time-clock-time/clock-in

Description

Clocks a member in given a valid member ID.

Headers

Authorization string required API access token to authenticate the request. The token value must be prefaced with the word "Bearer" and a single space.

Request Body

{} application/json

member_id integer required ID assigned to a member by Aladtec
kiosk_id integer required ID of an authenticated time clock kiosk
clock_in_datetime string required Date and time the member is clocking in, format is RFC 3339. The date and time is limited to up to 5 minutes in the future.
paycode_id integer optional ID of an associated paycode, required if paycodes are enabled in the system

Example: 

{
  "member_id": 50,
  "kiosk_id": 18,
  "clock_in_datetime": "2022-08-16T09:02:00-06:00",
  "paycode_id": 1
}

HTTP status code 200

Successful clock in response

Response Body

{} application/json

data object

member_id integer

ID assigned to a member by Aladtec

kiosk_id integer

ID of an authenticated time clock kiosk

clock_in_datetime string

Date and time the member clocked in, format is RFC 3339

paycode_id integer

ID of an associated paycode, null if paycodes are turned off in the system.

meta object

Additional properties describing the record set within data

generated_at_datetime string

RFC 3339 formatted datetime at which data was generated

Example: 

{
  "data": {
    "member_id": 50,
    "kiosk_id": 18,
    "clock_in_datetime": "2022-08-16T09:02:00-06:00",
    "paycode_id": 1
  },
  "meta": {
    "generated_at_datetime": "2023-08-01T07:42:33-06:00"
  }
}

HTTP status code 400

Error response containing one or more errors returned as a result of invalid request data.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "An example error message 1.",
      "detail": "More details about the specific error 1."
    },
    {
      "error": "An example error message 2.",
      "detail": "More details about the specific error 2."
    }
  ]
}

HTTP status code 403

Error response returned when the API token does not have permission to perform this action.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "Your API token does not have permission to perform this action.",
      "detail": "If you believe this is in error, please talk to your system contact."
    }
  ]
}

HTTP status code 404

Error response when Time Clock is not enabled in the system.
Please contact Aladtec Support (support@aladtec.com, 888.749.5550) for help if this error is received.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "Time Clock is not enabled for this system."
    }
  ]
}
<?php

/* Set your system URL and API token here. */
$base_url = 'https://secure#.aladtec.com/example/api/v3';
$api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

$url = $base_url . '/time-clock-time/clock-in?';

$ch = curl_init( $url );

/* Set curl options */
curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'POST' );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Authorization: Bearer ' . $api_token,
	'Content-Type: application/json'
));

$clock_in = array(
	'member_id' => 50,
	'kiosk_id' => 18,
	'clock_in_datetime' => '2022-08-16T15:00:00-05:00',
	'paycode_id' => 1
);

curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $clock_in ) );

/* Invoke the API and get the response */
$response_body = curl_exec( $ch );

$error = curl_error( $ch );
if ( $error ) {
	echo 'Error: ' . $error;
}

print( $response_body );

curl_close( $ch );

/* Set your system URL and API token here. */
var base_url = 'https://secure#.aladtec.com/example/api/v3';
var api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

var xhr = new XMLHttpRequest();

/* Set the options */
var url = base_url + '/time-clock-time/clock-in?';
xhr.open( 'POST', url );
xhr.setRequestHeader( 'Authorization', 'Bearer ' + api_token );
xhr.setRequestHeader( 'Content-Type', 'application/json' );

var clock_in_json = {
	member_id: 50,
	kiosk_id: 18,
	clock_in_datetime: '2022-08-16T15:00:00-05:00',
	paycode_id: 1
};

/* Invoke the API and get the response */
xhr.send( JSON.stringify( clock_in_json ) );

xhr.addEventListener( 'load', function () {
	console.log( xhr.responseText );
});
post

Clocks a member out given a valid member ID.

post https://secure#.aladtec.com/example/api/v3/time-clock-time/clock-out

Description

Clocks a member out given a valid member ID.

Headers

Authorization string required API access token to authenticate the request. The token value must be prefaced with the word "Bearer" and a single space.

Request Body

{} application/json

member_id integer required ID assigned to a member by Aladtec
kiosk_id integer required ID of an authenticated time clock kiosk
clock_out_datetime string required Date and time the member is clocking out, format is RFC 3339. The date and time is limited to up to 5 minutes in the future.

Example: 

{
  "member_id": 50,
  "kiosk_id": 18,
  "clock_out_datetime": "2022-08-16T09:02:00-06:00"
}

HTTP status code 200

Successful clock out response

Response Body

{} application/json

data object

member_id integer

ID assigned to a member by Aladtec

kiosk_id integer

ID of an authenticated time clock kiosk

clock_out_datetime string

Date and time the member clocked out, format is RFC 3339.

meta object

Additional properties describing the record set within data

generated_at_datetime string

RFC 3339 formatted datetime at which data was generated

Example: 

{
  "data": {
    "member_id": 50,
    "kiosk_id": 18,
    "clock_out_datetime": "2022-08-16T09:02:00-06:00"
  },
  "meta": {
    "generated_at_datetime": "2023-08-01T07:42:33-06:00"
  }
}

HTTP status code 400

Error response containing one or more errors returned as a result of invalid request data.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "An example error message 1.",
      "detail": "More details about the specific error 1."
    },
    {
      "error": "An example error message 2.",
      "detail": "More details about the specific error 2."
    }
  ]
}

HTTP status code 403

Error response returned when the API token does not have permission to perform this action.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "Your API token does not have permission to perform this action.",
      "detail": "If you believe this is in error, please talk to your system contact."
    }
  ]
}

HTTP status code 404

Error response when Time Clock is not enabled in the system.
Please contact Aladtec Support (support@aladtec.com, 888.749.5550) for help if this error is received.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "Time Clock is not enabled for this system."
    }
  ]
}
<?php
/* Set your system URL and API token here. */
$base_url = 'https://secure#.aladtec.com/example/api/v3';
$api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

$url = $base_url . '/time-clock-time/clock-out?';
$ch = curl_init( $url );

/* Set curl options */
curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'POST' );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Authorization: Bearer ' . $api_token,
	'Content-Type: application/json'
));

$clock_out = array(
	'member_id' => 50,
	'kiosk_id' => 18,
	'clock_out_datetime' => '2022-08-16T15:00:00-05:00'
);

curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $clock_out ) );

/* Invoke the API and get the response */
$response_body = curl_exec( $ch );

$error = curl_error( $ch );
if ( $error ) {
	echo 'Error: ' . $error;
}

print( $response_body );

curl_close( $ch );

/* Set your system URL and API token here. */
var base_url = 'https://secure#.aladtec.com/example/api/v3';
var api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

var xhr = new XMLHttpRequest();

/* Set the options */
var url = base_url + '/time-clock-time/clock-out?';
xhr.open( 'POST', url );
xhr.setRequestHeader( 'Authorization', 'Bearer ' + api_token );
xhr.setRequestHeader( 'Content-Type', 'application/json' );

var clock_out_json = {
	member_id: 50,
	kiosk_id: 18,
	clock_out_datetime: '2022-08-16T15:00:00-05:00'
};

/* Invoke the API and get the response */
xhr.send( JSON.stringify( clock_out_json ) );

xhr.addEventListener( 'load', function () {
	console.log( xhr.responseText );
});

/events

get

Events for requested date/time range.

/shift-labels

get

Shift Labels for requested date range.

/work-groups

get

Returns all work groups. Work groups are used for putting members into groups if they...

/time-types

get

Returns a list of unique Time Types which can be applied to scheduled time.

/accrual-banks

get

Returns a list of all accrual banks.

get

Returns the number of hours in each specified accrual bank for a list of provided members.

put

Sets accrual bank balances given a list of hours for members' accrual banks.

post

Updates accrual bank balances given a list of adjustment hours for members' accrual banks.

post https://secure#.aladtec.com/example/api/v3/accrual-banks/balances/adjustments

Description

Updates accrual bank balances given a list of adjustment hours for members' accrual banks.

Headers

Authorization string required API access token to authenticate the request. The token value must be prefaced with the word "Bearer" and a single space.

Request Body

{} application/json

member_id integer required ID assigned to a member by Aladtec
accrual_bank_id integer required ID assigned to an accrual bank in Aladtec
adjustment_hours number required The relative number of hours to adjust the accrual bank balance. A positive number will increase the balance, and a negative number will decrease the balance. The number can have, at most, four decimal places of precision (e.g. 10.1234).
note string optional An optional note to log details about the adjustment

Example: 

[
  {
    "member_id": 1,
    "accrual_bank_id": 1,
    "adjustment_hours": 24
  },
  {
    "member_id": 1,
    "accrual_bank_id": 2,
    "adjustment_hours": -40,
    "note": "Example note about the adjustment."
  },
  {
    "member_id": 3,
    "accrual_bank_id": 2,
    "adjustment_hours": 12.5001
  }
]

HTTP status code 200

Successful response containing the updated accrual bank balances

Response Body

{} application/json

data array

member_id integer

ID assigned to a member by Aladtec

accrual_bank_id integer

ID assigned to an accrual bank in Aladtec

hours number

The number of hours in the bank for the specified member in Aladtec

meta object

Additional properties describing the record set within data

generated_at_datetime string

RFC 3339 formatted datetime at which data was generated

Example: 

{
  "data": [
    {
      "member_id": 1,
      "accrual_bank_id": 1,
      "hours": 48
    },
    {
      "member_id": 1,
      "accrual_bank_id": 2,
      "hours": -4
    },
    {
      "member_id": 3,
      "accrual_bank_id": 2,
      "hours": 0.5001
    }
  ],
  "meta": {
    "generated_at_datetime": "2022-01-01T07:42:33-06:00"
  }
}

HTTP status code 400

Error response containing one or more errors returned as a result of invalid request data.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "An example error message 1.",
      "detail": "More details about the specific error 1."
    },
    {
      "error": "An example error message 2.",
      "detail": "More details about the specific error 2."
    }
  ]
}

HTTP status code 403

Error response returned when the API token does not have permission to perform this action.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "Your API token does not have permission to perform this action.",
      "detail": "If you believe this is in error, please talk to your system contact."
    }
  ]
}

HTTP status code 404

Error response when Accrual or Time Off is not enabled in the system.
Please contact Aladtec Support (support@aladtec.com, 888.749.5550) for help if this error is received.

Response Body

{} application/json

errors array

error string

The specific error returned

detail string

More details about the error that occurred

Example: 

{
  "errors": [
    {
      "error": "Time Off is not enabled in this system."
    }
  ]
}
<?php

/* Set your system URL and API token here. */
$base_url = 'https://secure#.aladtec.com/example/api/v3';
$api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

$url = $base_url . '/accrual-banks/balances/adjustments';

$ch = curl_init( $url );

/* Set curl options */
curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, 'POST' );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_HTTPHEADER, array(
	'Authorization: Bearer ' . $api_token,
	'Content-Type: application/json'
));

$accrual_adjustments = array(
	array(
		'member_id' => 1,
		'accrual_bank_id' => 1,
		'adjustment_hours' => 24.000
	),
	array(
		'member_id' => 1,
		'accrual_bank_id' => 2,
		'adjustment_hours' => -40.000,
		'note' => 'Example note about the adjustment.'
	),
	array(
		'member_id' => 3,
		'accrual_bank_id' => 2,
		'adjustment_hours' => 12.5001
	)
);

curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $accrual_adjustments ) );

/* Invoke the API and get the response */
$response_body = curl_exec( $ch );

$error = curl_error( $ch );
if ( $error ) {
	echo 'Error: ' . $error;
}

print( $response_body );

curl_close( $ch );

/* Set your system URL and API token here. */
var base_url = 'https://secure#.aladtec.com/example/api/v3';
var api_token = 'zYyMDk5MTAtbnU1blZVY3NPTHdFWEczWE1MT0RLRkNTYmI3WE1ELjBwYTZaaTNjS';

var xhr = new XMLHttpRequest();

/* Set the options */
var url = base_url + '/accrual-banks/balances/adjustments';
xhr.open( 'POST', url );
xhr.setRequestHeader( 'Authorization', 'Bearer ' + api_token );
xhr.setRequestHeader( 'Content-Type', 'application/json' );

var accrual_adjustments = [
	{
		member_id: 1,
		accrual_bank_id: 1,
		adjustment_hours: 24
	},
	{
		member_id: 1,
		accrual_bank_id: 2,
		adjustment_hours: -40,
		note: 'Example note about the adjustment.'
	},
	{
		member_id: 3,
		accrual_bank_id: 2,
		adjustment_hours: 12.5001
	}
];

/* Invoke the API and get the response */
xhr.send( JSON.stringify( accrual_adjustments ) );

xhr.addEventListener( 'load', function () {
	console.log( xhr.responseText );
});

/configuration

get

Returns a list of configuration settings.

/reports

get

Runs the Payroll Report export. Pagination is required to export all...