All URIs are relative to https://connect.squareup.com
Method | HTTP request | Description |
---|---|---|
create_employee | POST /v1/me/employees | Creates an employee for a business. |
create_employee_role | POST /v1/me/roles | Creates an employee role you can then assign to employees. |
create_timecard | POST /v1/me/timecards | Creates a timecard for an employee. Each timecard corresponds to a single shift. |
delete_timecard | 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. |
list_cash_drawer_shifts | 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. |
list_employee_roles | GET /v1/me/roles | Provides summary information for all of a business's employee roles. |
list_employees | GET /v1/me/employees | Provides summary information for all of a business's employees. |
list_timecard_events | GET /v1/me/timecards/{timecard_id}/events | Provides summary information for all events associated with a particular timecard. |
list_timecards | GET /v1/me/timecards | Provides summary information for all of a business's employee timecards. |
retrieve_cash_drawer_shift | 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. |
retrieve_employee | GET /v1/me/employees/{employee_id} | Provides the details for a single employee. |
retrieve_employee_role | GET /v1/me/roles/{role_id} | Provides the details for a single employee role. |
retrieve_timecard | GET /v1/me/timecards/{timecard_id} | Provides the details for a single timecard. |
update_employee | PUT /v1/me/employees/{employee_id} | V1 UpdateEmployee |
update_employee_role | PUT /v1/me/roles/{role_id} | Modifies the details of an employee role. |
update_timecard | 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. |
V1Employee create_employee(body)
Creates an employee for a business.
Creates an employee for a business.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
body = SquareConnect::V1Employee.new # V1Employee | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
#Creates an employee for a business.
result = api_instance.create_employee(body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->create_employee: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
body | V1Employee | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
- Content-Type: application/json
- Accept: application/json
V1EmployeeRole create_employee_role(employee_role)
Creates an employee role you can then assign to employees.
Creates an employee role you can then assign to employees.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
employee_role = SquareConnect::V1EmployeeRole.new # V1EmployeeRole | An EmployeeRole object with a name and permissions, and an optional owner flag.
begin
#Creates an employee role you can then assign to employees.
result = api_instance.create_employee_role(employee_role)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->create_employee_role: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
employee_role | V1EmployeeRole | An EmployeeRole object with a name and permissions, and an optional owner flag. |
- Content-Type: application/json
- Accept: application/json
V1Timecard create_timecard(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.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
body = SquareConnect::V1Timecard.new # V1Timecard | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
#Creates a timecard for an employee. Each timecard corresponds to a single shift.
result = api_instance.create_timecard(body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->create_timecard: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
body | V1Timecard | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
- Content-Type: application/json
- Accept: application/json
Object delete_timecard(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.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
timecard_id = "timecard_id_example" # String | The ID of the timecard to delete.
begin
#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.
result = api_instance.delete_timecard(timecard_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->delete_timecard: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
timecard_id | String | The ID of the timecard to delete. |
Object
- Content-Type: application/json
- Accept: application/json
Array<V1CashDrawerShift> list_cash_drawer_shifts(location_id, opts)
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.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
location_id = "location_id_example" # String | The ID of the location to list cash drawer shifts for.
opts = {
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.
}
begin
#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.
result = api_instance.list_cash_drawer_shifts(location_id, opts)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->list_cash_drawer_shifts: #{e}"
end
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] |
- Content-Type: application/json
- Accept: application/json
Array<V1EmployeeRole> list_employee_roles(opts)
Provides summary information for all of a business's employee roles.
Provides summary information for all of a business's employee roles.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
opts = {
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, # Integer | 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.
}
begin
#Provides summary information for all of a business's employee roles.
result = api_instance.list_employee_roles(opts)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->list_employee_roles: #{e}"
end
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 | Integer | 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] |
- Content-Type: application/json
- Accept: application/json
Array<V1Employee> list_employees(opts)
Provides summary information for all of a business's employees.
Provides summary information for all of a business's employees.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
opts = {
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, # Integer | 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.
}
begin
#Provides summary information for all of a business's employees.
result = api_instance.list_employees(opts)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->list_employees: #{e}"
end
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 | Integer | 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] |
- Content-Type: application/json
- Accept: application/json
Array<V1TimecardEvent> list_timecard_events(timecard_id)
Provides summary information for all events associated with a particular timecard.
Provides summary information for all events associated with a particular timecard.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
timecard_id = "timecard_id_example" # String | The ID of the timecard to list events for.
begin
#Provides summary information for all events associated with a particular timecard.
result = api_instance.list_timecard_events(timecard_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->list_timecard_events: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
timecard_id | String | The ID of the timecard to list events for. |
- Content-Type: application/json
- Accept: application/json
Array<V1Timecard> list_timecards(opts)
Provides summary information for all of a business's employee timecards.
Provides summary information for all of a business's employee timecards.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
opts = {
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, # BOOLEAN | 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, # Integer | 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.
}
begin
#Provides summary information for all of a business's employee timecards.
result = api_instance.list_timecards(opts)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->list_timecards: #{e}"
end
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 | BOOLEAN | 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 | Integer | 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] |
- Content-Type: application/json
- Accept: application/json
V1CashDrawerShift retrieve_cash_drawer_shift(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.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
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.
begin
#Provides the details for a single cash drawer shift, including all events that occurred during the shift.
result = api_instance.retrieve_cash_drawer_shift(location_id, shift_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->retrieve_cash_drawer_shift: #{e}"
end
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. |
- Content-Type: application/json
- Accept: application/json
V1Employee retrieve_employee(employee_id)
Provides the details for a single employee.
Provides the details for a single employee.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
employee_id = "employee_id_example" # String | The employee's ID.
begin
#Provides the details for a single employee.
result = api_instance.retrieve_employee(employee_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->retrieve_employee: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
employee_id | String | The employee's ID. |
- Content-Type: application/json
- Accept: application/json
V1EmployeeRole retrieve_employee_role(role_id)
Provides the details for a single employee role.
Provides the details for a single employee role.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
role_id = "role_id_example" # String | The role's ID.
begin
#Provides the details for a single employee role.
result = api_instance.retrieve_employee_role(role_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->retrieve_employee_role: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
role_id | String | The role's ID. |
- Content-Type: application/json
- Accept: application/json
V1Timecard retrieve_timecard(timecard_id)
Provides the details for a single timecard.
Provides the details for a single timecard.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
timecard_id = "timecard_id_example" # String | The timecard's ID.
begin
#Provides the details for a single timecard.
result = api_instance.retrieve_timecard(timecard_id)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->retrieve_timecard: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
timecard_id | String | The timecard's ID. |
- Content-Type: application/json
- Accept: application/json
V1Employee update_employee(employee_id, body)
V1 UpdateEmployee
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
employee_id = "employee_id_example" # String | The ID of the role to modify.
body = SquareConnect::V1Employee.new # V1Employee | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
#V1 UpdateEmployee
result = api_instance.update_employee(employee_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->update_employee: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
employee_id | String | The ID of the role to modify. | |
body | V1Employee | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
- Content-Type: application/json
- Accept: application/json
V1EmployeeRole update_employee_role(role_id, body)
Modifies the details of an employee role.
Modifies the details of an employee role.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
role_id = "role_id_example" # String | The ID of the role to modify.
body = SquareConnect::V1EmployeeRole.new # V1EmployeeRole | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
#Modifies the details of an employee role.
result = api_instance.update_employee_role(role_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->update_employee_role: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
role_id | String | The ID of the role to modify. | |
body | V1EmployeeRole | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
- Content-Type: application/json
- Accept: application/json
V1Timecard update_timecard(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.
# load the gem
require 'square_connect'
# setup authorization
SquareConnect.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = SquareConnect::V1EmployeesApi.new
timecard_id = "timecard_id_example" # String | TThe ID of the timecard to modify.
body = SquareConnect::V1Timecard.new # V1Timecard | An object containing the fields to POST for the request. See the corresponding object definition for field details.
begin
#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.
result = api_instance.update_timecard(timecard_id, body)
p result
rescue SquareConnect::ApiError => e
puts "Exception when calling V1EmployeesApi->update_timecard: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
timecard_id | String | TThe ID of the timecard to modify. | |
body | V1Timecard | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
- Content-Type: application/json
- Accept: application/json