Invitations are used to invite other users to access an existing Employer

Name / Description Type / Format Example
employer Item {Item}
The email address of the user that is being invited to access the Employer
string email "string"
An optional message to include in the email sent to the EmailAddress
string "string"
role string "Admin" "Editor" "Reviewer" "PayrollClientApprover" "PayrollClientEditor" "PayrollClientReviewer"
emailId string uuid "string"
emailStatus string "Queued" "Sent" "Failed" "Processing"
invitedBy Item {Item}
The unique id of the object
string uuid "string"
  "employer": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  "emailAddress": "string",
  "message": "string",
  "role": "Admin",
  "emailId": "string",
  "emailStatus": "Queued",
  "invitedBy": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  "id": "string"
Contained in Models

- none -

Consumed by Operations
Create Invitation
Returned by Operations
Create Invitation
Get Invitation