All URIs are relative to https://connect.squareup.com
| Method | HTTP request | Description |
|---|---|---|
| createEmployee | POST /v1/me/employees | Creates an employee for a business. |
| createEmployeeRole | POST /v1/me/roles | Creates an employee role you can then assign to employees. |
| createTimecard | POST /v1/me/timecards | Creates a timecard for an employee. Each timecard corresponds to a single shift. |
| deleteTimecard | DELETE /v1/me/timecards/{timecard_id} | Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. |
| listCashDrawerShifts | GET /v1/{location_id}/cash-drawer-shifts | Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. |
| listEmployeeRoles | GET /v1/me/roles | Provides summary information for all of a business's employee roles. |
| listEmployees | GET /v1/me/employees | Provides summary information for all of a business's employees. |
| listTimecardEvents | GET /v1/me/timecards/{timecard_id}/events | Provides summary information for all events associated with a particular timecard. |
| listTimecards | GET /v1/me/timecards | Provides summary information for all of a business's employee timecards. |
| retrieveCashDrawerShift | GET /v1/{location_id}/cash-drawer-shifts/{shift_id} | Provides the details for a single cash drawer shift, including all events that occurred during the shift. |
| retrieveEmployee | GET /v1/me/employees/{employee_id} | Provides the details for a single employee. |
| retrieveEmployeeRole | GET /v1/me/roles/{role_id} | Provides the details for a single employee role. |
| retrieveTimecard | GET /v1/me/timecards/{timecard_id} | Provides the details for a single timecard. |
| updateEmployee | PUT /v1/me/employees/{employee_id} | V1 UpdateEmployee |
| updateEmployeeRole | PUT /v1/me/roles/{role_id} | Modifies the details of an employee role. |
| updateTimecard | PUT /v1/me/timecards/{timecard_id} | Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. |
\SquareConnect\Model\V1Employee createEmployee($body)
Creates an employee for a business.
Creates an employee for a business.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$body = new \SquareConnect\Model\V1Employee(); // \SquareConnect\Model\V1Employee | An object containing the fields to POST for the request. See the corresponding object definition for field details.
try {
$result = $api_instance->createEmployee($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->createEmployee: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| body | \SquareConnect\Model\V1Employee | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
\SquareConnect\Model\V1Employee
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\V1EmployeeRole createEmployeeRole($employee_role)
Creates an employee role you can then assign to employees.
Creates an employee role you can then assign to employees.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$employee_role = new \SquareConnect\Model\V1EmployeeRole(); // \SquareConnect\Model\V1EmployeeRole | An EmployeeRole object with a name and permissions, and an optional owner flag.
try {
$result = $api_instance->createEmployeeRole($employee_role);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->createEmployeeRole: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| employee_role | \SquareConnect\Model\V1EmployeeRole | An EmployeeRole object with a name and permissions, and an optional owner flag. |
\SquareConnect\Model\V1EmployeeRole
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\V1Timecard createTimecard($body)
Creates a timecard for an employee. Each timecard corresponds to a single shift.
Creates a timecard for an employee. Each timecard corresponds to a single shift.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$body = new \SquareConnect\Model\V1Timecard(); // \SquareConnect\Model\V1Timecard | An object containing the fields to POST for the request. See the corresponding object definition for field details.
try {
$result = $api_instance->createTimecard($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->createTimecard: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| body | \SquareConnect\Model\V1Timecard | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
\SquareConnect\Model\V1Timecard
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object deleteTimecard($timecard_id)
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.
Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$timecard_id = "timecard_id_example"; // string | The ID of the timecard to delete.
try {
$result = $api_instance->deleteTimecard($timecard_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->deleteTimecard: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| timecard_id | string | The ID of the timecard to delete. |
object
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\V1CashDrawerShift[] listCashDrawerShifts($location_id, $order, $begin_time, $end_time)
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.
Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$location_id = "location_id_example"; // string | The ID of the location to list cash drawer shifts for.
$order = "order_example"; // string | The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC
$begin_time = "begin_time_example"; // string | The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time minus 90 days.
$end_time = "end_time_example"; // string | The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time.
try {
$result = $api_instance->listCashDrawerShifts($location_id, $order, $begin_time, $end_time);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->listCashDrawerShifts: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| location_id | string | The ID of the location to list cash drawer shifts for. | |
| order | string | The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC | [optional] |
| begin_time | string | The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time minus 90 days. | [optional] |
| end_time | string | The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time. | [optional] |
\SquareConnect\Model\V1CashDrawerShift[]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\V1EmployeeRole[] listEmployeeRoles($order, $limit, $batch_token)
Provides summary information for all of a business's employee roles.
Provides summary information for all of a business's employee roles.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$order = "order_example"; // string | The order in which employees are listed in the response, based on their created_at field.Default value: ASC
$limit = 56; // int | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
$batch_token = "batch_token_example"; // string | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
try {
$result = $api_instance->listEmployeeRoles($order, $limit, $batch_token);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->listEmployeeRoles: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| order | string | The order in which employees are listed in the response, based on their created_at field.Default value: ASC | [optional] |
| limit | int | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] |
| batch_token | string | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] |
\SquareConnect\Model\V1EmployeeRole[]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\V1Employee[] listEmployees($order, $begin_updated_at, $end_updated_at, $begin_created_at, $end_created_at, $status, $external_id, $limit, $batch_token)
Provides summary information for all of a business's employees.
Provides summary information for all of a business's employees.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$order = "order_example"; // string | The order in which employees are listed in the response, based on their created_at field. Default value: ASC
$begin_updated_at = "begin_updated_at_example"; // string | If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format
$end_updated_at = "end_updated_at_example"; // string | If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.
$begin_created_at = "begin_created_at_example"; // string | If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.
$end_created_at = "end_created_at_example"; // string | If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format.
$status = "status_example"; // string | If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE).
$external_id = "external_id_example"; // string | If provided, the endpoint returns only employee entities with the specified external_id.
$limit = 56; // int | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
$batch_token = "batch_token_example"; // string | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
try {
$result = $api_instance->listEmployees($order, $begin_updated_at, $end_updated_at, $begin_created_at, $end_created_at, $status, $external_id, $limit, $batch_token);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->listEmployees: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| order | string | The order in which employees are listed in the response, based on their created_at field. Default value: ASC | [optional] |
| begin_updated_at | string | If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format | [optional] |
| end_updated_at | string | If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format. | [optional] |
| begin_created_at | string | If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format. | [optional] |
| end_created_at | string | If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format. | [optional] |
| status | string | If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE). | [optional] |
| external_id | string | If provided, the endpoint returns only employee entities with the specified external_id. | [optional] |
| limit | int | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] |
| batch_token | string | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] |
\SquareConnect\Model\V1Employee[]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\V1TimecardEvent[] listTimecardEvents($timecard_id)
Provides summary information for all events associated with a particular timecard.
Provides summary information for all events associated with a particular timecard.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$timecard_id = "timecard_id_example"; // string | The ID of the timecard to list events for.
try {
$result = $api_instance->listTimecardEvents($timecard_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->listTimecardEvents: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| timecard_id | string | The ID of the timecard to list events for. |
\SquareConnect\Model\V1TimecardEvent[]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\V1Timecard[] listTimecards($order, $employee_id, $begin_clockin_time, $end_clockin_time, $begin_clockout_time, $end_clockout_time, $begin_updated_at, $end_updated_at, $deleted, $limit, $batch_token)
Provides summary information for all of a business's employee timecards.
Provides summary information for all of a business's employee timecards.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$order = "order_example"; // string | The order in which timecards are listed in the response, based on their created_at field.
$employee_id = "employee_id_example"; // string | If provided, the endpoint returns only timecards for the employee with the specified ID.
$begin_clockin_time = "begin_clockin_time_example"; // string | If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format.
$end_clockin_time = "end_clockin_time_example"; // string | If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format.
$begin_clockout_time = "begin_clockout_time_example"; // string | If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format.
$end_clockout_time = "end_clockout_time_example"; // string | If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format.
$begin_updated_at = "begin_updated_at_example"; // string | If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format.
$end_updated_at = "end_updated_at_example"; // string | If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.
$deleted = true; // bool | If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don't provide this parameter, both valid and deleted timecards are returned.
$limit = 56; // int | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
$batch_token = "batch_token_example"; // string | A pagination cursor to retrieve the next set of results for your original query to the endpoint.
try {
$result = $api_instance->listTimecards($order, $employee_id, $begin_clockin_time, $end_clockin_time, $begin_clockout_time, $end_clockout_time, $begin_updated_at, $end_updated_at, $deleted, $limit, $batch_token);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->listTimecards: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| order | string | The order in which timecards are listed in the response, based on their created_at field. | [optional] |
| employee_id | string | If provided, the endpoint returns only timecards for the employee with the specified ID. | [optional] |
| begin_clockin_time | string | If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format. | [optional] |
| end_clockin_time | string | If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format. | [optional] |
| begin_clockout_time | string | If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format. | [optional] |
| end_clockout_time | string | If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format. | [optional] |
| begin_updated_at | string | If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format. | [optional] |
| end_updated_at | string | If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format. | [optional] |
| deleted | bool | If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don't provide this parameter, both valid and deleted timecards are returned. | [optional] |
| limit | int | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] |
| batch_token | string | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] |
\SquareConnect\Model\V1Timecard[]
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\V1CashDrawerShift retrieveCashDrawerShift($location_id, $shift_id)
Provides the details for a single cash drawer shift, including all events that occurred during the shift.
Provides the details for a single cash drawer shift, including all events that occurred during the shift.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$location_id = "location_id_example"; // string | The ID of the location to list cash drawer shifts for.
$shift_id = "shift_id_example"; // string | The shift's ID.
try {
$result = $api_instance->retrieveCashDrawerShift($location_id, $shift_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->retrieveCashDrawerShift: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| location_id | string | The ID of the location to list cash drawer shifts for. | |
| shift_id | string | The shift's ID. |
\SquareConnect\Model\V1CashDrawerShift
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\V1Employee retrieveEmployee($employee_id)
Provides the details for a single employee.
Provides the details for a single employee.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$employee_id = "employee_id_example"; // string | The employee's ID.
try {
$result = $api_instance->retrieveEmployee($employee_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->retrieveEmployee: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| employee_id | string | The employee's ID. |
\SquareConnect\Model\V1Employee
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\V1EmployeeRole retrieveEmployeeRole($role_id)
Provides the details for a single employee role.
Provides the details for a single employee role.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$role_id = "role_id_example"; // string | The role's ID.
try {
$result = $api_instance->retrieveEmployeeRole($role_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->retrieveEmployeeRole: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| role_id | string | The role's ID. |
\SquareConnect\Model\V1EmployeeRole
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\V1Timecard retrieveTimecard($timecard_id)
Provides the details for a single timecard.
Provides the details for a single timecard.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$timecard_id = "timecard_id_example"; // string | The timecard's ID.
try {
$result = $api_instance->retrieveTimecard($timecard_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->retrieveTimecard: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| timecard_id | string | The timecard's ID. |
\SquareConnect\Model\V1Timecard
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\V1Employee updateEmployee($employee_id, $body)
V1 UpdateEmployee
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$employee_id = "employee_id_example"; // string | The ID of the role to modify.
$body = new \SquareConnect\Model\V1Employee(); // \SquareConnect\Model\V1Employee | An object containing the fields to POST for the request. See the corresponding object definition for field details.
try {
$result = $api_instance->updateEmployee($employee_id, $body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->updateEmployee: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| employee_id | string | The ID of the role to modify. | |
| body | \SquareConnect\Model\V1Employee | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
\SquareConnect\Model\V1Employee
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\V1EmployeeRole updateEmployeeRole($role_id, $body)
Modifies the details of an employee role.
Modifies the details of an employee role.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$role_id = "role_id_example"; // string | The ID of the role to modify.
$body = new \SquareConnect\Model\V1EmployeeRole(); // \SquareConnect\Model\V1EmployeeRole | An object containing the fields to POST for the request. See the corresponding object definition for field details.
try {
$result = $api_instance->updateEmployeeRole($role_id, $body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->updateEmployeeRole: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| role_id | string | The ID of the role to modify. | |
| body | \SquareConnect\Model\V1EmployeeRole | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
\SquareConnect\Model\V1EmployeeRole
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SquareConnect\Model\V1Timecard updateTimecard($timecard_id, $body)
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.
Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new SquareConnect\Api\V1EmployeesApi();
$timecard_id = "timecard_id_example"; // string | TThe ID of the timecard to modify.
$body = new \SquareConnect\Model\V1Timecard(); // \SquareConnect\Model\V1Timecard | An object containing the fields to POST for the request. See the corresponding object definition for field details.
try {
$result = $api_instance->updateTimecard($timecard_id, $body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling V1EmployeesApi->updateTimecard: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| timecard_id | string | TThe ID of the timecard to modify. | |
| body | \SquareConnect\Model\V1Timecard | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
\SquareConnect\Model\V1Timecard
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]