squareconnect.apis.v1_employees_api
All endpoints are relative to Square Connect V2 Documentation
| Method | HTTP request |
|---|---|
| create_employee | POST /v1/me/employees |
| create_employee_role | POST /v1/me/roles |
| create_timecard | POST /v1/me/timecards |
| delete_timecard | DELETE /v1/me/timecards/{timecard_id} |
| list_cash_drawer_shifts | GET /v1/{location_id}/cash-drawer-shifts |
| list_employee_roles | GET /v1/me/roles |
| list_employees | GET /v1/me/employees |
| list_timecard_events | GET /v1/me/timecards/{timecard_id}/events |
| list_timecards | GET /v1/me/timecards |
| retrieve_cash_drawer_shift | GET /v1/{location_id}/cash-drawer-shifts/{shift_id} |
| retrieve_employee | GET /v1/me/employees/{employee_id} |
| retrieve_employee_role | GET /v1/me/roles/{role_id} |
| retrieve_timecard | GET /v1/me/timecards/{timecard_id} |
| update_employee | PUT /v1/me/employees/{employee_id} |
| update_employee_role | PUT /v1/me/roles/{role_id} |
| update_timecard | PUT /v1/me/timecards/{timecard_id} |
V1Employee create_employee(body)
Creates an employee for a business.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| body | V1Employee |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1EmployeeRole create_employee_role(employee_role)
Creates an employee role you can then assign to employees.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| employee_role | V1EmployeeRole |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Timecard create_timecard(body)
Creates a timecard for an employee. Each timecard corresponds to a single shift.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| body | V1Timecard |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| timecard_id | str |
object
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[V1CashDrawerShift] list_cash_drawer_shifts(location_id, order=order, begin_time=begin_time, end_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.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| order | str | [optional] | |
| begin_time | str | [optional] | |
| end_time | str | [optional] |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[V1EmployeeRole] list_employee_roles(order=order, limit=limit, cursor=cursor)
Provides summary information for all of a business's employee roles.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| order | str | [optional] | |
| limit | int | [optional] | |
| cursor | str | [optional] |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[V1Employee] list_employees(order=order, begin_updated_at=begin_updated_at, end_updated_at=end_updated_at, begin_created_at=begin_created_at, end_created_at=end_created_at, status=status, external_id=external_id, limit=limit)
Provides summary information for all of a business's employees.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| order | str | [optional] | |
| begin_updated_at | str | [optional] | |
| end_updated_at | str | [optional] | |
| begin_created_at | str | [optional] | |
| end_created_at | str | [optional] | |
| status | str | [optional] | |
| external_id | str | [optional] | |
| limit | int | [optional] |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[V1TimecardEvent] list_timecard_events(timecard_id)
Provides summary information for all events associated with a particular timecard.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| timecard_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[V1Timecard] list_timecards(order=order, employee_id=employee_id, begin_clockin_time=begin_clockin_time, end_clockin_time=end_clockin_time, begin_clockout_time=begin_clockout_time, end_clockout_time=end_clockout_time, begin_updated_at=begin_updated_at, end_updated_at=end_updated_at, deleted=deleted, limit=limit, cursor=cursor)
Provides summary information for all of a business's employee timecards.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| order | str | [optional] | |
| employee_id | str | [optional] | |
| begin_clockin_time | str | [optional] | |
| end_clockin_time | str | [optional] | |
| begin_clockout_time | str | [optional] | |
| end_clockout_time | str | [optional] | |
| begin_updated_at | str | [optional] | |
| end_updated_at | str | [optional] | |
| deleted | bool | [optional] | |
| limit | int | [optional] | |
| cursor | str | [optional] |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| location_id | str | ||
| shift_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Employee retrieve_employee(employee_id)
Provides the details for a single employee.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| employee_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1EmployeeRole retrieve_employee_role(role_id)
Provides the details for a single employee role.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| role_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Timecard retrieve_timecard(timecard_id)
Provides the details for a single timecard.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| timecard_id | str |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Employee update_employee(employee_id, body)
| Name | Type | Notes | Default Value |
|---|---|---|---|
| employee_id | str | ||
| body | V1Employee |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1EmployeeRole update_employee_role(role_id, body)
Modifies the details of an employee role.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| role_id | str | ||
| body | V1EmployeeRole |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
| Name | Type | Notes | Default Value |
|---|---|---|---|
| timecard_id | str | ||
| body | V1Timecard |
Assign your Access Token from developer portal to the authorization parameter.
[Back to top] [Back to API list] [Back to Model list] [Back to README]