All URIs are relative to https://api.mindbodyonline.com
| Method | HTTP request | Description |
|---|---|---|
| payrollGetClassPayroll | GET /public/v{version}/payroll/classes | Get class payroll for staff members. |
| payrollGetTimeClock | GET /public/v{version}/payroll/timeclock | Get time card payroll for staff members. |
\Swagger\Client\Model\GetClassPayrollResponse payrollGetClassPayroll($site_id, $version, $authorization, $request_end_date_time, $request_include_inactive_staff, $request_limit, $request_offset, $request_staff_id, $request_start_date_time)
Get class payroll for staff members.
A staff authorization token is not required for this endpoint, but if one is passed, its permissions are honored. Depending on the access permissions configured for the staff member whose token is passed, the endpoint returns either only the payroll information for that staff member or it returns the payroll information for all staff members. Note that if a staff member is not paid for a class, earnings of zero are returned by this endpoint. Note that this endpoint calculates both bonus and no-reg rates for assistants.These rates are not supported by the Payroll report in the web interface. Note that this endpoint returns both the teacher’s adjusted rate and the assistant’s pay rate when the assistant is paid by the teacher.The Payroll report in the web interface only returns the teacher’s adjusted rate.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\PayrollApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$site_id = "site_id_example"; // string | ID of the site from which to pull data.
$version = "version_example"; // string |
$authorization = ""; // string | A staff user authorization token.
$request_end_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The end of the date range for the payroll information to be returned. The maximum allowed date range is 14 days.<br /> Default: **Today’s date** * If you do not supply an `EndDateTime`, the data returns for the period from the `StartDateTime` that you supply to today’s date. * If you do not supply an `EndDateTime` or a `StartDateTime`, data returns for the seven days prior to today’s date.
$request_include_inactive_staff = true; // bool | When `true`, payroll information returns for both active and inactive staff members.<br /> Default: **false**
$request_limit = 56; // int | Number of results to include, defaults to 100
$request_offset = 56; // int | Page offset, defaults to 0.
$request_staff_id = 789; // int | A list of staff IDs that you want to retrieve payroll information for. If you do not supply a `StaffId`, all active staff members return, ordered by staff ID.
$request_start_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The beginning of the date range for the payroll information to be returned. The maximum allowed date range is 14 days. * If you do not supply a `StartDateTime`, data returns for the seven days prior to the `EndDateTime` that you supply. * If you do not supply either a `StartDateTime` or an `EndDateTime`, the data returns for seven days prior to today’s date.
try {
$result = $apiInstance->payrollGetClassPayroll($site_id, $version, $authorization, $request_end_date_time, $request_include_inactive_staff, $request_limit, $request_offset, $request_staff_id, $request_start_date_time);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PayrollApi->payrollGetClassPayroll: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| site_id | string | ID of the site from which to pull data. | |
| version | string | ||
| authorization | string | A staff user authorization token. | [optional] [default to ] |
| request_end_date_time | \DateTime | The end of the date range for the payroll information to be returned. The maximum allowed date range is 14 days.<br /> Default: Today’s date * If you do not supply an `EndDateTime`, the data returns for the period from the `StartDateTime` that you supply to today’s date. * If you do not supply an `EndDateTime` or a `StartDateTime`, data returns for the seven days prior to today’s date. | [optional] |
| request_include_inactive_staff | bool | When `true`, payroll information returns for both active and inactive staff members.<br /> Default: false | [optional] |
| request_limit | int | Number of results to include, defaults to 100 | [optional] |
| request_offset | int | Page offset, defaults to 0. | [optional] |
| request_staff_id | int | A list of staff IDs that you want to retrieve payroll information for. If you do not supply a `StaffId`, all active staff members return, ordered by staff ID. | [optional] |
| request_start_date_time | \DateTime | The beginning of the date range for the payroll information to be returned. The maximum allowed date range is 14 days. * If you do not supply a `StartDateTime`, data returns for the seven days prior to the `EndDateTime` that you supply. * If you do not supply either a `StartDateTime` or an `EndDateTime`, the data returns for seven days prior to today’s date. | [optional] |
\Swagger\Client\Model\GetClassPayrollResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml, multipart/form-data
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\GetTimeClockResponse payrollGetTimeClock($site_id, $version, $authorization, $request_end_date_time, $request_include_inactive_staff, $request_limit, $request_offset, $request_staff_id, $request_start_date_time)
Get time card payroll for staff members.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\PayrollApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$site_id = "site_id_example"; // string | ID of the site from which to pull data.
$version = "version_example"; // string |
$authorization = ""; // string | A staff user authorization token.
$request_end_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The end of the date range for the time card information to be returned. If you do not supply an `EndDateTime`, data returns for the seven days prior to today’s date. Classes that begin before the `EndDateTime` are included in the response, regardless of the time that the class ends. The maximum allowed date range is 14 days.<br /> Default: **Today’s date**
$request_include_inactive_staff = true; // bool | When `true`, payroll information returns for both active and inactive staff members.<br /> Default: **false**
$request_limit = 56; // int | Number of results to include, defaults to 100
$request_offset = 56; // int | Page offset, defaults to 0.
$request_staff_id = 789; // int | The staff ID for whom you want to retrieve time card information. If you do not supply a `StaffId`, all active staff members return, ordered by staff ID.
$request_start_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The beginning of the date range for the time card information to be returned. If you do not supply a `StartDateTime`, data returns for the seven days prior to the `EndDateTime` that you supply. The maximum allowed date range is 14 days.
try {
$result = $apiInstance->payrollGetTimeClock($site_id, $version, $authorization, $request_end_date_time, $request_include_inactive_staff, $request_limit, $request_offset, $request_staff_id, $request_start_date_time);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PayrollApi->payrollGetTimeClock: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| site_id | string | ID of the site from which to pull data. | |
| version | string | ||
| authorization | string | A staff user authorization token. | [optional] [default to ] |
| request_end_date_time | \DateTime | The end of the date range for the time card information to be returned. If you do not supply an `EndDateTime`, data returns for the seven days prior to today’s date. Classes that begin before the `EndDateTime` are included in the response, regardless of the time that the class ends. The maximum allowed date range is 14 days.<br /> Default: Today’s date | [optional] |
| request_include_inactive_staff | bool | When `true`, payroll information returns for both active and inactive staff members.<br /> Default: false | [optional] |
| request_limit | int | Number of results to include, defaults to 100 | [optional] |
| request_offset | int | Page offset, defaults to 0. | [optional] |
| request_staff_id | int | The staff ID for whom you want to retrieve time card information. If you do not supply a `StaffId`, all active staff members return, ordered by staff ID. | [optional] |
| request_start_date_time | \DateTime | The beginning of the date range for the time card information to be returned. If you do not supply a `StartDateTime`, data returns for the seven days prior to the `EndDateTime` that you supply. The maximum allowed date range is 14 days. | [optional] |
\Swagger\Client\Model\GetTimeClockResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json, text/json, application/xml, text/xml, multipart/form-data
[Back to top] [Back to API list] [Back to Model list] [Back to README]