SquareConnect\V1EmployeesApi

February 26, 2020 · View on GitHub

All URIs are relative to https://connect.squareup.com

Method	HTTP request	Description
createEmployee	POST /v1/me/employees	CreateEmployee
createEmployeeRole	POST /v1/me/roles	CreateEmployeeRole
createTimecard	POST /v1/me/timecards	CreateTimecard
deleteTimecard	DELETE /v1/me/timecards/{timecard_id}	DeleteTimecard
listCashDrawerShifts	GET /v1/{location_id}/cash-drawer-shifts	ListCashDrawerShifts
listEmployeeRoles	GET /v1/me/roles	ListEmployeeRoles
listEmployees	GET /v1/me/employees	ListEmployees
listTimecardEvents	GET /v1/me/timecards/{timecard_id}/events	ListTimecardEvents
listTimecards	GET /v1/me/timecards	ListTimecards
retrieveCashDrawerShift	GET /v1/{location_id}/cash-drawer-shifts/{shift_id}	RetrieveCashDrawerShift
retrieveEmployee	GET /v1/me/employees/{employee_id}	RetrieveEmployee
retrieveEmployeeRole	GET /v1/me/roles/{role_id}	RetrieveEmployeeRole
retrieveTimecard	GET /v1/me/timecards/{timecard_id}	RetrieveTimecard
updateEmployee	PUT /v1/me/employees/{employee_id}	UpdateEmployee
updateEmployeeRole	PUT /v1/me/roles/{role_id}	UpdateEmployeeRole
updateTimecard	PUT /v1/me/timecards/{timecard_id}	UpdateTimecard

createEmployee

\SquareConnect\Model\V1Employee createEmployee($body)

CreateEmployee

Use the CreateEmployee endpoint to add an employee to a Square account. Employees created with the Connect API have an initial status of INACTIVE. Inactive employees cannot sign in to Square Point of Sale until they are activated from the Square Dashboard. Employee status cannot be changed with the Connect API. <aside class="important"> Employee entities cannot be deleted. To disable employee profiles, set the employee's status to INACTIVE

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = 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 = $apiInstance->createEmployee($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1EmployeesApi->createEmployee: ', $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]

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]

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]

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.

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.

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.