Staff

Get all staff

Get a staff member

• The staff member may have more addresses than the ones shown in then shipping_address and postal_address fields. Use an addresses endpoint to get a complete list of a staff member's addresses.
• Use the sites endpoint to retrieve a list of sites for a given staff member.
• The permissions element will be omitted when the is_admin flag is true.

Permissions

Permissions control the visibility and limit the access of features to individual staff members. Permissions are divided into two categories; Back Office and POS.

Back Office

• Adjustments - Apply adjustments, including discounts, surcharges and adjustment reasons (if enabled).
• CashIn - Allow Cash In for Takings.
• CashOut - Allow Cash Out for Takings.
• ChangePrice - Allows changing of the unit price.
• DeleteHeldOrder - Allows deleting of held orders.
• FinishSale - Allow checkout (finish) of a sale with any payment type.
• MakeDiscount - Allow applying discounts and surcharges. This is implied if the user has the Adjustments permission.
• ModifySales - Allows the modification of a held order.
• OpenCashDrawer - Allows the cash drawer to be opened as part of a checkout or manually.
• OverrideTax - Allow override of the tax on an order line.
• Void - Allow the voiding (refund) of a sale.
• XReport - Allow viewing the current takings. Also known as an X Report.
• ZReport - Allows viewing and creating of end of day takings. Also known as a Z Report.

POS

• Company - Edit company details, taxes and payment types.
• Customers - Create and update customers.
• Devices - Create, update and recycle registers.
• PaymentTypes - Create and update payment types. This is implied if the user has the Company permission.
• PosPermission - Allow access to the POS.
• PrinterSetup - Setup and modify the printer configuration.
• Products - Create and update products.
• Purchase - Create and update purchase orders. This also gives permission to lookup suppliers.
• Reports - Allow viewing of reports, dashboard and the sales feed.
• Sites - Create and update sites.
• Taxes - Create and update taxes. This is implied if the user has the Company permission.
• Users - Create and update other staff in the company.
• Void - Allow the voiding (refund) of a sale.
• Wastage - Create Wastage.

Default Permissisons

If the permissions are not specified they will be the same as if the staff was created through the Back Office. The permissions assigned are:

• Adjustments
• FinishSale
• ModifySales
• PosPermission
• Wastage

Create a staff member

• Creating a staff member will send out an invitation email. The invitation email allows them to setup their password. The invitation email will be sent from the details of the company owner.
• The phone is optional.
• The image is optional. It is the avatar for the staff member.
• The is_admin is optional. If not provided it will default to false.
• The permissions are optional. If not provided all of the default permissions will be assigned (as if the user was created through the Back Office). See the Permissions for a full list.
• If sites are optional. If not provided the staff member will be assigned to all sites.
• If the sites has no elements the staff member will be not be assigned to any sites.
• If tags are optional.
• The code is optional. It can contain a string up to 255 characters.

Update a staff member

• All attributes are optional.
• If you provide an empty array of permissions all permissions will be revoked from that staff member.
• If sites is provided the staff member will be assigned to those specific sites (replacing any existing sites). If sites is not provided they will be assigned to all sites.
• If the sites has no elements the staff member will be removed from all sites.
• If the tags is provided it will replace all existing tags. If the tags contains zero elements it will remove all tags from the staff member.
• The code can contain a string up to 255 characters.

Delete a staff member

List of Webhooks

Here is a list of the supported webhook topics.

staff/created

When a staff member is created. You will receive the complete staff member.

staff/updated

When a staff member is updated. You will receive the complete staff member after the modifications have been applied.

You also may provide the following attribute filters:

• tags

staff/deleted

When a staff member is deleted. You will receive the complete staff member.