From e97459350353a3263560a377721f5162af8d2ddf Mon Sep 17 00:00:00 2001 From: Kam Date: Sun, 17 Jan 2016 11:22:34 +1000 Subject: [PATCH] Make CSS templates more modular --- .gitignore | 6 +- app/stylesheets/_foundation-includes.scss | 5 +- app/stylesheets/_index.scss | 16 + app/stylesheets/_variables.scss | 86 +- app/stylesheets/spectacle-core.scss | 6 + app/stylesheets/spectacle.scss | 14 +- bin/cli.js | 8 +- public/index.html | 46169 ++++++++++++++++++-- 8 files changed, 42925 insertions(+), 3385 deletions(-) create mode 100644 app/stylesheets/_index.scss create mode 100644 app/stylesheets/spectacle-core.scss diff --git a/.gitignore b/.gitignore index a81d980..2b2aeea 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ ~* *~ -bak -node_modules +*bak *cache -npm-debug.log +*.log +node_modules diff --git a/app/stylesheets/_foundation-includes.scss b/app/stylesheets/_foundation-includes.scss index f78957c..ec4c119 100644 --- a/app/stylesheets/_foundation-includes.scss +++ b/app/stylesheets/_foundation-includes.scss @@ -1,9 +1,10 @@ // -// Include Foundation components +//= Include Foundation components @import 'foundation'; -// TODO: Conditionally include `foundation-global-styles` +// TODO: Conditionally include `foundation-global-styles`. +// It's better if we don't have ANY global includes. @include foundation-global-styles; #spectacle { diff --git a/app/stylesheets/_index.scss b/app/stylesheets/_index.scss new file mode 100644 index 0000000..6f0052d --- /dev/null +++ b/app/stylesheets/_index.scss @@ -0,0 +1,16 @@ +// +//= Main includes +// + +#spectacle { + + // Include highlight.js style + @import 'monokai'; + + // Include Spectacle layout + @import 'variables'; + @import 'utils'; + @import 'schema'; + @import 'layout'; + +} diff --git a/app/stylesheets/_variables.scss b/app/stylesheets/_variables.scss index 27d7c88..232056f 100644 --- a/app/stylesheets/_variables.scss +++ b/app/stylesheets/_variables.scss @@ -3,69 +3,69 @@ // // The height of the top bar -$topbar-height: 50px; +$topbar-height: 50px !default; // The width of the column padding -$column-padding: 2.25rem; +$column-padding: 2.25rem !default; // The accent color to use for nav highlights and section headings -$accent-color: #f68b1f; +$accent-color: #f68b1f !default; // The dark backgorund color behind code examples -$dark-background-color: $black; +$dark-background-color: $black !default; // Medium device width (from Foundation) -$medium-width: 40em; +$medium-width: 40em !default; // Large device width (from Foundation) -$large-width: 64em; +$large-width: 64em !default; // // JSON schema labels -$msg-json-section-description: "Description"; -$msg-json-section-properties: "Properties"; -$msg-json-section-items: "Items"; -$msg-json-section-inherited: "Inherited"; -$msg-json-section-anyOf: "Any of"; -$msg-json-discriminator: "discriminator"; -$msg-json-read-only: "read only"; -$msg-json-required: "required"; -$msg-json-ref-prefix: "Details: "; -$msg-json-section-additionalProperties: "Additional properties"; -$msg-json-section-example: "Example"; +$msg-json-section-description: "Description" !default; +$msg-json-section-properties: "Properties" !default; +$msg-json-section-items: "Items" !default; +$msg-json-section-inherited: "Inherited" !default; +$msg-json-section-anyOf: "Any of" !default; +$msg-json-discriminator: "discriminator" !default; +$msg-json-read-only: "read only" !default; +$msg-json-required: "required" !default; +$msg-json-ref-prefix: "Details: " !default; +$msg-json-section-additionalProperties: "Additional properties" !default; +$msg-json-section-example: "Example" !default; // // Swagger labels -$msg-swagger-data-type: 'Data type'; -$msg-swagger-description: 'Description'; +$msg-swagger-data-type: 'Data type' !default; +$msg-swagger-description: 'Description' !default; -$msg-swagger-section-operation-path: 'Path'; -$msg-swagger-section-operation-description: $msg-swagger-description; -$msg-swagger-section-request-params: 'Request parameters'; -$msg-swagger-section-request-body: 'Request body'; -$msg-swagger-section-responses: 'Responses'; +$msg-swagger-section-operation-path: 'Path' !default; +$msg-swagger-section-operation-description: $msg-swagger-description !default; +$msg-swagger-section-request-params: 'Request parameters' !default; +$msg-swagger-section-request-body: 'Request body' !default; +$msg-swagger-section-responses: 'Responses' !default; -$msg-swagger-param-key: 'Key'; -$msg-swagger-param-name: 'Name'; -$msg-swagger-param-description: $msg-swagger-description; -$msg-swagger-param-data-type: 'Data type'; -$msg-swagger-param-type: 'Type'; +$msg-swagger-param-key: 'Key' !default; +$msg-swagger-param-name: 'Name' !default; +$msg-swagger-param-description: $msg-swagger-description !default; +$msg-swagger-param-data-type: 'Data type' !default; +$msg-swagger-param-type: 'Type' !default; -$msg-swagger-response-header-name: 'Header'; -$msg-swagger-response-header-description: $msg-swagger-description; -$msg-swagger-response-header-data-type: 'Data type'; +$msg-swagger-response-header-name: 'Header' !default; +$msg-swagger-response-header-description: $msg-swagger-description !default; +$msg-swagger-response-header-data-type: 'Data type' !default; -$msg-swagger-section-request-security: 'Security'; -$msg-swagger-request-security-scopes: 'Scopes'; -$msg-swagger-request-security-schema: 'Schema'; -$msg-swagger-security-definition-properties: 'Properties'; -$msg-swagger-security-definition-type-basic: '(HTTP Basic Authentication)'; -$msg-swagger-security-definition-type-oauth2: '(OAuth2 Authentication)'; -$msg-swagger-security-definition-type-apikey: '(API Key Authentication)'; -$msg-swagger-badge-global: 'global'; +$msg-swagger-section-request-security: 'Security' !default; +$msg-swagger-request-security-scopes: 'Scopes' !default; +$msg-swagger-request-security-schema: 'Schema' !default; +$msg-swagger-security-definition-properties: 'Properties' !default; +$msg-swagger-security-definition-type-basic: '(HTTP Basic Authentication)' !default; +$msg-swagger-security-definition-type-oauth2: '(OAuth2 Authentication)' !default; +$msg-swagger-security-definition-type-apikey: '(API Key Authentication)' !default; +$msg-swagger-badge-global: 'global' !default; -$msg-swagger-response-code: 'Code'; -$msg-swagger-response-description: 'Description'; -$msg-swagger-response-schema: 'Schema'; +$msg-swagger-response-code: 'Code' !default; +$msg-swagger-response-description: 'Description' !default; +$msg-swagger-response-schema: 'Schema' !default; diff --git a/app/stylesheets/spectacle-core.scss b/app/stylesheets/spectacle-core.scss new file mode 100644 index 0000000..b68cf57 --- /dev/null +++ b/app/stylesheets/spectacle-core.scss @@ -0,0 +1,6 @@ +// +//= Spectacle core +// + +// Include just the Spectacle core without Foundation +@import 'index'; diff --git a/app/stylesheets/spectacle.scss b/app/stylesheets/spectacle.scss index 597711e..16fbb1b 100644 --- a/app/stylesheets/spectacle.scss +++ b/app/stylesheets/spectacle.scss @@ -7,15 +7,5 @@ @import 'foundation-settings'; @import 'foundation-includes'; -#spectacle { - - // Include highlight.js style - @import 'monokai'; - - // Include Spectacle layout - @import 'variables'; - @import 'utils'; - @import 'schema'; - @import 'layout'; - -} +// Include Spectacle +@import 'index'; diff --git a/bin/cli.js b/bin/cli.js index c44c6e2..0bfa310 100644 --- a/bin/cli.js +++ b/bin/cli.js @@ -17,8 +17,8 @@ process.chdir(__dirname + '/..'); program.version(package.version) .usage('spactacle [options] ') .description(package.description) - .option('-S, --no-css', 'omit CSS generation (default: false)') - .option('-J, --no-js', 'omit JavaScript generation (default: false)') + .option('-C, --disable-css', 'omit CSS generation (default: false)') + .option('-J, --disable-js', 'omit JavaScript generation (default: false)') .option('-e, --embeddable', 'omit the HTML and generate the documentation content only (default: false)') .option('-d, --development-mode', 'start HTTP server with the file watcher and live reload (default: false)') .option('-s, --start-server', 'start the HTTP server without any development features') @@ -92,10 +92,10 @@ if (program.startServer) { grunt.task.run('server'); } else { - if (!program.noCss) { + if (!program.disableCss) { grunt.task.run('stylesheets'); } - if (!program.noJs) { + if (!program.disableJs) { grunt.task.run('javascripts'); } grunt.task.run('templates'); diff --git a/public/index.html b/public/index.html index 99ba116..24c040f 100644 --- a/public/index.html +++ b/public/index.html @@ -1,3331 +1,42858 @@ - - - - - - Swagger Sample App | API Reference - - - - - -
-
-
    - -
-
-
-
-
-
-
-
-
-

This is a sample server Petstore server. You can find out more about Swagger at http://swagger.wordnik.com or on irc.freenode.net, #swagger. For this sample, you can use the api key "special-key" to test the authorization filters

- -
-
-
- - - - -
Version: - 1.0.0 -
-
-
+
+
+
+
+
+
+
+

PayApp Payroll System

+
- -

user

- -
- - -
- user -
- - - -

-
Creates list of users with given input array
-

- -
-
-
- POST - /user/createWithList -
-
-
- - -
-
- -
-
-
-
- - User - -
-
-
- -

List of user object

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "email": "string",
-  "firstName": "string",
-  "id": "integer(int64)",
-  "lastName": "string",
-  "password": "string",
-  "phone": "string",
-  "userStatus": "integer(int32)",
-  "username": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
- -
- - -
- user -
- - - -

-
Creates list of users with given input array
-

- -
-
-
- POST - /user/createWithArray -
-
-
- - -
-
- -
-
-
-
-
-
-
- -

List of user object

- - -
-
-
- - -
- -
-
-
Request Example
-
-
-
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
- -
- - -
- user -
- - - -

-
Get user by user name
-

- -
-
-
- GET - /user/{username} -
-
-
- - -
-
- - -
-
-
-
username
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- User - -
- -
-
-

successful operation

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid username supplied

- -
-
-
-
-
404 Not Found
-
-
-

User not found

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "email": "string",
-  "firstName": "string",
-  "id": "integer(int64)",
-  "lastName": "string",
-  "password": "string",
-  "phone": "string",
-  "userStatus": "integer(int32)",
-  "username": "string"
-}
-
-
-
-
-
-
- -
- - -
- user -
- - - -

-
Updated user
-

- -
-
-
- PUT - /user/{username} -
-
-
- -
-
-
-

This can only be done by the logged in user.

- -
-
-
- -
-
- -
-
-
-
- - User - -
-
-
- -

Updated user object

- - -
-
-
- - -
-
-
-
username
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "email": "string",
-  "firstName": "string",
-  "id": "integer(int64)",
-  "lastName": "string",
-  "password": "string",
-  "phone": "string",
-  "userStatus": "integer(int32)",
-  "username": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
400 Bad Request
-
-
-

Invalid user supplied

- -
-
-
-
-
404 Not Found
-
-
-

User not found

- -
-
-
-
-
-
-
- -
- - -
- user -
- - - -

-
Delete user
-

- -
-
-
- DELETE - /user/{username} -
-
-
- -
-
-
-

This can only be done by the logged in user.

- -
-
-
- -
-
- - -
-
-
-
username
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
400 Bad Request
-
-
-

Invalid username supplied

- -
-
-
-
-
404 Not Found
-
-
-

User not found

- -
-
-
-
-
-
-
- -
- - -
- user -
- - - -

-
Create user
-

- -
-
-
- POST - /user -
-
-
- -
-
-
-

This can only be done by the logged in user.

- -
-
-
- -
-
- -
-
-
-
- - User - -
-
-
- -

Created user object

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "email": "string",
-  "firstName": "string",
-  "id": "integer(int64)",
-  "lastName": "string",
-  "password": "string",
-  "phone": "string",
-  "userStatus": "integer(int32)",
-  "username": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
- -
- - -
- user -
- - - -

-
Logs out current logged in user session
-

- -
-
-
- GET - /user/logout -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
- -
- - -
- user -
- - - -

-
Logs user into the system
-

- -
-
-
- GET - /user/login -
-
-
- - -
-
- - -
-
-
-
username
-
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
-
password
-
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- -
-
-

successful operation

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid username/password supplied

- -
-
-
-
-
-
Response Example (200 OK)
-
-
-
-
-
-

pet

- -
- - -
- pet -
- - - -

-
Update an existing pet
-

- -
-
-
- PUT - /pet -
-
-
- - -
-
- -
-
-
-
- - Pet - -
-
-
- -

Pet object that needs to be added to the store

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "category": {
-    "$ref": "Category"
-  },
-  "id": "integer(int64)",
-  "name": "string",
-  "photoUrls": "array",
-  "status": "string",
-  "tags": "array"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
400 Bad Request
-
-
-

Invalid ID supplied

- -
-
-
-
-
404 Not Found
-
-
-

Pet not found

- -
-
-
-
-
405 Method Not Allowed
-
-
-

Validation exception

- -
-
-
-
-
-
-
- -
- - -
- pet -
- - - -

-
Add a new pet to the store
-

- -
-
-
- POST - /pet -
-
-
- - -
-
- -
-
-
-
- - Pet - -
-
-
- -

Pet object that needs to be added to the store

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "category": {
-    "$ref": "Category"
-  },
-  "id": "integer(int64)",
-  "name": "string",
-  "photoUrls": "array",
-  "status": "string",
-  "tags": "array"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
405 Method Not Allowed
-
-
-

Invalid input

- -
-
-
-
-
-
-
- -
- - -
- pet -
- - - -

-
Finds Pets by status
-

- -
-
-
- GET - /pet/findByStatus -
-
-
- -
-
-
-

Multiple status values can be provided with comma seperated strings

- -
-
-
- -
-
- - -
-
-
-
status
-
-
- -

(no description)

-
-
-
-
format
-
undefined
-
-
type
-
string[] - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Pet - -
- -
-
-

successful operation

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid status value

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "category": {
-    "$ref": "Category"
-  },
-  "id": "integer(int64)",
-  "name": "string",
-  "photoUrls": "array",
-  "status": "string",
-  "tags": "array"
-}
-
-
-
-
-
-
- -
- - -
- pet -
- - - -

-
Finds Pets by tags
-

- -
-
-
- GET - /pet/findByTags -
-
-
- -
-
-
-

Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.

- -
-
-
- -
-
- - -
-
-
-
tags
-
-
- -

(no description)

-
-
-
-
format
-
undefined
-
-
type
-
string[] - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Pet - -
- -
-
-

successful operation

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid tag value

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "category": {
-    "$ref": "Category"
-  },
-  "id": "integer(int64)",
-  "name": "string",
-  "photoUrls": "array",
-  "status": "string",
-  "tags": "array"
-}
-
-
-
-
-
-
- -
- - -
- pet -
- - - -

-
Find pet by ID
-

- -
-
-
- GET - /pet/{petId} -
-
-
- -
-
-
-

Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions

- -
-
-
- -
-
- - -
-
-
-
petId
- -
-
- -

(no descrip

- - - - - Swagger Sample App | API Reference - - - - - -
-
-
    - -
-
-
-
-
-
-
-
-
-

This is a sample server Petstore server. You can find out more about Swagger at http://swagger.wordnik.com or on irc.freenode.net, #swagger. For this sample, you can use the api key "special-key" to test the authorization filters

- -
-
-
- - - - -
Version: - 1.0.0 -
-
-
+
+
+
API Endpoint
+
+ 

+https://api.mytommy.com/api/v1
+
+
+ + +
Response Content-Types: + application/json +
+ +
Schemes: + http, https +
+ +
Version: + 1.0.0 +
+
- -

user

- -
- - -
- user -
- - - -

-
Creates list of users with given input array
-

- -
-
-
- POST - /user/createWithList -
-
-
- - -
-
- -
-
-
-
- - User - -
-
-
- -

List of user object

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "email": "string",
-  "firstName": "string",
-  "id": "integer(int64)",
-  "lastName": "string",
-  "password": "string",
-  "phone": "string",
-  "userStatus": "integer(int32)",
-  "username": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
- -
- - -
- user -
- - - -

-
Creates list of users with given input array
-

- -
-
-
- POST - /user/createWithArray -
-
-
- - -
-
- -
-
-
-
-
-
-
- -

List of user object

- - -
-
-
- - -
- -
-
-
Request Example
-
-
-
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
- -
- - -
- user -
- - - -

-
Get user by user name
-

- -
-
-
- GET - /user/{username} -
-
-
- - -
-
- - -
-
-
-
username
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- User - -
- -
-
-

successful operation

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid username supplied

- -
-
-
-
-
404 Not Found
-
-
-

User not found

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "email": "string",
-  "firstName": "string",
-  "id": "integer(int64)",
-  "lastName": "string",
-  "password": "string",
-  "phone": "string",
-  "userStatus": "integer(int32)",
-  "username": "string"
-}
-
-
-
-
-
-
- -
- - -
- user -
- - - -

-
Updated user
-

- -
-
-
- PUT - /user/{username} -
-
-
- -
-
-
-

This can only be done by the logged in user.

- -
-
-
- -
-
- -
-
-
-
- - User - -
-
-
- -

Updated user object

- - -
-
-
- - -
-
-
-
username
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "email": "string",
-  "firstName": "string",
-  "id": "integer(int64)",
-  "lastName": "string",
-  "password": "string",
-  "phone": "string",
-  "userStatus": "integer(int32)",
-  "username": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
400 Bad Request
-
-
-

Invalid user supplied

- -
-
-
-
-
404 Not Found
-
-
-

User not found

- -
-
-
-
-
-
-
- -
- - -
- user -
- - - -

-
Delete user
-

- -
-
-
- DELETE - /user/{username} -
-
-
- -
-
-
-

This can only be done by the logged in user.

- -
-
-
- -
-
- - -
-
-
-
username
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
400 Bad Request
-
-
-

Invalid username supplied

- -
-
-
-
-
404 Not Found
-
-
-

User not found

- -
-
-
-
-
-
-
- -
- - -
- user -
- - - -

-
Create user
-

- -
-
-
- POST - /user -
-
-
- -
-
-
-

This can only be done by the logged in user.

- -
-
-
- -
-
- -
-
-
-
- - User - -
-
-
- -

Created user object

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "email": "string",
-  "firstName": "string",
-  "id": "integer(int64)",
-  "lastName": "string",
-  "password": "string",
-  "phone": "string",
-  "userStatus": "integer(int32)",
-  "username": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
- -
- - -
- user -
- - - -

-
Logs out current logged in user session
-

- -
-
-
- GET - /user/logout -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
- -
- - -
- user -
- - - -

-
Logs user into the system
-

- -
-
-
- GET - /user/login -
-
-
- - -
-
- - -
-
-
-
username
-
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
-
password
-
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- -
-
-

successful operation

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid username/password supplied

- -
-
-
-
-
-
Response Example (200 OK)
-
-
-
-
-
-

pet

- -
- - -
- pet -
- - - -

-
Update an existing pet
-

- -
-
-
- PUT - /pet -
-
-
- - -
-
- -
-
-
-
- - Pet - -
-
-
- -

Pet object that needs to be added to the store

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "category": {
-    "$ref": "Category"
-  },
-  "id": "integer(int64)",
-  "name": "string",
-  "photoUrls": "array",
-  "status": "string",
-  "tags": "array"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
400 Bad Request
-
-
-

Invalid ID supplied

- -
-
-
-
-
404 Not Found
-
-
-

Pet not found

- -
-
-
-
-
405 Method Not Allowed
-
-
-

Validation exception

- -
-
-
-
-
-
-
- -
- - -
- pet -
- - - -

-
Add a new pet to the store
-

- -
-
-
- POST - /pet -
-
-
- - -
-
- -
-
-
-
- - Pet - -
-
-
- -

Pet object that needs to be added to the store

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "category": {
-    "$ref": "Category"
-  },
-  "id": "integer(int64)",
-  "name": "string",
-  "photoUrls": "array",
-  "status": "string",
-  "tags": "array"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
405 Method Not Allowed
-
-
-

Invalid input

- -
-
-
-
-
-
-
- -
- - -
- pet -
- - - -

-
Finds Pets by status
-

- -
-
-
- GET - /pet/findByStatus -
-
-
- -
-
-
-

Multiple status values can be provided with comma seperated strings

- -
-
-
- -
-
- - -
-
-
-
status
-
-
- -

(no description)

-
-
-
-
format
-
undefined
-
-
type
-
string[] - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Pet - -
- -
-
-

successful operation

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid status value

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "category": {
-    "$ref": "Category"
-  },
-  "id": "integer(int64)",
-  "name": "string",
-  "photoUrls": "array",
-  "status": "string",
-  "tags": "array"
-}
-
-
-
-
-
-
- -
- - -
- pet -
- - - -

-
Finds Pets by tags
-

- -
-
-
- GET - /pet/findByTags -
-
-
- -
-
-
-

Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.

- -
-
-
- -
-
- - -
-
-
-
tags
-
-
- -

(no description)

-
-
-
-
format
-
undefined
-
-
type
-
string[] - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Pet - -
- -
-
-

successful operation

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid tag value

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "category": {
-    "$ref": "Category"
-  },
-  "id": "integer(int64)",
-  "name": "string",
-  "photoUrls": "array",
-  "status": "string",
-  "tags": "array"
-}
-
-
-
-
-
-
- -
- - -
- pet -
- - - -

-
Find pet by ID
-

- -
-
-
- GET - /pet/{petId} -
-
-
- -
-
-
-

Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions

- -
-
-
- -
-
- - -
-
-
-
petId
- -
-
- -

(no description)

-
-
-
-
type
-
integer (int64) - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Pet - -
- -
-
-

successful operation

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid ID supplied

- -
-
-
-
-
404 Not Found
-
-
-

Pet not found

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "category": {
-    "$ref": "Category"
-  },
-  "id": "integer(int64)",
-  "name": "string",
-  "photoUrls": "array",
-  "status": "string",
-  "tags": "array"
-}
-
-
-
-
-
-
-

store

- -
- - -
- store -
- - - -

-
Find purchase order by ID
-

- -
-
-
- GET - /store/order/{orderId} -
-
-
- -
-
-
-

For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions

- -
-
-
- -
-
- - -
-
-
-
orderId
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Order - -
- -
-
-

successful operation

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid ID supplied

- -
-
-
-
-
404 Not Found
-
-
-

Order not found

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "complete": {
-    "$ref": "boolean"
-  },
-  "id": "integer(int64)",
-  "petId": "integer(int64)",
-  "quantity": "integer(int32)",
-  "shipDate": "string(date-time)",
-  "status": "string"
-}
-
-
-
-
-
-
- -
- - -
- store -
- - - -

-
Delete purchase order by ID
-

- -
-
-
- DELETE - /store/order/{orderId} -
-
-
- -
-
-
-

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

- -
-
-
- -
-
- - -
-
-
-
orderId
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
400 Bad Request
-
-
-

Invalid ID supplied

- -
-
-
-
-
404 Not Found
-
-
-

Order not found

- -
-
-
-
-
-
-
- -
- - -
- store -
- - - -

-
Place an order for a pet
-

- -
-
-
- POST - /store/order -
-
-
- - -
-
- -
-
-
-
- - Order - -
-
-
- -

order placed for purchasing the pet

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "complete": {
-    "$ref": "boolean"
-  },
-  "id": "integer(int64)",
-  "petId": "integer(int64)",
-  "quantity": "integer(int32)",
-  "shipDate": "string(date-time)",
-  "status": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
- Order - -
- -
-
-

successful operation

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid Order

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "complete": {
-    "$ref": "boolean"
-  },
-  "id": "integer(int64)",
-  "petId": "integer(int64)",
-  "quantity": "integer(int32)",
-  "shipDate": "string(date-time)",
-  "status": "string"
-}
-
-
-
-
-
-
+
- -

Schema definitions

- -
-

- boolean: - object - - - -

-
-
- -
-
-
-
-
-
-
-
-

- Category: - object - - - -

-
-
- -
-
-
- name: - string - - -
-
- id: - integer (int64) - - -
-
-
-
-
-
-
-

- Order: - object - - - -

-
-
- -
-
-
- complete: - - boolean - - - - -
-
- shipDate: - object - - -
-
- quantity: - object - - -
-
- petId: - object - - -
-
- id: - object - - -
-
- status: - object - - -
-
-
-
-
-
-
-

- Pet: - object , x ∈ { - photoUrls - , - name - - } - - - - -

-
-
- -
-
-
- tags: - object - - -
-
- photoUrls: - object - - -
-
- category: - - Category - - - - -
-
- id: - object - - -
-
- name: - object - - -
-
- status: - object - - -
-
-
-
-
-
-
-

- Tag: - object - - - -

-
-
- -
-
-
- name: - string - - -
-
- id: - integer (int64) - - -
-
-
-
-
-
-
-

- User: - object - - - -

-
-
- -
-
-
- phone: - object - - -
-
- password: - object - - -
-
- email: - object - - -
-
- lastName: - object - - -
-
- firstName: - object - - -
-
- username: - object - - -
-
- id: - object - - -
-
- userStatus: - object - - -
-
-
-
-
-
+ +

Authentication

-
-
- Documentation by Spectacle +
+
+
+

+ basicAuth + +

+
+
+
+
description
+
+
+ HTTP Basic Authentication. Works over `HTTP` and `HTTPS` +
+
+
+ + +
+
+
+
+
+

+ api_key + +

+
+
+
+
name
+
+
+ api_key +
+
+
+
+
in
+
+
+ header +
+
+
+ + +
+
+
+
+
+
+

+ petstore_auth + +

+
+
+
+
authorizationUrl
+
+
+ http://swagger.io/api/oauth/dialog +
+
+
+
+
flow
+
+
+ implicit +
+
+
+
+
scopes
+
+
+ [object Object] +
+
+
+ + +
+
+
+

User

+ +
+ + +
+ User +
+ + + +

+
List of Accounts including Employer(s)
+

+ +
+
+
+ GET + /user/accounts +
+
+
+ +
+
+
+

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Accounts + +
+ +
+
+

An array of accounts

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+[
+  {
+    "account_type": "string",
+    "acount_id": "integer",
+    "display_name": "string",
+    "icon_url": "string"
+  }
+]
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + UserProfile + +
+
+
+ +

accepts any users data to be updated.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
api_key +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user/password +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ + +
+
+
+
new_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+
old_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User password updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
+ GET + /user/login +
+

+ + + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid username/password supplied

+ +
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
basicAuth +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Accept Employer
+

+ +
+
+
+ GET + /employee/accept-employer/{employer_id} +
+
+
+ +
+
+
+

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) + 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
response
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

User's accepted

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid email/password supplied

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
logout user
+

+ +
+
+
+ GET + /user/logout +
+
+
+ +
+
+
+

Logs out current logged in user session + *Page 3_Account (part3)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+
+

successful operation

+ +
+
+
+
+
+
+
+

Employer

+ +
+ + +
+ Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /employer/{employer_id} +
+
+
+ +
+
+
+

Employer profile. + *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerOwnProfile + +
+ +
+
+

Profile information for an employer

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employer +
+ + + +

+
Update Employer Data
+

+ +
+
+
+ PUT + /employer/{employer_id} +
+
+
+ +
+
+
+

This updates individual or group of employer's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + EmployerOwnProfile + +
+
+
+ +

Unique employer identifier to be used for fetching specific employer profile data.

+ + +
+
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employer update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Employee List by Location
+

+ +
+
+
+ GET + /employer/employees/listbylocation/{employer_id}/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+
+
+
+
+

PayApp Payroll System

+
-
-
- +
Schemes: + http, https +
+ +
Version: + 1.0.0 +
+ +
+
+ + +

Authentication

+ +
+
+
+

+ basicAuth + +

+
+
+
+
description
+
+
+ HTTP Basic Authentication. Works over `HTTP` and `HTTPS` +
+
+
+ + +
+
+
+
+
+
+

+ api_key + +

+
+
+
+
name
+
+
+ api_key +
+
+
+
+
in
+
+
+ header +
+
+
+ + +
+
+
+
+
+
+

+ petstore_auth + +

+
+
+
+
authorizationUrl
+
+
+ http://swagger.io/api/oauth/dialog +
+
+
+
+
flow
+
+
+ implicit +
+
+
+
+
scopes
+
+
+ [object Object] +
+
+
+ + +
+
+
+

User

+ +
+ + +
+ User +
+ + + +

+
List of Accounts including Employer(s)
+

+ +
+
+
+ GET + /user/accounts +
+
+
+ +
+
+
+

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Accounts + +
+ +
+
+

An array of accounts

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+[
+  {
+    "account_type": "string",
+    "acount_id": "integer",
+    "display_name": "string",
+    "icon_url": "string"
+  }
+]
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + UserProfile + +
+
+
+ +

accepts any users data to be updated.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
api_key +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user/password +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ + +
+
+
+
new_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+
old_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User password updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
+ GET + /user/login +
+

+ + + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid username/password supplied

+ +
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
basicAuth +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Accept Employer
+

+ +
+
+
+ GET + /employee/accept-employer/{employer_id} +
+
+
+ +
+
+
+

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) + 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
response
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

User's accepted

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid email/password supplied

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
logout user
+

+ +
+
+
+ GET + /user/logout +
+
+
+ +
+
+
+

Logs out current logged in user session + *Page 3_Account (part3)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+
+

successful operation

+ +
+
+
+
+
+
+
+

Employer

+ +
+ + +
+ Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /employer/{employer_id} +
+
+
+ +
+
+
+

Employer profile. + *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerOwnProfile + +
+ +
+
+

Profile information for an employer

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employer +
+ + + +

+
Update Employer Data
+

+ +
+
+
+ PUT + /employer/{employer_id} +
+
+
+ +
+
+
+

This updates individual or group of employer's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + EmployerOwnProfile + +
+
+
+ +

Unique employer identifier to be used for fetching specific employer profile data.

+ + +
+
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employer update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Employee List by Location
+

+ +
+
+
+ GET + /employer/employees/listbylocation/{employer_id}/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /user/employer/employee-profile/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Role

+ +
+ + +
+ Role +
+ + + +

+
Employee Role List
+

+ +
+
+
+ GET + /employee/roles/{employee_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Role + +
+ +
+
+

Employee role list

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "role_id": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Add Employee Role
+

+ +
+
+
+ POST + /employee/role +
+
+
+ + +
+
+ +
+
+
+
+ + Role + +
+
+
+ +

accepts role page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee role added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Details
+

+ +
+
+
+ GET + /employee/role/{employee_role_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleDetails + +
+ +
+
+

Employee role details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "first_shift": "string",
+  "last_shift": "string",
+  "payroll_variations": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Variation Details
+

+ +
+
+
+ GET + /employee/role/variation/{employee_role_variation_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_variation_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleVariation + +
+ +
+
+

Employee role variation details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Add Employee Role Variation
+

+ +
+
+
+ POST + /employee/role/variation +
+
+
+ + +
+
+ +
+
+
+
+ + RoleVariation + +
+
+
+ +

accepts variation page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee role variation added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Variation List
+

+ +
+
+
+ GET + /employee/role/variations/{employee_role_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleVariation + +
+ +
+
+

Employee role details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Bank

+ +
+ + +
+ Bank +
+ + + +

+
List All User Bank
+

+ +
+
+
+ GET + /user/bank +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserBank + +
+ +
+
+

User Banks List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_id": "integer",
+  "created_at": "string",
+  "user_bank_bsb": "string",
+  "user_bank_id": "integer",
+  "user_bank_name": "string",
+  "user_bank_number": "string",
+  "user_bank_status": "string",
+  "user_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
Get User Bank
+

+ +
+
+
+ GET + /user/bank/{user_bank_id} +
+
+
+ + +
+
+ + +
+
+
+
user_bank_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserBank + +
+ +
+
+

User Bank Details

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_id": "integer",
+  "created_at": "string",
+  "user_bank_bsb": "string",
+  "user_bank_id": "integer",
+  "user_bank_name": "string",
+  "user_bank_number": "string",
+  "user_bank_status": "string",
+  "user_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
List All Bank
+

+ +
+
+
+ GET + /bank +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ Bank + +
+ +
+
+

Banks List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_description": "string",
+  "bank_fullname": "string",
+  "bank_iconurl": "string",
+  "bank_id": "integer",
+  "bank_name": "string",
+  "bank_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
Add User Bank Allotment
+

+ +
+
+
+ POST +
+
+
+
+
+
+
+

PayApp Payroll System

+ +
+
+
+
API Endpoint
+
+ 

+https://api.mytommy.com/api/v1
+
+
+ + +
Response Content-Types: + application/json +
+ +
Schemes: + http, https +
+ +
Version: + 1.0.0 +
+
+
+
+ + +

Authentication

+ +
+
+
+

+ basicAuth + +

+
+
+
+
description
+
+
+ HTTP Basic Authentication. Works over `HTTP` and `HTTPS` +
+
+
+ + +
+
+
+
+
+
+

+ api_key + +

+
+
+
+
name
+
+
+ api_key +
+
+
+
+
in
+
+
+ header +
+
+
+ + +
+
+
+
+
+
+

+ petstore_auth + +

+
+
+
+
authorizationUrl
+
+
+ http://swagger.io/api/oauth/dialog +
+
+
+
+
flow
+
+
+ implicit +
+
+
+
+
scopes
+
+
+ [object Object] +
+
+
+ + +
+
+
+

User

+ +
+ + +
+ User +
+ + + +

+
List of Accounts including Employer(s)
+

+ +
+
+
+ GET + /user/accounts +
+
+
+ +
+
+
+

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Accounts + +
+ +
+
+

An array of accounts

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+[
+  {
+    "account_type": "string",
+    "acount_id": "integer",
+    "display_name": "string",
+    "icon_url": "string"
+  }
+]
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + UserProfile + +
+
+
+ +

accepts any users data to be updated.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
api_key +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user/password +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ + +
+
+
+
new_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+
old_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User password updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
+ GET + /user/login +
+

+ + + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid username/password supplied

+ +
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
basicAuth +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Accept Employer
+

+ +
+
+
+ GET + /employee/accept-employer/{employer_id} +
+
+
+ +
+
+
+

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) + 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
response
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

User's accepted

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid email/password supplied

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
logout user
+

+ +
+
+
+ GET + /user/logout +
+
+
+ +
+
+
+

Logs out current logged in user session + *Page 3_Account (part3)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+
+

successful operation

+ +
+
+
+
+
+
+
+

Employer

+ +
+ + +
+ Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /employer/{employer_id} +
+
+
+ +
+
+
+

Employer profile. + *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerOwnProfile + +
+ +
+
+

Profile information for an employer

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employer +
+ + + +

+
Update Employer Data
+

+ +
+
+
+ PUT + /employer/{employer_id} +
+
+
+ +
+
+
+

This updates individual or group of employer's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + EmployerOwnProfile + +
+
+
+ +

Unique employer identifier to be used for fetching specific employer profile data.

+ + +
+
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employer update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Employee List by Location
+

+ +
+
+
+ GET + /employer/employees/listbylocation/{employer_id}/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /user/employer/employee-profile/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Role

+ +
+ + +
+ Role +
+ + + +

+
Employee Role List
+

+ +
+
+
+ GET + /employee/roles/{employee_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Role + +
+ +
+
+

Employee role list

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "role_id": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Add Employee Role
+

+ +
+
+
+ POST + /employee/role +
+
+
+ + +
+
+ +
+
+
+
+ + Role + +
+
+
+ +

accepts role page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee role added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Details
+

+ +
+
+
+ GET + /employee/role/{employee_role_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleDetails + +
+ +
+
+

Employee role details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "first_shift": "string",
+  "last_shift": "string",
+  "payroll_variations": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Variation Details
+

+ +
+
+
+ GET + /employee/role/variation/{employee_role_variation_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_variation_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleVariation + +
+ +
+
+

Employee role variation details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Add Employee Role Variation
+

+ +
+
+
+ POST + /employee/role/variation +
+
+
+ + +
+
+ +
+
+
+
+ + RoleVariation + +
+
+
+ +

accepts variation page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee role variation added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Variation List
+

+ +
+
+
+ GET + /employee/role/variations/{employee_role_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleVariation + +
+ +
+
+

Employee role details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Bank

+ +
+ + +
+ Bank +
+ + + +

+
List All User Bank
+

+ +
+
+
+ GET + /user/bank +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserBank + +
+ +
+
+

User Banks List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_id": "integer",
+  "created_at": "string",
+  "user_bank_bsb": "string",
+  "user_bank_id": "integer",
+  "user_bank_name": "string",
+  "user_bank_number": "string",
+  "user_bank_status": "string",
+  "user_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
Get User Bank
+

+ +
+
+
+ GET + /user/bank/{user_bank_id} +
+
+
+ + +
+
+ + +
+
+
+
user_bank_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserBank + +
+ +
+
+

User Bank Details

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_id": "integer",
+  "created_at": "string",
+  "user_bank_bsb": "string",
+  "user_bank_id": "integer",
+  "user_bank_name": "string",
+  "user_bank_number": "string",
+  "user_bank_status": "string",
+  "user_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
List All Bank
+

+ +
+
+
+ GET + /bank +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ Bank + +
+ +
+
+

Banks List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_description": "string",
+  "bank_fullname": "string",
+  "bank_iconurl": "string",
+  "bank_id": "integer",
+  "bank_name": "string",
+  "bank_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
Add User Bank Allotment
+

+ +
+
+
+ POST + /user/bank/allotment/{user_bank_id} +
+
+
+ + +
+
+ +
+
+
+
+ + BankAllotment + +
+
+
+ +

accepts user bank allotment data to be added.

+ + +
+
+
+ + +
+
+
+
user_bank_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employer_id": "integer",
+  "pay_type": "string",
+  "user_bank_allotment_fixed": "string",
+  "user_bank_allotment_id": "integer",
+  "user_bank_allotment_percent": "string",
+  "user_bank_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User Bank Allotment successfully added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

SuperFund

+ +
+ + +
+ SuperFund +
+ + + +

+
List All Superfund
+

+ +
+
+
+ GET + /superfund +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ SuperFund + +
+ +
+
+

SuportFund List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_description": "string",
+  "superfund_id": "integer",
+  "superfund_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
List All User SuperFund
+

+ +
+
+
+ GET + /user/superfund +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserSuperFund + +
+ +
+
+

List User superfund

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_number": "string",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
GetUser SuperFund Details
+

+ +
+
+
+ GET + /user/superfund/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserSuperFund + +
+ +
+
+

User superfund details

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_number": "string",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
List All Employer with SuperFund
+

+ +
+
+
+ GET + /user/superfund/employer/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserEmployerSuperFund + +
+ +
+
+

List Employer with superfund

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "employer_id": "integer",
+  "employer_name": "string",
+  "user_employer_superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
Remove User Employer SupportFund
+

+ +
+
+
+ POST + /user/superfund/employer/remove/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User Employer SuperFund successfully remove

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Payroll

+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay approval options
+

+ +
+
+
+ GET + /pay-approval-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Approval Day Frequency select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollApprovalOptions + +
+ +
+
+

Pay Approval Options List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_approval_id": "string",
+  "payroll_approval_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay interval options
+

+ +
+
+
+ GET + /pay-interval-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Interval select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollIntervalOptions + +
+ +
+
+

Pay Interval Options List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_interval_id": "string",
+  "payroll_interval_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay release options
+

+ +
+
+
+ GET + /pay-release-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Interval select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollReleaseOptions + +
+ +
+
+

Pay Interval Release List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_release_id": "string",
+  "payroll_release_name": "string"
+}
+
+
+
+
+
+
+

Entity

+ +
+ + +
+ Entity + Tax +
+ + + +

+
List all Tax entity Type
+

+ +
+
+
+ GET + /tax-entity-type-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxEntityTypeOptions + +
+ +
+
+

Tax Entity Type List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "tax_entity_id": "string",
+  "tax_entity_name": "string"
+}
+
+
+
+
+
+
+

Tax

+ +
+ + +
+ Entity + Tax +
+ + + +

+
List all Tax entity Type
+

+ +
+
+
+ GET + /tax-entity-type-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxEntityTypeOptions + +
+ +
+
+

Tax Entity Type List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "tax_entity_id": "string",
+  "tax_entity_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Reporting + Tax +
+ + + +

+
List all Tax Reporting Option
+

+ +
+
+
+ GET + /tax-reporting-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxReportingOptions + +
+ +
+
+

Tax Reporting Option

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "entity_type_id": "string",
+  "entity_type_name": "string"
+}
+
+
+
+
+
+
+

Reporting

+ +
+ + +
+ Reporting + Tax +
+ + + +

+
List all Tax Reporting Option
+

+ +
+
+
+ GET + /tax-reporting-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxReportingOptions + +
+ +
+
+

Tax Reporting Option

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "entity_type_id": "string",
+  "entity_type_name": "string"
+}
+
+
+
+
+
+
+

Employees

+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Employee List by Location
+

+ +
+
+
+ GET + /employer/employees/listbylocation/{employer_id}/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees +
+ + + +

+
Employer Empl

+
+
+
+
+
+
+

PayApp Payroll System

+ +
+
+
+
API Endpoint
+
+ 

+https://api.mytommy.com/api/v1
+
+
+ + +
Response Content-Types: + application/json +
+ +
Schemes: + http, https +
+ +
Version: + 1.0.0 +
+
+
+
+ + +

Authentication

+ +
+
+
+

+ basicAuth + +

+
+
+
+
description
+
+
+ HTTP Basic Authentication. Works over `HTTP` and `HTTPS` +
+
+
+ + +
+
+
+
+
+
+

+ api_key + +

+
+
+
+
name
+
+
+ api_key +
+
+
+
+
in
+
+
+ header +
+
+
+ + +
+
+
+
+
+
+

+ petstore_auth + +

+
+
+
+
authorizationUrl
+
+
+ http://swagger.io/api/oauth/dialog +
+
+
+
+
flow
+
+
+ implicit +
+
+
+
+
scopes
+
+
+ [object Object] +
+
+
+ + +
+
+
+

User

+ +
+ + +
+ User +
+ + + +

+
List of Accounts including Employer(s)
+

+ +
+
+
+ GET + /user/accounts +
+
+
+ +
+
+
+

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Accounts + +
+ +
+
+

An array of accounts

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+[
+  {
+    "account_type": "string",
+    "acount_id": "integer",
+    "display_name": "string",
+    "icon_url": "string"
+  }
+]
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + UserProfile + +
+
+
+ +

accepts any users data to be updated.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
api_key +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user/password +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ + +
+
+
+
new_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+
old_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User password updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
+ GET + /user/login +
+

+ + + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid username/password supplied

+ +
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
basicAuth +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Accept Employer
+

+ +
+
+
+ GET + /employee/accept-employer/{employer_id} +
+
+
+ +
+
+
+

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) + 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
response
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

User's accepted

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid email/password supplied

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
logout user
+

+ +
+
+
+ GET + /user/logout +
+
+
+ +
+
+
+

Logs out current logged in user session + *Page 3_Account (part3)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+
+

successful operation

+ +
+
+
+
+
+
+
+

Employer

+ +
+ + +
+ Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /employer/{employer_id} +
+
+
+ +
+
+
+

Employer profile. + *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerOwnProfile + +
+ +
+
+

Profile information for an employer

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employer +
+ + + +

+
Update Employer Data
+

+ +
+
+
+ PUT + /employer/{employer_id} +
+
+
+ +
+
+
+

This updates individual or group of employer's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + EmployerOwnProfile + +
+
+
+ +

Unique employer identifier to be used for fetching specific employer profile data.

+ + +
+
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employer update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Employee List by Location
+

+ +
+
+
+ GET + /employer/employees/listbylocation/{employer_id}/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /user/employer/employee-profile/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Role

+ +
+ + +
+ Role +
+ + + +

+
Employee Role List
+

+ +
+
+
+ GET + /employee/roles/{employee_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Role + +
+ +
+
+

Employee role list

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "role_id": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Add Employee Role
+

+ +
+
+
+ POST + /employee/role +
+
+
+ + +
+
+ +
+
+
+
+ + Role + +
+
+
+ +

accepts role page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee role added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Details
+

+ +
+
+
+ GET + /employee/role/{employee_role_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleDetails + +
+ +
+
+

Employee role details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "first_shift": "string",
+  "last_shift": "string",
+  "payroll_variations": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Variation Details
+

+ +
+
+
+ GET + /employee/role/variation/{employee_role_variation_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_variation_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleVariation + +
+ +
+
+

Employee role variation details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Add Employee Role Variation
+

+ +
+
+
+ POST + /employee/role/variation +
+
+
+ + +
+
+ +
+
+
+
+ + RoleVariation + +
+
+
+ +

accepts variation page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee role variation added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Variation List
+

+ +
+
+
+ GET + /employee/role/variations/{employee_role_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleVariation + +
+ +
+
+

Employee role details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Bank

+ +
+ + +
+ Bank +
+ + + +

+
List All User Bank
+

+ +
+
+
+ GET + /user/bank +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserBank + +
+ +
+
+

User Banks List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_id": "integer",
+  "created_at": "string",
+  "user_bank_bsb": "string",
+  "user_bank_id": "integer",
+  "user_bank_name": "string",
+  "user_bank_number": "string",
+  "user_bank_status": "string",
+  "user_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
Get User Bank
+

+ +
+
+
+ GET + /user/bank/{user_bank_id} +
+
+
+ + +
+
+ + +
+
+
+
user_bank_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserBank + +
+ +
+
+

User Bank Details

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_id": "integer",
+  "created_at": "string",
+  "user_bank_bsb": "string",
+  "user_bank_id": "integer",
+  "user_bank_name": "string",
+  "user_bank_number": "string",
+  "user_bank_status": "string",
+  "user_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
List All Bank
+

+ +
+
+
+ GET + /bank +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ Bank + +
+ +
+
+

Banks List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_description": "string",
+  "bank_fullname": "string",
+  "bank_iconurl": "string",
+  "bank_id": "integer",
+  "bank_name": "string",
+  "bank_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
Add User Bank Allotment
+

+ +
+
+
+ POST + /user/bank/allotment/{user_bank_id} +
+
+
+ + +
+
+ +
+
+
+
+ + BankAllotment + +
+
+
+ +

accepts user bank allotment data to be added.

+ + +
+
+
+ + +
+
+
+
user_bank_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employer_id": "integer",
+  "pay_type": "string",
+  "user_bank_allotment_fixed": "string",
+  "user_bank_allotment_id": "integer",
+  "user_bank_allotment_percent": "string",
+  "user_bank_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User Bank Allotment successfully added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

SuperFund

+ +
+ + +
+ SuperFund +
+ + + +

+
List All Superfund
+

+ +
+
+
+ GET + /superfund +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ SuperFund + +
+ +
+
+

SuportFund List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_description": "string",
+  "superfund_id": "integer",
+  "superfund_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
List All User SuperFund
+

+ +
+
+
+ GET + /user/superfund +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserSuperFund + +
+ +
+
+

List User superfund

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_number": "string",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
GetUser SuperFund Details
+

+ +
+
+
+ GET + /user/superfund/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserSuperFund + +
+ +
+
+

User superfund details

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_number": "string",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
List All Employer with SuperFund
+

+ +
+
+
+ GET + /user/superfund/employer/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserEmployerSuperFund + +
+ +
+
+

List Employer with superfund

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "employer_id": "integer",
+  "employer_name": "string",
+  "user_employer_superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
Remove User Employer SupportFund
+

+ +
+
+
+ POST + /user/superfund/employer/remove/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User Employer SuperFund successfully remove

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Payroll

+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay approval options
+

+ +
+
+
+ GET + /pay-approval-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Approval Day Frequency select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollApprovalOptions + +
+ +
+
+

Pay Approval Options List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_approval_id": "string",
+  "payroll_approval_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay interval options
+

+ +
+
+
+ GET + /pay-interval-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Interval select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollIntervalOptions + +
+ +
+
+

Pay Interval Options List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_interval_id": "string",
+  "payroll_interval_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay release options
+

+ +
+
+
+ GET + /pay-release-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Interval select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollReleaseOptions + +
+ +
+
+

Pay Interval Release List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_release_id": "string",
+  "payroll_release_name": "string"
+}
+
+
+
+
+
+
+

Entity

+ +
+ + +
+ Entity + Tax +
+ + + +

+
List all Tax entity Type
+

+ +
+
+
+ GET + /tax-entity-type-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxEntityTypeOptions + +
+ +
+
+

Tax Entity Type List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "tax_entity_id": "string",
+  "tax_entity_name": "string"
+}
+
+
+
+
+
+
+

Tax

+ +
+ + +
+ Entity + Tax +
+ + + +

+
List all Tax entity Type
+

+ +
+
+
+ GET + /tax-entity-type-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxEntityTypeOptions + +
+ +
+
+

Tax Entity Type List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "tax_entity_id": "string",
+  "tax_entity_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Reporting + Tax +
+ + + +

+
List all Tax Reporting Option
+

+ +
+
+
+ GET + /tax-reporting-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxReportingOptions + +
+ +
+
+

Tax Reporting Option

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "entity_type_id": "string",
+  "entity_type_name": "string"
+}
+
+
+
+
+
+
+

Reporting

+ +
+ + +
+ Reporting + Tax +
+ + + +

+
List all Tax Reporting Option
+

+ +
+
+
+ GET + /tax-reporting-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxReportingOptions + +
+ +
+
+

Tax Reporting Option

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "entity_type_id": "string",
+  "entity_type_name": "string"
+}
+
+
+
+
+
+
+

Employees

+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Employee List by Location
+

+ +
+
+
+ GET + /employer/employees/listbylocation/{employer_id}/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees +
+ + + +

+
Employer Employee List
+

+ +
+
+
+ GET + /employer/employees +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /user/employer/employee-profile/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Employee

+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile
+

+ +
+
+
+ GET + /employee/{employee_id} +
+
+
+ +
+
+
+

E_Employee-Profile (part1)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

employee profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile Availability
+

+ +
+
+
+ GET + /employee/unavailability/{employee_id}/{date_start}/{date_end} +
+
+
+ +
+
+
+

E_Employee-Profile_Availability (Calendar View - date clicked)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Unavailability + +
+ +
+
+

employee unavailability within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_unavailability_date_endv": "string",
+  "employee_unavailability_date_start": "string",
+  "employee_unavailability_fullday": "boolean",
+  "employee_unavailability_id": "integer",
+  "employee_unavailability_special_day": "string",
+  "notes": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile Shifts
+

+ +
+
+
+ GET + /employee/shift/{employee_id}/{date_start}/{date_end} +
+
+
+ +
+
+
+

E_Employee-Profile_Shifts (calendar view – clicked) + E_Employee-Profile_Shifts (List View)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployeeShifts + +
+ +
+
+

employee shifts within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employer_id": "integer",
+  "employer_shift_assigned_id": "integer",
+  "end_date": "object",
+  "location_id": "integer",
+  "note": "string",
+  "role_id": "integer",
+  "start_date": "object"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Unavailability

+ +
+ + +
+ Unavailability +
+ + + +

+
Add Employee Unavailability
+

+ +
+
+
+ POST + /employee/unavailability +
+
+
+ +
+
+
+

E_Employee-Profile_Availability (Calendar View - date clicked)

+ +
+
+
+ +
+
+ +
+
+
+
+ + Unavailability + +
+
+
+ +

accepts unavailability form data.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_unavailability_date_endv": "string",
+  "employee_unavailability_date_start": "string",
+  "employee_unavailability_fullday": "boolean",
+  "employee_unavailability_id": "integer",
+  "employee_unavailability_special_day": "string",
+  "notes": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Unavailability added successfully

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Unavailability +
+ + + +

+
Delete Employee Unavailability
+

+ +
+
+
+ DELETE + /employee/unavailability/{employee_unavailability_id} +
+
+
+ +
+
+
+

E_Employee-Profile_Availability_Edit (Delete confirmation)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_unavailability_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Unavailability deleted successfully

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Shift

+ +
+ + +
+ Shift +
+ + + +

+
Employe Shifts
+

+ +
+
+
+ GET + /employer/shiftbylocation/calendar/{employer_id}/{location_id}/{date_start}/{date_end} +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerShiftsMonth + +
+ +
+
+

employer shifts count within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "count": "integer",
+  "date": "object",
+  "employer_shift_id": "integer",
+  "publish": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Employe Shifts
+

+ +
+
+
+ GET + /employer/shiftbylocation/list/{employer_id}/{location_id}/{date_start}/{date_end} +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
+
+
+
+

PayApp Payroll System

+ +
+
+
+
API Endpoint
+
+ 

+https://api.mytommy.com/api/v1
+
+
+ + +
Response Content-Types: + application/json +
+ +
Schemes: + http, https +
+ +
Version: + 1.0.0 +
+
+
+
+ + +

Authentication

+ +
+
+
+

+ basicAuth + +

+
+
+
+
description
+
+
+ HTTP Basic Authentication. Works over `HTTP` and `HTTPS` +
+
+
+ + +
+
+
+
+
+
+

+ api_key + +

+
+
+
+
name
+
+
+ api_key +
+
+
+
+
in
+
+
+ header +
+
+
+ + +
+
+
+
+
+
+

+ petstore_auth + +

+
+
+
+
authorizationUrl
+
+
+ http://swagger.io/api/oauth/dialog +
+
+
+
+
flow
+
+
+ implicit +
+
+
+
+
scopes
+
+
+ [object Object] +
+
+
+ + +
+
+
+

User

+ +
+ + +
+ User +
+ + + +

+
List of Accounts including Employer(s)
+

+ +
+
+
+ GET + /user/accounts +
+
+
+ +
+
+
+

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Accounts + +
+ +
+
+

An array of accounts

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+[
+  {
+    "account_type": "string",
+    "acount_id": "integer",
+    "display_name": "string",
+    "icon_url": "string"
+  }
+]
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + UserProfile + +
+
+
+ +

accepts any users data to be updated.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
api_key +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user/password +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ + +
+
+
+
new_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+
old_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User password updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
+ GET + /user/login +
+

+ + + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid username/password supplied

+ +
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
basicAuth +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Accept Employer
+

+ +
+
+
+ GET + /employee/accept-employer/{employer_id} +
+
+
+ +
+
+
+

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) + 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
response
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

User's accepted

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid email/password supplied

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
logout user
+

+ +
+
+
+ GET + /user/logout +
+
+
+ +
+
+
+

Logs out current logged in user session + *Page 3_Account (part3)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+
+

successful operation

+ +
+
+
+
+
+
+
+

Employer

+ +
+ + +
+ Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /employer/{employer_id} +
+
+
+ +
+
+
+

Employer profile. + *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerOwnProfile + +
+ +
+
+

Profile information for an employer

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employer +
+ + + +

+
Update Employer Data
+

+ +
+
+
+ PUT + /employer/{employer_id} +
+
+
+ +
+
+
+

This updates individual or group of employer's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + EmployerOwnProfile + +
+
+
+ +

Unique employer identifier to be used for fetching specific employer profile data.

+ + +
+
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employer update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Employee List by Location
+

+ +
+
+
+ GET + /employer/employees/listbylocation/{employer_id}/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /user/employer/employee-profile/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Role

+ +
+ + +
+ Role +
+ + + +

+
Employee Role List
+

+ +
+
+
+ GET + /employee/roles/{employee_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Role + +
+ +
+
+

Employee role list

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "role_id": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Add Employee Role
+

+ +
+
+
+ POST + /employee/role +
+
+
+ + +
+
+ +
+
+
+
+ + Role + +
+
+
+ +

accepts role page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee role added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Details
+

+ +
+
+
+ GET + /employee/role/{employee_role_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleDetails + +
+ +
+
+

Employee role details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "first_shift": "string",
+  "last_shift": "string",
+  "payroll_variations": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Variation Details
+

+ +
+
+
+ GET + /employee/role/variation/{employee_role_variation_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_variation_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleVariation + +
+ +
+
+

Employee role variation details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Add Employee Role Variation
+

+ +
+
+
+ POST + /employee/role/variation +
+
+
+ + +
+
+ +
+
+
+
+ + RoleVariation + +
+
+
+ +

accepts variation page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee role variation added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Variation List
+

+ +
+
+
+ GET + /employee/role/variations/{employee_role_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleVariation + +
+ +
+
+

Employee role details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Bank

+ +
+ + +
+ Bank +
+ + + +

+
List All User Bank
+

+ +
+
+
+ GET + /user/bank +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserBank + +
+ +
+
+

User Banks List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_id": "integer",
+  "created_at": "string",
+  "user_bank_bsb": "string",
+  "user_bank_id": "integer",
+  "user_bank_name": "string",
+  "user_bank_number": "string",
+  "user_bank_status": "string",
+  "user_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
Get User Bank
+

+ +
+
+
+ GET + /user/bank/{user_bank_id} +
+
+
+ + +
+
+ + +
+
+
+
user_bank_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserBank + +
+ +
+
+

User Bank Details

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_id": "integer",
+  "created_at": "string",
+  "user_bank_bsb": "string",
+  "user_bank_id": "integer",
+  "user_bank_name": "string",
+  "user_bank_number": "string",
+  "user_bank_status": "string",
+  "user_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
List All Bank
+

+ +
+
+
+ GET + /bank +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ Bank + +
+ +
+
+

Banks List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_description": "string",
+  "bank_fullname": "string",
+  "bank_iconurl": "string",
+  "bank_id": "integer",
+  "bank_name": "string",
+  "bank_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
Add User Bank Allotment
+

+ +
+
+
+ POST + /user/bank/allotment/{user_bank_id} +
+
+
+ + +
+
+ +
+
+
+
+ + BankAllotment + +
+
+
+ +

accepts user bank allotment data to be added.

+ + +
+
+
+ + +
+
+
+
user_bank_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employer_id": "integer",
+  "pay_type": "string",
+  "user_bank_allotment_fixed": "string",
+  "user_bank_allotment_id": "integer",
+  "user_bank_allotment_percent": "string",
+  "user_bank_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User Bank Allotment successfully added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

SuperFund

+ +
+ + +
+ SuperFund +
+ + + +

+
List All Superfund
+

+ +
+
+
+ GET + /superfund +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ SuperFund + +
+ +
+
+

SuportFund List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_description": "string",
+  "superfund_id": "integer",
+  "superfund_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
List All User SuperFund
+

+ +
+
+
+ GET + /user/superfund +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserSuperFund + +
+ +
+
+

List User superfund

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_number": "string",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
GetUser SuperFund Details
+

+ +
+
+
+ GET + /user/superfund/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserSuperFund + +
+ +
+
+

User superfund details

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_number": "string",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
List All Employer with SuperFund
+

+ +
+
+
+ GET + /user/superfund/employer/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserEmployerSuperFund + +
+ +
+
+

List Employer with superfund

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "employer_id": "integer",
+  "employer_name": "string",
+  "user_employer_superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
Remove User Employer SupportFund
+

+ +
+
+
+ POST + /user/superfund/employer/remove/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User Employer SuperFund successfully remove

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Payroll

+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay approval options
+

+ +
+
+
+ GET + /pay-approval-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Approval Day Frequency select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollApprovalOptions + +
+ +
+
+

Pay Approval Options List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_approval_id": "string",
+  "payroll_approval_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay interval options
+

+ +
+
+
+ GET + /pay-interval-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Interval select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollIntervalOptions + +
+ +
+
+

Pay Interval Options List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_interval_id": "string",
+  "payroll_interval_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay release options
+

+ +
+
+
+ GET + /pay-release-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Interval select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollReleaseOptions + +
+ +
+
+

Pay Interval Release List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_release_id": "string",
+  "payroll_release_name": "string"
+}
+
+
+
+
+
+
+

Entity

+ +
+ + +
+ Entity + Tax +
+ + + +

+
List all Tax entity Type
+

+ +
+
+
+ GET + /tax-entity-type-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxEntityTypeOptions + +
+ +
+
+

Tax Entity Type List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "tax_entity_id": "string",
+  "tax_entity_name": "string"
+}
+
+
+
+
+
+
+

Tax

+ +
+ + +
+ Entity + Tax +
+ + + +

+
List all Tax entity Type
+

+ +
+
+
+ GET + /tax-entity-type-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxEntityTypeOptions + +
+ +
+
+

Tax Entity Type List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "tax_entity_id": "string",
+  "tax_entity_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Reporting + Tax +
+ + + +

+
List all Tax Reporting Option
+

+ +
+
+
+ GET + /tax-reporting-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxReportingOptions + +
+ +
+
+

Tax Reporting Option

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "entity_type_id": "string",
+  "entity_type_name": "string"
+}
+
+
+
+
+
+
+

Reporting

+ +
+ + +
+ Reporting + Tax +
+ + + +

+
List all Tax Reporting Option
+

+ +
+
+
+ GET + /tax-reporting-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxReportingOptions + +
+ +
+
+

Tax Reporting Option

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "entity_type_id": "string",
+  "entity_type_name": "string"
+}
+
+
+
+
+
+
+

Employees

+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Employee List by Location
+

+ +
+
+
+ GET + /employer/employees/listbylocation/{employer_id}/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees +
+ + + +

+
Employer Employee List
+

+ +
+
+
+ GET + /employer/employees +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /user/employer/employee-profile/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Employee

+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile
+

+ +
+
+
+ GET + /employee/{employee_id} +
+
+
+ +
+
+
+

E_Employee-Profile (part1)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

employee profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile Availability
+

+ +
+
+
+ GET + /employee/unavailability/{employee_id}/{date_start}/{date_end} +
+
+
+ +
+
+
+

E_Employee-Profile_Availability (Calendar View - date clicked)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Unavailability + +
+ +
+
+

employee unavailability within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_unavailability_date_endv": "string",
+  "employee_unavailability_date_start": "string",
+  "employee_unavailability_fullday": "boolean",
+  "employee_unavailability_id": "integer",
+  "employee_unavailability_special_day": "string",
+  "notes": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile Shifts
+

+ +
+
+
+ GET + /employee/shift/{employee_id}/{date_start}/{date_end} +
+
+
+ +
+
+
+

E_Employee-Profile_Shifts (calendar view – clicked) + E_Employee-Profile_Shifts (List View)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployeeShifts + +
+ +
+
+

employee shifts within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employer_id": "integer",
+  "employer_shift_assigned_id": "integer",
+  "end_date": "object",
+  "location_id": "integer",
+  "note": "string",
+  "role_id": "integer",
+  "start_date": "object"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Unavailability

+ +
+ + +
+ Unavailability +
+ + + +

+
Add Employee Unavailability
+

+ +
+
+
+ POST + /employee/unavailability +
+
+
+ +
+
+
+

E_Employee-Profile_Availability (Calendar View - date clicked)

+ +
+
+
+ +
+
+ +
+
+
+
+ + Unavailability + +
+
+
+ +

accepts unavailability form data.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_unavailability_date_endv": "string",
+  "employee_unavailability_date_start": "string",
+  "employee_unavailability_fullday": "boolean",
+  "employee_unavailability_id": "integer",
+  "employee_unavailability_special_day": "string",
+  "notes": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Unavailability added successfully

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Unavailability +
+ + + +

+
Delete Employee Unavailability
+

+ +
+
+
+ DELETE + /employee/unavailability/{employee_unavailability_id} +
+
+
+ +
+
+
+

E_Employee-Profile_Availability_Edit (Delete confirmation)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_unavailability_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Unavailability deleted successfully

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Shift

+ +
+ + +
+ Shift +
+ + + +

+
Employe Shifts
+

+ +
+
+
+ GET + /employer/shiftbylocation/calendar/{employer_id}/{location_id}/{date_start}/{date_end} +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerShiftsMonth + +
+ +
+
+

employer shifts count within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "count": "integer",
+  "date": "object",
+  "employer_shift_id": "integer",
+  "publish": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Employe Shifts
+

+ +
+
+
+ GET + /employer/shiftbylocation/list/{employer_id}/{location_id}/{date_start}/{date_end} +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerShifts + +
+ +
+
+

employer shifts count within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employer_id": "integer",
+  "employer_shift_id": "integer",
+  "employer_shift_repeat": "boolean",
+  "employer_shift_time_end": "string",
+  "employer_shift_time_start": "string",
+  "location_id": "integer",
+  "notes": "string",
+  "role_id": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Publish Employer Shifts
+

+ +
+
+
+ PUT + /shift/publish +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

shift published

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Employer Shift Update
+

+ +
+
+
+ PUT + /shift/{employer_shift_id} +
+
+
+ + +
+
+ +
+
+
+
+ + EmployerShifts + +
+
+
+ +

accepts shift form data.

+ + +
+
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employer_id": "integer",
+  "employer_shift_id": "integer",
+  "employer_shift_repeat": "boolean",
+  "employer_shift_time_end": "string",
+  "employer_shift_time_start": "string",
+  "location_id": "integer",
+  "notes": "string",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

shift details updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Add Employer Shift
+

+ +
+
+
+ POST + /shift +
+
+
+ + +
+
+ +
+
+
+
+ + EmployerShifts + +
+
+
+ +

accepts shift form data.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "employer_id": "integer",
+  "employer_shift_id": "integer",
+  "employer_shift_repeat": "boolean",
+  "employer_shift_time_end": "string",
+  "employer_shift_time_start": "string",
+  "location_id": "integer",
+  "notes": "string",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

shift added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Employee Shift
+

+ +
+
+
+ GET + /employee/shift/{employee_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployeeShift + +
+ +
+
+

shift added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employer_shift_assigned_id": "integer",
+  "role_name": "string",
+  "shift_current_time": "string",
+  "shift_status": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
List Employees Scheduled on this Shift
+

+ +
+
+
+ GET + /shift/scheduled/{employer_shift_id} +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

list of employees

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Add employee on shift
+

+ +
+
+
+ POST + /shift/add/employee/{employer_shift_id} +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

add employee to shift

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Remove employee on shift
+

+ +
+
+
+ DELETE + /shift/employee/{employer_shift_assigned_id}/ +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_assigned_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

employee removed

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Industry

+ +
+ + +
+ Industry +
+ + + +

+
List all industries
+

+ +
+
+
+ GET + /industry +
+
+
+ +
+
+
+

fetch industries, used in select/list + *Page 3_Account_EmployerProfile (Industry select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Industries + +
+ +
+
+

Industry Lists

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "industry_code": "string",
+  "industry_description": "string",
+  "industry_id": "string",
+  "industry_name": "string"
+}
+
+
+
+
+
+
+

Documents

+ +
+ + +
+ Documents +
+ + + +

+
Add new document
+

+ +
+
+
+ POST + /documents +
+
+
+ + +
+
+ +
+
+
+
+ + Documents + +
+
+
+ +

accepts document data to be added.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "user_document_expiry": "string",
+  "user_document_id": "integer",
+  "user_document_issuer": "string",
+  "user_document_name": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Document successfully added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
Edit document
+

+ +
+
+
+ PUT + /documents/{document_id} +
+
+
+ + +
+
+ +
+
+
+
+ + Documents + +
+
+
+ +

accepts document data to be edited.

+ + +
+
+
+ + +
+
+
+
document_id
+
+
+
+
+
+
+
+

PayApp Payroll System

+ +
+
+
+
API Endpoint
+
+ 

+https://api.mytommy.com/api/v1
+
+
+ + +
Response Content-Types: + application/json +
+ +
Schemes: + http, https +
+ +
Version: + 1.0.0 +
+
+
+
+ + +

Authentication

+ +
+
+
+

+ basicAuth + +

+
+
+
+
description
+
+
+ HTTP Basic Authentication. Works over `HTTP` and `HTTPS` +
+
+
+ + +
+
+
+
+
+
+

+ api_key + +

+
+
+
+
name
+
+
+ api_key +
+
+
+
+
in
+
+
+ header +
+
+
+ + +
+
+
+
+
+
+

+ petstore_auth + +

+
+
+
+
authorizationUrl
+
+
+ http://swagger.io/api/oauth/dialog +
+
+
+
+
flow
+
+
+ implicit +
+
+
+
+
scopes
+
+
+ [object Object] +
+
+
+ + +
+
+
+

User

+ +
+ + +
+ User +
+ + + +

+
List of Accounts including Employer(s)
+

+ +
+
+
+ GET + /user/accounts +
+
+
+ +
+
+
+

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Accounts + +
+ +
+
+

An array of accounts

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+[
+  {
+    "account_type": "string",
+    "acount_id": "integer",
+    "display_name": "string",
+    "icon_url": "string"
+  }
+]
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + UserProfile + +
+
+
+ +

accepts any users data to be updated.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
api_key +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user/password +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ + +
+
+
+
new_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+
old_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User password updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
+ GET + /user/login +
+

+ + + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid username/password supplied

+ +
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
basicAuth +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Accept Employer
+

+ +
+
+
+ GET + /employee/accept-employer/{employer_id} +
+
+
+ +
+
+
+

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) + 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
response
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

User's accepted

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid email/password supplied

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
logout user
+

+ +
+
+
+ GET + /user/logout +
+
+
+ +
+
+
+

Logs out current logged in user session + *Page 3_Account (part3)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+
+

successful operation

+ +
+
+
+
+
+
+
+

Employer

+ +
+ + +
+ Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /employer/{employer_id} +
+
+
+ +
+
+
+

Employer profile. + *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerOwnProfile + +
+ +
+
+

Profile information for an employer

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employer +
+ + + +

+
Update Employer Data
+

+ +
+
+
+ PUT + /employer/{employer_id} +
+
+
+ +
+
+
+

This updates individual or group of employer's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + EmployerOwnProfile + +
+
+
+ +

Unique employer identifier to be used for fetching specific employer profile data.

+ + +
+
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employer update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Employee List by Location
+

+ +
+
+
+ GET + /employer/employees/listbylocation/{employer_id}/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /user/employer/employee-profile/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Role

+ +
+ + +
+ Role +
+ + + +

+
Employee Role List
+

+ +
+
+
+ GET + /employee/roles/{employee_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Role + +
+ +
+
+

Employee role list

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "role_id": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Add Employee Role
+

+ +
+
+
+ POST + /employee/role +
+
+
+ + +
+
+ +
+
+
+
+ + Role + +
+
+
+ +

accepts role page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee role added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Details
+

+ +
+
+
+ GET + /employee/role/{employee_role_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleDetails + +
+ +
+
+

Employee role details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "first_shift": "string",
+  "last_shift": "string",
+  "payroll_variations": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Variation Details
+

+ +
+
+
+ GET + /employee/role/variation/{employee_role_variation_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_variation_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleVariation + +
+ +
+
+

Employee role variation details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Add Employee Role Variation
+

+ +
+
+
+ POST + /employee/role/variation +
+
+
+ + +
+
+ +
+
+
+
+ + RoleVariation + +
+
+
+ +

accepts variation page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee role variation added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Variation List
+

+ +
+
+
+ GET + /employee/role/variations/{employee_role_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleVariation + +
+ +
+
+

Employee role details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Bank

+ +
+ + +
+ Bank +
+ + + +

+
List All User Bank
+

+ +
+
+
+ GET + /user/bank +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserBank + +
+ +
+
+

User Banks List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_id": "integer",
+  "created_at": "string",
+  "user_bank_bsb": "string",
+  "user_bank_id": "integer",
+  "user_bank_name": "string",
+  "user_bank_number": "string",
+  "user_bank_status": "string",
+  "user_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
Get User Bank
+

+ +
+
+
+ GET + /user/bank/{user_bank_id} +
+
+
+ + +
+
+ + +
+
+
+
user_bank_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserBank + +
+ +
+
+

User Bank Details

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_id": "integer",
+  "created_at": "string",
+  "user_bank_bsb": "string",
+  "user_bank_id": "integer",
+  "user_bank_name": "string",
+  "user_bank_number": "string",
+  "user_bank_status": "string",
+  "user_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
List All Bank
+

+ +
+
+
+ GET + /bank +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ Bank + +
+ +
+
+

Banks List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_description": "string",
+  "bank_fullname": "string",
+  "bank_iconurl": "string",
+  "bank_id": "integer",
+  "bank_name": "string",
+  "bank_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
Add User Bank Allotment
+

+ +
+
+
+ POST + /user/bank/allotment/{user_bank_id} +
+
+
+ + +
+
+ +
+
+
+
+ + BankAllotment + +
+
+
+ +

accepts user bank allotment data to be added.

+ + +
+
+
+ + +
+
+
+
user_bank_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employer_id": "integer",
+  "pay_type": "string",
+  "user_bank_allotment_fixed": "string",
+  "user_bank_allotment_id": "integer",
+  "user_bank_allotment_percent": "string",
+  "user_bank_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User Bank Allotment successfully added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

SuperFund

+ +
+ + +
+ SuperFund +
+ + + +

+
List All Superfund
+

+ +
+
+
+ GET + /superfund +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ SuperFund + +
+ +
+
+

SuportFund List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_description": "string",
+  "superfund_id": "integer",
+  "superfund_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
List All User SuperFund
+

+ +
+
+
+ GET + /user/superfund +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserSuperFund + +
+ +
+
+

List User superfund

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_number": "string",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
GetUser SuperFund Details
+

+ +
+
+
+ GET + /user/superfund/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserSuperFund + +
+ +
+
+

User superfund details

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_number": "string",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
List All Employer with SuperFund
+

+ +
+
+
+ GET + /user/superfund/employer/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserEmployerSuperFund + +
+ +
+
+

List Employer with superfund

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "employer_id": "integer",
+  "employer_name": "string",
+  "user_employer_superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
Remove User Employer SupportFund
+

+ +
+
+
+ POST + /user/superfund/employer/remove/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User Employer SuperFund successfully remove

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Payroll

+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay approval options
+

+ +
+
+
+ GET + /pay-approval-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Approval Day Frequency select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollApprovalOptions + +
+ +
+
+

Pay Approval Options List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_approval_id": "string",
+  "payroll_approval_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay interval options
+

+ +
+
+
+ GET + /pay-interval-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Interval select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollIntervalOptions + +
+ +
+
+

Pay Interval Options List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_interval_id": "string",
+  "payroll_interval_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay release options
+

+ +
+
+
+ GET + /pay-release-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Interval select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollReleaseOptions + +
+ +
+
+

Pay Interval Release List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_release_id": "string",
+  "payroll_release_name": "string"
+}
+
+
+
+
+
+
+

Entity

+ +
+ + +
+ Entity + Tax +
+ + + +

+
List all Tax entity Type
+

+ +
+
+
+ GET + /tax-entity-type-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxEntityTypeOptions + +
+ +
+
+

Tax Entity Type List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "tax_entity_id": "string",
+  "tax_entity_name": "string"
+}
+
+
+
+
+
+
+

Tax

+ +
+ + +
+ Entity + Tax +
+ + + +

+
List all Tax entity Type
+

+ +
+
+
+ GET + /tax-entity-type-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxEntityTypeOptions + +
+ +
+
+

Tax Entity Type List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "tax_entity_id": "string",
+  "tax_entity_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Reporting + Tax +
+ + + +

+
List all Tax Reporting Option
+

+ +
+
+
+ GET + /tax-reporting-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxReportingOptions + +
+ +
+
+

Tax Reporting Option

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "entity_type_id": "string",
+  "entity_type_name": "string"
+}
+
+
+
+
+
+
+

Reporting

+ +
+ + +
+ Reporting + Tax +
+ + + +

+
List all Tax Reporting Option
+

+ +
+
+
+ GET + /tax-reporting-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxReportingOptions + +
+ +
+
+

Tax Reporting Option

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "entity_type_id": "string",
+  "entity_type_name": "string"
+}
+
+
+
+
+
+
+

Employees

+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Employee List by Location
+

+ +
+
+
+ GET + /employer/employees/listbylocation/{employer_id}/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees +
+ + + +

+
Employer Employee List
+

+ +
+
+
+ GET + /employer/employees +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /user/employer/employee-profile/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Employee

+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile
+

+ +
+
+
+ GET + /employee/{employee_id} +
+
+
+ +
+
+
+

E_Employee-Profile (part1)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

employee profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile Availability
+

+ +
+
+
+ GET + /employee/unavailability/{employee_id}/{date_start}/{date_end} +
+
+
+ +
+
+
+

E_Employee-Profile_Availability (Calendar View - date clicked)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Unavailability + +
+ +
+
+

employee unavailability within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_unavailability_date_endv": "string",
+  "employee_unavailability_date_start": "string",
+  "employee_unavailability_fullday": "boolean",
+  "employee_unavailability_id": "integer",
+  "employee_unavailability_special_day": "string",
+  "notes": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile Shifts
+

+ +
+
+
+ GET + /employee/shift/{employee_id}/{date_start}/{date_end} +
+
+
+ +
+
+
+

E_Employee-Profile_Shifts (calendar view – clicked) + E_Employee-Profile_Shifts (List View)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployeeShifts + +
+ +
+
+

employee shifts within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employer_id": "integer",
+  "employer_shift_assigned_id": "integer",
+  "end_date": "object",
+  "location_id": "integer",
+  "note": "string",
+  "role_id": "integer",
+  "start_date": "object"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Unavailability

+ +
+ + +
+ Unavailability +
+ + + +

+
Add Employee Unavailability
+

+ +
+
+
+ POST + /employee/unavailability +
+
+
+ +
+
+
+

E_Employee-Profile_Availability (Calendar View - date clicked)

+ +
+
+
+ +
+
+ +
+
+
+
+ + Unavailability + +
+
+
+ +

accepts unavailability form data.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_unavailability_date_endv": "string",
+  "employee_unavailability_date_start": "string",
+  "employee_unavailability_fullday": "boolean",
+  "employee_unavailability_id": "integer",
+  "employee_unavailability_special_day": "string",
+  "notes": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Unavailability added successfully

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Unavailability +
+ + + +

+
Delete Employee Unavailability
+

+ +
+
+
+ DELETE + /employee/unavailability/{employee_unavailability_id} +
+
+
+ +
+
+
+

E_Employee-Profile_Availability_Edit (Delete confirmation)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_unavailability_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Unavailability deleted successfully

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Shift

+ +
+ + +
+ Shift +
+ + + +

+
Employe Shifts
+

+ +
+
+
+ GET + /employer/shiftbylocation/calendar/{employer_id}/{location_id}/{date_start}/{date_end} +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerShiftsMonth + +
+ +
+
+

employer shifts count within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "count": "integer",
+  "date": "object",
+  "employer_shift_id": "integer",
+  "publish": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Employe Shifts
+

+ +
+
+
+ GET + /employer/shiftbylocation/list/{employer_id}/{location_id}/{date_start}/{date_end} +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerShifts + +
+ +
+
+

employer shifts count within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employer_id": "integer",
+  "employer_shift_id": "integer",
+  "employer_shift_repeat": "boolean",
+  "employer_shift_time_end": "string",
+  "employer_shift_time_start": "string",
+  "location_id": "integer",
+  "notes": "string",
+  "role_id": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Publish Employer Shifts
+

+ +
+
+
+ PUT + /shift/publish +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

shift published

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Employer Shift Update
+

+ +
+
+
+ PUT + /shift/{employer_shift_id} +
+
+
+ + +
+
+ +
+
+
+
+ + EmployerShifts + +
+
+
+ +

accepts shift form data.

+ + +
+
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employer_id": "integer",
+  "employer_shift_id": "integer",
+  "employer_shift_repeat": "boolean",
+  "employer_shift_time_end": "string",
+  "employer_shift_time_start": "string",
+  "location_id": "integer",
+  "notes": "string",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

shift details updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Add Employer Shift
+

+ +
+
+
+ POST + /shift +
+
+
+ + +
+
+ +
+
+
+
+ + EmployerShifts + +
+
+
+ +

accepts shift form data.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "employer_id": "integer",
+  "employer_shift_id": "integer",
+  "employer_shift_repeat": "boolean",
+  "employer_shift_time_end": "string",
+  "employer_shift_time_start": "string",
+  "location_id": "integer",
+  "notes": "string",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

shift added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Employee Shift
+

+ +
+
+
+ GET + /employee/shift/{employee_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployeeShift + +
+ +
+
+

shift added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employer_shift_assigned_id": "integer",
+  "role_name": "string",
+  "shift_current_time": "string",
+  "shift_status": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
List Employees Scheduled on this Shift
+

+ +
+
+
+ GET + /shift/scheduled/{employer_shift_id} +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

list of employees

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Add employee on shift
+

+ +
+
+
+ POST + /shift/add/employee/{employer_shift_id} +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

add employee to shift

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Remove employee on shift
+

+ +
+
+
+ DELETE + /shift/employee/{employer_shift_assigned_id}/ +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_assigned_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

employee removed

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Industry

+ +
+ + +
+ Industry +
+ + + +

+
List all industries
+

+ +
+
+
+ GET + /industry +
+
+
+ +
+
+
+

fetch industries, used in select/list + *Page 3_Account_EmployerProfile (Industry select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Industries + +
+ +
+
+

Industry Lists

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "industry_code": "string",
+  "industry_description": "string",
+  "industry_id": "string",
+  "industry_name": "string"
+}
+
+
+
+
+
+
+

Documents

+ +
+ + +
+ Documents +
+ + + +

+
Add new document
+

+ +
+
+
+ POST + /documents +
+
+
+ + +
+
+ +
+
+
+
+ + Documents + +
+
+
+ +

accepts document data to be added.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "user_document_expiry": "string",
+  "user_document_id": "integer",
+  "user_document_issuer": "string",
+  "user_document_name": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Document successfully added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
Edit document
+

+ +
+
+
+ PUT + /documents/{document_id} +
+
+
+ + +
+
+ +
+
+
+
+ + Documents + +
+
+
+ +

accepts document data to be edited.

+ + +
+
+
+ + +
+
+
+
document_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+[
+  {
+    "user_document_expiry": "string",
+    "user_document_id": "integer",
+    "user_document_issuer": "string",
+    "user_document_name": "string"
+  }
+]
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Documents + +
+ +
+
+

Document successfully updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "user_document_expiry": "string",
+  "user_document_id": "integer",
+  "user_document_issuer": "string",
+  "user_document_name": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
List document page
+

+ +
+
+
+ GET + /document-pages/{document_id} +
+
+
+ + +
+
+ + +
+
+
+
document_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ DocumentPages + +
+ +
+
+

Document Page List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "user_document_id": "string",
+  "user_document_page_id": "integer",
+  "user_document_page_url": "string",
+  "user_document_sort": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
List document shared
+

+ +
+
+
+ GET + /document/shared +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ DocumentShared + +
+ +
+
+

Document Page List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "employer_id": "string",
+  "user_document_id": "integer",
+  "user_document_share_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
Remove employer to document share
+

+ +
+
+
+ DELETE + /document/share/{document_id} +
+
+
+ + +
+
+ + +
+
+
+
document_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Document unshared successful

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
List all employee's documents
+

+ +
+
+
+ GET + /employee/documents/shared/{employee_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Documents + +
+ +
+
+

Employee document lists

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "user_document_expiry": "string",
+  "user_document_id": "integer",
+  "user_document_issuer": "string",
+  "user_document_name": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
Employee's document Details
+

+ +
+
+
+ GET + /employee/document/shared/{document_id} +
+
+
+ + +
+
+ + +
+
+
+
document_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Documents + +
+ +
+
+

Employee document details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "user_document_expiry": "string",
+  "user_document_id": "integer",
+  "user_document_issuer": "string",
+  "user_document_name": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Locations

+ +
+ + +
+ Locations +
+ + + +

+
Employee's list of locations
+

+ +
+
+
+ POST + /employee/locations/{employee_id} +
+
+
+ + +
+
+ +
+
+
+
+ + Locations + +
+
+
+ +

accepts locations page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_location_id": "integer",
+  "employee_location_name": "string",
+  "location_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee location added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Locations +
+ + + +

+
remove location from employee
+

+ +
+
+
+ DELETE + /employee/location/{employee_location_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Successfully remove employees locations

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Notes

+ +
+ + +
+ Notes +
+ + + +

+
Add Employee's notes
+

+ +
+
+
+ POST + /employee/notes/{employee_id} +
+
+
+ + +
+
+ +
+
+
+
+ + Note + +
+
+
+ +

accepts noted page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_notes": "string",
+  "employee_notes_id": "integer",
+  "employer_shift_id": "integer",
+  "location_id": "integer",
+  "to_user_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee notes added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Notes +
+ + + +

+
Delte employee's note
+

+ +
+
+
+ DELETE + /employee/note/{employee_notes_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_notes_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee note deleted

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ + +

Schema definitions

+ +
+

+ Accounts: + object + + + +

+
+
+ +
+
+
+ acount_id: + object + + +
+
+ display_name: + object + + +
+
+ icon_url: + object + + +
+
+ account_type: + object + + +
+
+
+
+
+
+
+

+ Bank: + object + + + +

+
+
+ +
+
+
+ bank_id: + object + + +
+
+ bank_status: + object + + +
+
+ bank_name: + object + + +
+
+ bank_fullname: + object + + +
+
+ bank_description: + object + + +
+
+ bank_iconurl: + object + + +
+
+
+
+
+
+
+

+ BankAllotment: + object + + + +

+
+
+ +
+
+
+ user_bank_allotment_id: + object + + +
+
+ user_bank_id: + object + + +
+
+ employer_id: + object + + +
+
+ user_bank_allotment_percent: + object + + +
+
+
+
+
+
+
+
+

PayApp Payroll System

+ +
+
+
+
API Endpoint
+
+ 

+https://api.mytommy.com/api/v1
+
+
+ + +
Response Content-Types: + application/json +
+ +
Schemes: + http, https +
+ +
Version: + 1.0.0 +
+
+
+
+ + +

Authentication

+ +
+
+
+

+ basicAuth + +

+
+
+
+
description
+
+
+ HTTP Basic Authentication. Works over `HTTP` and `HTTPS` +
+
+
+ + +
+
+
+
+
+
+

+ api_key + +

+
+
+
+
name
+
+
+ api_key +
+
+
+
+
in
+
+
+ header +
+
+
+ + +
+
+
+
+
+
+

+ petstore_auth + +

+
+
+
+
authorizationUrl
+
+
+ http://swagger.io/api/oauth/dialog +
+
+
+
+
flow
+
+
+ implicit +
+
+
+
+
scopes
+
+
+ [object Object] +
+
+
+ + +
+
+
+

User

+ +
+ + +
+ User +
+ + + +

+
List of Accounts including Employer(s)
+

+ +
+
+
+ GET + /user/accounts +
+
+
+ +
+
+
+

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Accounts + +
+ +
+
+

An array of accounts

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+[
+  {
+    "account_type": "string",
+    "acount_id": "integer",
+    "display_name": "string",
+    "icon_url": "string"
+  }
+]
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + UserProfile + +
+
+
+ +

accepts any users data to be updated.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
api_key +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user/password +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ + +
+
+
+
new_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+
old_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User password updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
+ GET + /user/login +
+

+ + + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid username/password supplied

+ +
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
basicAuth +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Accept Employer
+

+ +
+
+
+ GET + /employee/accept-employer/{employer_id} +
+
+
+ +
+
+
+

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) + 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
response
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

User's accepted

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid email/password supplied

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
logout user
+

+ +
+
+
+ GET + /user/logout +
+
+
+ +
+
+
+

Logs out current logged in user session + *Page 3_Account (part3)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+
+

successful operation

+ +
+
+
+
+
+
+
+

Employer

+ +
+ + +
+ Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /employer/{employer_id} +
+
+
+ +
+
+
+

Employer profile. + *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerOwnProfile + +
+ +
+
+

Profile information for an employer

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employer +
+ + + +

+
Update Employer Data
+

+ +
+
+
+ PUT + /employer/{employer_id} +
+
+
+ +
+
+
+

This updates individual or group of employer's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + EmployerOwnProfile + +
+
+
+ +

Unique employer identifier to be used for fetching specific employer profile data.

+ + +
+
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employer update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Employee List by Location
+

+ +
+
+
+ GET + /employer/employees/listbylocation/{employer_id}/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /user/employer/employee-profile/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Role

+ +
+ + +
+ Role +
+ + + +

+
Employee Role List
+

+ +
+
+
+ GET + /employee/roles/{employee_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Role + +
+ +
+
+

Employee role list

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "role_id": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Add Employee Role
+

+ +
+
+
+ POST + /employee/role +
+
+
+ + +
+
+ +
+
+
+
+ + Role + +
+
+
+ +

accepts role page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee role added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Details
+

+ +
+
+
+ GET + /employee/role/{employee_role_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleDetails + +
+ +
+
+

Employee role details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "first_shift": "string",
+  "last_shift": "string",
+  "payroll_variations": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Variation Details
+

+ +
+
+
+ GET + /employee/role/variation/{employee_role_variation_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_variation_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleVariation + +
+ +
+
+

Employee role variation details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Add Employee Role Variation
+

+ +
+
+
+ POST + /employee/role/variation +
+
+
+ + +
+
+ +
+
+
+
+ + RoleVariation + +
+
+
+ +

accepts variation page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee role variation added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Variation List
+

+ +
+
+
+ GET + /employee/role/variations/{employee_role_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleVariation + +
+ +
+
+

Employee role details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Bank

+ +
+ + +
+ Bank +
+ + + +

+
List All User Bank
+

+ +
+
+
+ GET + /user/bank +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserBank + +
+ +
+
+

User Banks List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_id": "integer",
+  "created_at": "string",
+  "user_bank_bsb": "string",
+  "user_bank_id": "integer",
+  "user_bank_name": "string",
+  "user_bank_number": "string",
+  "user_bank_status": "string",
+  "user_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
Get User Bank
+

+ +
+
+
+ GET + /user/bank/{user_bank_id} +
+
+
+ + +
+
+ + +
+
+
+
user_bank_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserBank + +
+ +
+
+

User Bank Details

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_id": "integer",
+  "created_at": "string",
+  "user_bank_bsb": "string",
+  "user_bank_id": "integer",
+  "user_bank_name": "string",
+  "user_bank_number": "string",
+  "user_bank_status": "string",
+  "user_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
List All Bank
+

+ +
+
+
+ GET + /bank +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ Bank + +
+ +
+
+

Banks List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_description": "string",
+  "bank_fullname": "string",
+  "bank_iconurl": "string",
+  "bank_id": "integer",
+  "bank_name": "string",
+  "bank_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
Add User Bank Allotment
+

+ +
+
+
+ POST + /user/bank/allotment/{user_bank_id} +
+
+
+ + +
+
+ +
+
+
+
+ + BankAllotment + +
+
+
+ +

accepts user bank allotment data to be added.

+ + +
+
+
+ + +
+
+
+
user_bank_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employer_id": "integer",
+  "pay_type": "string",
+  "user_bank_allotment_fixed": "string",
+  "user_bank_allotment_id": "integer",
+  "user_bank_allotment_percent": "string",
+  "user_bank_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User Bank Allotment successfully added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

SuperFund

+ +
+ + +
+ SuperFund +
+ + + +

+
List All Superfund
+

+ +
+
+
+ GET + /superfund +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ SuperFund + +
+ +
+
+

SuportFund List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_description": "string",
+  "superfund_id": "integer",
+  "superfund_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
List All User SuperFund
+

+ +
+
+
+ GET + /user/superfund +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserSuperFund + +
+ +
+
+

List User superfund

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_number": "string",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
GetUser SuperFund Details
+

+ +
+
+
+ GET + /user/superfund/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserSuperFund + +
+ +
+
+

User superfund details

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_number": "string",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
List All Employer with SuperFund
+

+ +
+
+
+ GET + /user/superfund/employer/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserEmployerSuperFund + +
+ +
+
+

List Employer with superfund

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "employer_id": "integer",
+  "employer_name": "string",
+  "user_employer_superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
Remove User Employer SupportFund
+

+ +
+
+
+ POST + /user/superfund/employer/remove/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User Employer SuperFund successfully remove

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Payroll

+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay approval options
+

+ +
+
+
+ GET + /pay-approval-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Approval Day Frequency select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollApprovalOptions + +
+ +
+
+

Pay Approval Options List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_approval_id": "string",
+  "payroll_approval_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay interval options
+

+ +
+
+
+ GET + /pay-interval-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Interval select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollIntervalOptions + +
+ +
+
+

Pay Interval Options List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_interval_id": "string",
+  "payroll_interval_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay release options
+

+ +
+
+
+ GET + /pay-release-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Interval select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollReleaseOptions + +
+ +
+
+

Pay Interval Release List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_release_id": "string",
+  "payroll_release_name": "string"
+}
+
+
+
+
+
+
+

Entity

+ +
+ + +
+ Entity + Tax +
+ + + +

+
List all Tax entity Type
+

+ +
+
+
+ GET + /tax-entity-type-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxEntityTypeOptions + +
+ +
+
+

Tax Entity Type List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "tax_entity_id": "string",
+  "tax_entity_name": "string"
+}
+
+
+
+
+
+
+

Tax

+ +
+ + +
+ Entity + Tax +
+ + + +

+
List all Tax entity Type
+

+ +
+
+
+ GET + /tax-entity-type-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxEntityTypeOptions + +
+ +
+
+

Tax Entity Type List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "tax_entity_id": "string",
+  "tax_entity_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Reporting + Tax +
+ + + +

+
List all Tax Reporting Option
+

+ +
+
+
+ GET + /tax-reporting-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxReportingOptions + +
+ +
+
+

Tax Reporting Option

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "entity_type_id": "string",
+  "entity_type_name": "string"
+}
+
+
+
+
+
+
+

Reporting

+ +
+ + +
+ Reporting + Tax +
+ + + +

+
List all Tax Reporting Option
+

+ +
+
+
+ GET + /tax-reporting-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxReportingOptions + +
+ +
+
+

Tax Reporting Option

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "entity_type_id": "string",
+  "entity_type_name": "string"
+}
+
+
+
+
+
+
+

Employees

+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Employee List by Location
+

+ +
+
+
+ GET + /employer/employees/listbylocation/{employer_id}/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees +
+ + + +

+
Employer Employee List
+

+ +
+
+
+ GET + /employer/employees +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /user/employer/employee-profile/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Employee

+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile
+

+ +
+
+
+ GET + /employee/{employee_id} +
+
+
+ +
+
+
+

E_Employee-Profile (part1)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

employee profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile Availability
+

+ +
+
+
+ GET + /employee/unavailability/{employee_id}/{date_start}/{date_end} +
+
+
+ +
+
+
+

E_Employee-Profile_Availability (Calendar View - date clicked)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Unavailability + +
+ +
+
+

employee unavailability within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_unavailability_date_endv": "string",
+  "employee_unavailability_date_start": "string",
+  "employee_unavailability_fullday": "boolean",
+  "employee_unavailability_id": "integer",
+  "employee_unavailability_special_day": "string",
+  "notes": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile Shifts
+

+ +
+
+
+ GET + /employee/shift/{employee_id}/{date_start}/{date_end} +
+
+
+ +
+
+
+

E_Employee-Profile_Shifts (calendar view – clicked) + E_Employee-Profile_Shifts (List View)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployeeShifts + +
+ +
+
+

employee shifts within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employer_id": "integer",
+  "employer_shift_assigned_id": "integer",
+  "end_date": "object",
+  "location_id": "integer",
+  "note": "string",
+  "role_id": "integer",
+  "start_date": "object"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Unavailability

+ +
+ + +
+ Unavailability +
+ + + +

+
Add Employee Unavailability
+

+ +
+
+
+ POST + /employee/unavailability +
+
+
+ +
+
+
+

E_Employee-Profile_Availability (Calendar View - date clicked)

+ +
+
+
+ +
+
+ +
+
+
+
+ + Unavailability + +
+
+
+ +

accepts unavailability form data.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_unavailability_date_endv": "string",
+  "employee_unavailability_date_start": "string",
+  "employee_unavailability_fullday": "boolean",
+  "employee_unavailability_id": "integer",
+  "employee_unavailability_special_day": "string",
+  "notes": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Unavailability added successfully

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Unavailability +
+ + + +

+
Delete Employee Unavailability
+

+ +
+
+
+ DELETE + /employee/unavailability/{employee_unavailability_id} +
+
+
+ +
+
+
+

E_Employee-Profile_Availability_Edit (Delete confirmation)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_unavailability_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Unavailability deleted successfully

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Shift

+ +
+ + +
+ Shift +
+ + + +

+
Employe Shifts
+

+ +
+
+
+ GET + /employer/shiftbylocation/calendar/{employer_id}/{location_id}/{date_start}/{date_end} +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerShiftsMonth + +
+ +
+
+

employer shifts count within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "count": "integer",
+  "date": "object",
+  "employer_shift_id": "integer",
+  "publish": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Employe Shifts
+

+ +
+
+
+ GET + /employer/shiftbylocation/list/{employer_id}/{location_id}/{date_start}/{date_end} +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerShifts + +
+ +
+
+

employer shifts count within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employer_id": "integer",
+  "employer_shift_id": "integer",
+  "employer_shift_repeat": "boolean",
+  "employer_shift_time_end": "string",
+  "employer_shift_time_start": "string",
+  "location_id": "integer",
+  "notes": "string",
+  "role_id": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Publish Employer Shifts
+

+ +
+
+
+ PUT + /shift/publish +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

shift published

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Employer Shift Update
+

+ +
+
+
+ PUT + /shift/{employer_shift_id} +
+
+
+ + +
+
+ +
+
+
+
+ + EmployerShifts + +
+
+
+ +

accepts shift form data.

+ + +
+
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employer_id": "integer",
+  "employer_shift_id": "integer",
+  "employer_shift_repeat": "boolean",
+  "employer_shift_time_end": "string",
+  "employer_shift_time_start": "string",
+  "location_id": "integer",
+  "notes": "string",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

shift details updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Add Employer Shift
+

+ +
+
+
+ POST + /shift +
+
+
+ + +
+
+ +
+
+
+
+ + EmployerShifts + +
+
+
+ +

accepts shift form data.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "employer_id": "integer",
+  "employer_shift_id": "integer",
+  "employer_shift_repeat": "boolean",
+  "employer_shift_time_end": "string",
+  "employer_shift_time_start": "string",
+  "location_id": "integer",
+  "notes": "string",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

shift added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Employee Shift
+

+ +
+
+
+ GET + /employee/shift/{employee_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployeeShift + +
+ +
+
+

shift added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employer_shift_assigned_id": "integer",
+  "role_name": "string",
+  "shift_current_time": "string",
+  "shift_status": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
List Employees Scheduled on this Shift
+

+ +
+
+
+ GET + /shift/scheduled/{employer_shift_id} +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

list of employees

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Add employee on shift
+

+ +
+
+
+ POST + /shift/add/employee/{employer_shift_id} +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

add employee to shift

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Remove employee on shift
+

+ +
+
+
+ DELETE + /shift/employee/{employer_shift_assigned_id}/ +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_assigned_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

employee removed

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Industry

+ +
+ + +
+ Industry +
+ + + +

+
List all industries
+

+ +
+
+
+ GET + /industry +
+
+
+ +
+
+
+

fetch industries, used in select/list + *Page 3_Account_EmployerProfile (Industry select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Industries + +
+ +
+
+

Industry Lists

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "industry_code": "string",
+  "industry_description": "string",
+  "industry_id": "string",
+  "industry_name": "string"
+}
+
+
+
+
+
+
+

Documents

+ +
+ + +
+ Documents +
+ + + +

+
Add new document
+

+ +
+
+
+ POST + /documents +
+
+
+ + +
+
+ +
+
+
+
+ + Documents + +
+
+
+ +

accepts document data to be added.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "user_document_expiry": "string",
+  "user_document_id": "integer",
+  "user_document_issuer": "string",
+  "user_document_name": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Document successfully added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
Edit document
+

+ +
+
+
+ PUT + /documents/{document_id} +
+
+
+ + +
+
+ +
+
+
+
+ + Documents + +
+
+
+ +

accepts document data to be edited.

+ + +
+
+
+ + +
+
+
+
document_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+[
+  {
+    "user_document_expiry": "string",
+    "user_document_id": "integer",
+    "user_document_issuer": "string",
+    "user_document_name": "string"
+  }
+]
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Documents + +
+ +
+
+

Document successfully updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "user_document_expiry": "string",
+  "user_document_id": "integer",
+  "user_document_issuer": "string",
+  "user_document_name": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
List document page
+

+ +
+
+
+ GET + /document-pages/{document_id} +
+
+
+ + +
+
+ + +
+
+
+
document_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ DocumentPages + +
+ +
+
+

Document Page List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "user_document_id": "string",
+  "user_document_page_id": "integer",
+  "user_document_page_url": "string",
+  "user_document_sort": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
List document shared
+

+ +
+
+
+ GET + /document/shared +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ DocumentShared + +
+ +
+
+

Document Page List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "employer_id": "string",
+  "user_document_id": "integer",
+  "user_document_share_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
Remove employer to document share
+

+ +
+
+
+ DELETE + /document/share/{document_id} +
+
+
+ + +
+
+ + +
+
+
+
document_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Document unshared successful

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
List all employee's documents
+

+ +
+
+
+ GET + /employee/documents/shared/{employee_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Documents + +
+ +
+
+

Employee document lists

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "user_document_expiry": "string",
+  "user_document_id": "integer",
+  "user_document_issuer": "string",
+  "user_document_name": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
Employee's document Details
+

+ +
+
+
+ GET + /employee/document/shared/{document_id} +
+
+
+ + +
+
+ + +
+
+
+
document_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Documents + +
+ +
+
+

Employee document details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "user_document_expiry": "string",
+  "user_document_id": "integer",
+  "user_document_issuer": "string",
+  "user_document_name": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Locations

+ +
+ + +
+ Locations +
+ + + +

+
Employee's list of locations
+

+ +
+
+
+ POST + /employee/locations/{employee_id} +
+
+
+ + +
+
+ +
+
+
+
+ + Locations + +
+
+
+ +

accepts locations page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_location_id": "integer",
+  "employee_location_name": "string",
+  "location_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee location added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Locations +
+ + + +

+
remove location from employee
+

+ +
+
+
+ DELETE + /employee/location/{employee_location_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Successfully remove employees locations

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Notes

+ +
+ + +
+ Notes +
+ + + +

+
Add Employee's notes
+

+ +
+
+
+ POST + /employee/notes/{employee_id} +
+
+
+ + +
+
+ +
+
+
+
+ + Note + +
+
+
+ +

accepts noted page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_notes": "string",
+  "employee_notes_id": "integer",
+  "employer_shift_id": "integer",
+  "location_id": "integer",
+  "to_user_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee notes added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Notes +
+ + + +

+
Delte employee's note
+

+ +
+
+
+ DELETE + /employee/note/{employee_notes_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_notes_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee note deleted

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ + +

Schema definitions

+ +
+

+ Accounts: + object + + + +

+
+
+ +
+
+
+ acount_id: + object + + +
+
+ display_name: + object + + +
+
+ icon_url: + object + + +
+
+ account_type: + object + + +
+
+
+
+
+
+
+

+ Bank: + object + + + +

+
+
+ +
+
+
+ bank_id: + object + + +
+
+ bank_status: + object + + +
+
+ bank_name: + object + + +
+
+ bank_fullname: + object + + +
+
+ bank_description: + object + + +
+
+ bank_iconurl: + object + + +
+
+
+
+
+
+
+

+ BankAllotment: + object + + + +

+
+
+ +
+
+
+ user_bank_allotment_id: + object + + +
+
+ user_bank_id: + object + + +
+
+ employer_id: + object + + +
+
+ user_bank_allotment_percent: + object + + +
+
+ user_bank_allotment_fixed: + object + + +
+
+ pay_type: + object + + +
+
+
+
+
+
+
+

+ DocumentPages: + object + + + +

+
+
+ +
+
+
+ user_document_page_id: + object + + +
+
+ user_document_page_url: + object + + +
+
+ user_document_sort: + object + + +
+
+ user_document_id: + object + + +
+
+
+
+
+
+
+

+ Documents: + object + + + +

+
+
+ +
+
+
+ user_document_id: + object + + +
+
+ user_document_name: + object + + +
+
+ user_document_issuer: + object + + +
+
+ user_document_expiry: + object + + +
+
+
+
+
+
+
+

+ DocumentShared: + object + + + +

+
+
+ +
+
+
+ user_document_share_id: + object + + +
+
+ user_document_id: + object + + +
+
+ employer_id: + object + + +
+
+
+
+
+
+
+

+ EmployeeShift: + object + + + +

+
+
+ +
+
+
+ user_id: + object + + +
+
+ employer_shift_assigned_id: + object + + +
+
+ role_name: + object + + +
+
+ shift_current_time: + object + + +
+
+ user_name_last: + object + + +
+
+ user_name_first: + object + + +
+
+ user_email: + object + + +
+
+ user_iconurl: + object + + +
+
+ user_phone: + object + + +
+
+ shift_status: + object + + +
+
+
+
+
+
+
+

+ EmployeeShifts: + object + + + +

+
+
+ +
+
+
+ employer_shift_assigned_id: + object + + +
+
+ employer_id: + object + + +
+
+ employee_id: + object + + +
+
+ location_id: + object + + +
+
+ role_id: + object + + +
+
+ start_date: + object + + +
+
+ end_date: + object + + +
+
+ note: + object + + +
+
+
+
+
+
+
+

+ EmployerAddress: + object + + + +

+
+
+ +
+
+
+ employer_address_line1: + string + + +
+
+

Employer current address line one

+ +
+
+ employer_address_line2: + string + + +
+
+

Employer current address line two

+ +
+
+ employer_address_city: + string + + +
+
+

Employer current city

+ +
+
+ employer_postcode: + string + + +
+
+

Employer current postcode

+ +
+
+ employer_state: + string + + +
+
+

Employer current state/province

+ +
+
+ country_id: + string + + +
+
+

Employer current country

+ +
+
+
+
+
+
+
+

+ EmployerOwnProfile: + object + + + +

+
+
+ +
+
+
+ employer_id: + object + + +
+
+ employer_business_name: + object + + +
+
+ employer_iconurl: + object + + +
+
+ user_name_last: + object + + +
+
+ user_name_first: + object + + +
+
+ employer_email: + object + + +
+
+ employer_phone: + object + + +
+
+ industry_id: + object + + +
+
+ employer_abn: + object + + +
+
+ employer_acn: + object + + +
+
+ employer_contact_email: + object + + +
+
+ employer_contact_name: + object + + +
+
+ payroll_interval_id: + object + + +
+
+ payroll_approval_id: + object + + +
+
+ payroll_release_id: + object + + +
+
+ tax_entity_id: + object + + +
+
+ tax_reporting_id: + object + + +
+
+ employer_tax_gst: + object + + +
+
+ employer_tax_payrolltax: + object + + +
+
+ address: + object + + +
+
+
+
+
+
+
+

+ EmployerShifts: + object + + + +

+
+
+ +
+
+
+ employer_shift_id: + object + + +
+
+ employer_id: + object + + +
+
+ location_id: + object + + +
+
+ role_id: + object + + +
+
+ employer_shift_time_start: + object + + +
+
+ employer_shift_time_end: + object + + +
+
+ employer_shift_repeat: + object + + +
+
+ notes: + object + + +
+
+
+
+
+
+
+

+ EmployerShiftsMonth: + object + + + +

+
+
+ +
+
+
+ employer_shift_id: + object + + +
+
+ date: + object + + +
+
+ count: + object + + +
+
+ publish: + object + + +
+
+
+
+
+
+
+

+ Error: + object + + + +

+
+
+ +
+
+
+ code: + object + + +
+
+ message: + object + + +
+
+ fields: + object + + +
+
+
+
+
+
+
+

+ Industries: + object + + + +

+
+
+ +
+
+
+ industry_id: + object + + +
+
+ industry_name: + object + + +
+
+ industry_code: + object + + +
+
+ industry_description: + object + + +
+
+
+
+
+
+
+

+ Locations: + object + + + +

+
+
+ +
+
+
+ location_id: + object + + +
+
+ employee_location_id: + object + + +
+
+ employee_location_name: + object + + +
+
+
+
+
+
+
+

+ Note: + object + + + +

+
+
+ +
+
+
+ employee_notes_id: + object + + +
+
+ employee_id: + object + + +
+
+ to_user_id: + object + + +
+
+ location_id: + object + + +
+
+ employer_shift_id: + object + + +
+
+ employee_notes: + object + + +
+
+
+
+
+
+
+

+ PayrollApprovalOptions: + object + + + +

+
+
+ +
+
+
+ payroll_approval_id: + object + + +
+
+ payroll_approval_name: + object + + +
+
+
+
+
+
+
+

+ PayrollIntervalOptions: + object + + + +

+
+
+ +
+
+
+ payroll_interval_id: + object + + +
+
+ payroll_interval_name: + object + + +
+
+
+
+
+
+
+

+ PayrollReleaseOptions: + object + + + +

+
+
+ +
+
+
+ payroll_release_id: + object + + +
+
+ payroll_release_name: + object + + +
+
+
+
+
+
+
+

+ Role: + object + + + +

+
+
+ +
+
+
+ employee_role_id: + object + + +
+
+ employee_id: + object + + +
+
+ role_id: + object + + +
+
+
+
+
+
+
+

+ RoleDetails: + object + + + +

+
+
+ +
+
+
+ employee_role_id: + object + + +
+
+ employee_id: + object + + +
+
+ last_shift: + object + + +
+
+ first_shift: + object + + +
+
+ payroll_variations: + object + + +
+
+
+
+
+
+
+

+ RoleVariation: + object + + + +

+
+
+ +
+
+
+ employee_role_variations_id: + object + + +
+
+ employee_role_id: + object + + +
+
+ variations_type: + object + + +
+
+ variations_value: + object + + +
+
+
+
+
+
+
+

+ SuperFund: + object + + + +

+
+
+ +
+
+
+ superfund_id: + object + + +
+
+ superfund_name: + object + + +
+
+ superfund_description: + object + + +
+
+
+
+
+
+
+

+ TaxEntityTypeOptions: + object + + + +

+
+
+ +
+
+
+ tax_entity_id: + object + + +
+
+ tax_entity_name: + object + + +
+
+
+
+
+
+
+

+ TaxReportingOptions: + object + + + +

+
+
+ +
+
+
+ entity_type_id: + object + + +
+
+ entity_type_name: + object + + +
+
+
+
+
+
+
+

+ Unavailability: + object + + + +

+
+
+ +
+
+
+ employee_unavailability_id: + object + + +
+
+ employee_unavailability_date_start: + object + + +
+
+ employee_unavailability_date_endv: + object + + +
+
+ employee_id: + object + + +
+
+ notes: + object + + +
+
+ employee_unavailability_special_day: + object + + +
+
+ employee_unavailability_fullday: + object + + +
+
+
+
+
+
+
+
+

PayApp Payroll System

+ +
+
+
+
API Endpoint
+
+ 

+https://api.mytommy.com/api/v1
+
+
+ + +
Response Content-Types: + application/json +
+ +
Schemes: + http, https +
+ +
Version: + 1.0.0 +
+
+
+
+ + +

Authentication

+ +
+
+
+

+ basicAuth + +

+
+
+
+
description
+
+
+ HTTP Basic Authentication. Works over `HTTP` and `HTTPS` +
+
+
+ + +
+
+
+
+
+
+

+ api_key + +

+
+
+
+
name
+
+
+ api_key +
+
+
+
+
in
+
+
+ header +
+
+
+ + +
+
+
+
+
+
+

+ petstore_auth + +

+
+
+
+
authorizationUrl
+
+
+ http://swagger.io/api/oauth/dialog +
+
+
+
+
flow
+
+
+ implicit +
+
+
+
+
scopes
+
+
+ [object Object] +
+
+
+ + +
+
+
+

User

+ +
+ + +
+ User +
+ + + +

+
List of Accounts including Employer(s)
+

+ +
+
+
+ GET + /user/accounts +
+
+
+ +
+
+
+

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Accounts + +
+ +
+
+

An array of accounts

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+[
+  {
+    "account_type": "string",
+    "acount_id": "integer",
+    "display_name": "string",
+    "icon_url": "string"
+  }
+]
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + UserProfile + +
+
+
+ +

accepts any users data to be updated.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
api_key +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Update User Data
+

+ +
+
+
+ PUT + /user/password +
+
+
+ +
+
+
+

This updates individual or group of user's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ + +
+
+
+
new_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+
old_password
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User password updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
+ GET + /user/login +
+

+ + + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid username/password supplied

+ +
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
basicAuth +
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
Accept Employer
+

+ +
+
+
+ GET + /employee/accept-employer/{employer_id} +
+
+
+ +
+
+
+

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) + 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
response
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

User's accepted

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid email/password supplied

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ User +
+ + + +

+
logout user
+

+ +
+
+
+ GET + /user/logout +
+
+
+ +
+
+
+

Logs out current logged in user session + *Page 3_Account (part3)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+
+

successful operation

+ +
+
+
+
+
+
+
+

Employer

+ +
+ + +
+ Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /employer/{employer_id} +
+
+
+ +
+
+
+

Employer profile. + *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerOwnProfile + +
+ +
+
+

Profile information for an employer

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employer +
+ + + +

+
Update Employer Data
+

+ +
+
+
+ PUT + /employer/{employer_id} +
+
+
+ +
+
+
+

This updates individual or group of employer's records + Pages 3_AccountEmployerProfile

+ +
+
+
+ +
+
+ +
+
+
+
+ + EmployerOwnProfile + +
+
+
+ +

Unique employer identifier to be used for fetching specific employer profile data.

+ + +
+
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "address": "array",
+  "employer_abn": "string",
+  "employer_acn": "string",
+  "employer_business_name": "string",
+  "employer_contact_email": "string",
+  "employer_contact_name": "string",
+  "employer_email": "string",
+  "employer_iconurl": "string",
+  "employer_id": "integer",
+  "employer_phone": "string",
+  "employer_tax_gst": "integer",
+  "employer_tax_payrolltax": "integer",
+  "industry_id": "string",
+  "payroll_approval_id": "integer",
+  "payroll_interval_id": "integer",
+  "payroll_release_id": "integer",
+  "tax_entity_id": "integer",
+  "tax_reporting_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employer update success

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Employee List by Location
+

+ +
+
+
+ GET + /employer/employees/listbylocation/{employer_id}/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /user/employer/employee-profile/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Role

+ +
+ + +
+ Role +
+ + + +

+
Employee Role List
+

+ +
+
+
+ GET + /employee/roles/{employee_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Role + +
+ +
+
+

Employee role list

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "role_id": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Add Employee Role
+

+ +
+
+
+ POST + /employee/role +
+
+
+ + +
+
+ +
+
+
+
+ + Role + +
+
+
+ +

accepts role page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee role added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Details
+

+ +
+
+
+ GET + /employee/role/{employee_role_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleDetails + +
+ +
+
+

Employee role details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_role_id": "integer",
+  "first_shift": "string",
+  "last_shift": "string",
+  "payroll_variations": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Variation Details
+

+ +
+
+
+ GET + /employee/role/variation/{employee_role_variation_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_variation_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleVariation + +
+ +
+
+

Employee role variation details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Add Employee Role Variation
+

+ +
+
+
+ POST + /employee/role/variation +
+
+
+ + +
+
+ +
+
+
+
+ + RoleVariation + +
+
+
+ +

accepts variation page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee role variation added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Role +
+ + + +

+
Get Employee Role Variation List
+

+ +
+
+
+ GET + /employee/role/variations/{employee_role_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_role_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ RoleVariation + +
+ +
+
+

Employee role details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_role_id": "integer",
+  "employee_role_variations_id": "integer",
+  "variations_type": "string",
+  "variations_value": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Bank

+ +
+ + +
+ Bank +
+ + + +

+
List All User Bank
+

+ +
+
+
+ GET + /user/bank +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserBank + +
+ +
+
+

User Banks List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_id": "integer",
+  "created_at": "string",
+  "user_bank_bsb": "string",
+  "user_bank_id": "integer",
+  "user_bank_name": "string",
+  "user_bank_number": "string",
+  "user_bank_status": "string",
+  "user_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
Get User Bank
+

+ +
+
+
+ GET + /user/bank/{user_bank_id} +
+
+
+ + +
+
+ + +
+
+
+
user_bank_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserBank + +
+ +
+
+

User Bank Details

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_id": "integer",
+  "created_at": "string",
+  "user_bank_bsb": "string",
+  "user_bank_id": "integer",
+  "user_bank_name": "string",
+  "user_bank_number": "string",
+  "user_bank_status": "string",
+  "user_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
List All Bank
+

+ +
+
+
+ GET + /bank +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ Bank + +
+ +
+
+

Banks List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "bank_description": "string",
+  "bank_fullname": "string",
+  "bank_iconurl": "string",
+  "bank_id": "integer",
+  "bank_name": "string",
+  "bank_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Bank +
+ + + +

+
Add User Bank Allotment
+

+ +
+
+
+ POST + /user/bank/allotment/{user_bank_id} +
+
+
+ + +
+
+ +
+
+
+
+ + BankAllotment + +
+
+
+ +

accepts user bank allotment data to be added.

+ + +
+
+
+ + +
+
+
+
user_bank_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employer_id": "integer",
+  "pay_type": "string",
+  "user_bank_allotment_fixed": "string",
+  "user_bank_allotment_id": "integer",
+  "user_bank_allotment_percent": "string",
+  "user_bank_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User Bank Allotment successfully added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

SuperFund

+ +
+ + +
+ SuperFund +
+ + + +

+
List All Superfund
+

+ +
+
+
+ GET + /superfund +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ SuperFund + +
+ +
+
+

SuportFund List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_description": "string",
+  "superfund_id": "integer",
+  "superfund_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
List All User SuperFund
+

+ +
+
+
+ GET + /user/superfund +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserSuperFund + +
+ +
+
+

List User superfund

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_number": "string",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
GetUser SuperFund Details
+

+ +
+
+
+ GET + /user/superfund/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserSuperFund + +
+ +
+
+

User superfund details

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_number": "string",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
List All Employer with SuperFund
+

+ +
+
+
+ GET + /user/superfund/employer/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ UserEmployerSuperFund + +
+ +
+
+

List Employer with superfund

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "employer_id": "integer",
+  "employer_name": "string",
+  "user_employer_superfund_id": "integer",
+  "user_superfund_id": "integer",
+  "user_superfund_status": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ SuperFund +
+ + + +

+
Remove User Employer SupportFund
+

+ +
+
+
+ POST + /user/superfund/employer/remove/{user_supperfund_id} +
+
+
+ + +
+
+ + +
+
+
+
user_supperfund_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

User Employer SuperFund successfully remove

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Payroll

+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay approval options
+

+ +
+
+
+ GET + /pay-approval-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Approval Day Frequency select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollApprovalOptions + +
+ +
+
+

Pay Approval Options List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_approval_id": "string",
+  "payroll_approval_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay interval options
+

+ +
+
+
+ GET + /pay-interval-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Interval select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollIntervalOptions + +
+ +
+
+

Pay Interval Options List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_interval_id": "string",
+  "payroll_interval_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Payroll +
+ + + +

+
List all Pay release options
+

+ +
+
+
+ GET + /pay-release-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_PayRun (Interval select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ PayrollReleaseOptions + +
+ +
+
+

Pay Interval Release List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "payroll_release_id": "string",
+  "payroll_release_name": "string"
+}
+
+
+
+
+
+
+

Entity

+ +
+ + +
+ Entity + Tax +
+ + + +

+
List all Tax entity Type
+

+ +
+
+
+ GET + /tax-entity-type-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxEntityTypeOptions + +
+ +
+
+

Tax Entity Type List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "tax_entity_id": "string",
+  "tax_entity_name": "string"
+}
+
+
+
+
+
+
+

Tax

+ +
+ + +
+ Entity + Tax +
+ + + +

+
List all Tax entity Type
+

+ +
+
+
+ GET + /tax-entity-type-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxEntityTypeOptions + +
+ +
+
+

Tax Entity Type List

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "tax_entity_id": "string",
+  "tax_entity_name": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Reporting + Tax +
+ + + +

+
List all Tax Reporting Option
+

+ +
+
+
+ GET + /tax-reporting-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxReportingOptions + +
+ +
+
+

Tax Reporting Option

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "entity_type_id": "string",
+  "entity_type_name": "string"
+}
+
+
+
+
+
+
+

Reporting

+ +
+ + +
+ Reporting + Tax +
+ + + +

+
List all Tax Reporting Option
+

+ +
+
+
+ GET + /tax-reporting-options +
+
+
+ +
+
+
+

used in select/list + *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ TaxReportingOptions + +
+ +
+
+

Tax Reporting Option

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "entity_type_id": "string",
+  "entity_type_name": "string"
+}
+
+
+
+
+
+
+

Employees

+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Employee List by Location
+

+ +
+
+
+ GET + /employer/employees/listbylocation/{employer_id}/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees +
+ + + +

+
Employer Employee List
+

+ +
+
+
+ GET + /employer/employees +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employees + Employer +
+ + + +

+
Employer Own Profile
+

+ +
+
+
+ GET + /user/employer/employee-profile/{location_id} +
+
+
+ +
+
+
+

List all employees under the employer's location

+ +
+
+
+ +
+
+ + +
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

List of employees profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Employee

+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile
+

+ +
+
+
+ GET + /employee/{employee_id} +
+
+
+ +
+
+
+

E_Employee-Profile (part1)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

employee profile

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile Availability
+

+ +
+
+
+ GET + /employee/unavailability/{employee_id}/{date_start}/{date_end} +
+
+
+ +
+
+
+

E_Employee-Profile_Availability (Calendar View - date clicked)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Unavailability + +
+ +
+
+

employee unavailability within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employee_unavailability_date_endv": "string",
+  "employee_unavailability_date_start": "string",
+  "employee_unavailability_fullday": "boolean",
+  "employee_unavailability_id": "integer",
+  "employee_unavailability_special_day": "string",
+  "notes": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Employee +
+ + + +

+
Employee Profile Shifts
+

+ +
+
+
+ GET + /employee/shift/{employee_id}/{date_start}/{date_end} +
+
+
+ +
+
+
+

E_Employee-Profile_Shifts (calendar view – clicked) + E_Employee-Profile_Shifts (List View)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployeeShifts + +
+ +
+
+

employee shifts within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employee_id": "integer",
+  "employer_id": "integer",
+  "employer_shift_assigned_id": "integer",
+  "end_date": "object",
+  "location_id": "integer",
+  "note": "string",
+  "role_id": "integer",
+  "start_date": "object"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Unavailability

+ +
+ + +
+ Unavailability +
+ + + +

+
Add Employee Unavailability
+

+ +
+
+
+ POST + /employee/unavailability +
+
+
+ +
+
+
+

E_Employee-Profile_Availability (Calendar View - date clicked)

+ +
+
+
+ +
+
+ +
+
+
+
+ + Unavailability + +
+
+
+ +

accepts unavailability form data.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_unavailability_date_endv": "string",
+  "employee_unavailability_date_start": "string",
+  "employee_unavailability_fullday": "boolean",
+  "employee_unavailability_id": "integer",
+  "employee_unavailability_special_day": "string",
+  "notes": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Unavailability added successfully

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Unavailability +
+ + + +

+
Delete Employee Unavailability
+

+ +
+
+
+ DELETE + /employee/unavailability/{employee_unavailability_id} +
+
+
+ +
+
+
+

E_Employee-Profile_Availability_Edit (Delete confirmation)

+ +
+
+
+ +
+
+ + +
+
+
+
employee_unavailability_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Unavailability deleted successfully

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Shift

+ +
+ + +
+ Shift +
+ + + +

+
Employe Shifts
+

+ +
+
+
+ GET + /employer/shiftbylocation/calendar/{employer_id}/{location_id}/{date_start}/{date_end} +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerShiftsMonth + +
+ +
+
+

employer shifts count within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "count": "integer",
+  "date": "object",
+  "employer_shift_id": "integer",
+  "publish": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Employe Shifts
+

+ +
+
+
+ GET + /employer/shiftbylocation/list/{employer_id}/{location_id}/{date_start}/{date_end} +
+
+
+ + +
+
+ + +
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
date_start
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
date_end
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployerShifts + +
+ +
+
+

employer shifts count within the current selecte date range

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employer_id": "integer",
+  "employer_shift_id": "integer",
+  "employer_shift_repeat": "boolean",
+  "employer_shift_time_end": "string",
+  "employer_shift_time_start": "string",
+  "location_id": "integer",
+  "notes": "string",
+  "role_id": "integer"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Publish Employer Shifts
+

+ +
+
+
+ PUT + /shift/publish +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

shift published

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Employer Shift Update
+

+ +
+
+
+ PUT + /shift/{employer_shift_id} +
+
+
+ + +
+
+ +
+
+
+
+ + EmployerShifts + +
+
+
+ +

accepts shift form data.

+ + +
+
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employer_id": "integer",
+  "employer_shift_id": "integer",
+  "employer_shift_repeat": "boolean",
+  "employer_shift_time_end": "string",
+  "employer_shift_time_start": "string",
+  "location_id": "integer",
+  "notes": "string",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

shift details updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Add Employer Shift
+

+ +
+
+
+ POST + /shift +
+
+
+ + +
+
+ +
+
+
+
+ + EmployerShifts + +
+
+
+ +

accepts shift form data.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "employer_id": "integer",
+  "employer_shift_id": "integer",
+  "employer_shift_repeat": "boolean",
+  "employer_shift_time_end": "string",
+  "employer_shift_time_start": "string",
+  "location_id": "integer",
+  "notes": "string",
+  "role_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

shift added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Employee Shift
+

+ +
+
+
+ GET + /employee/shift/{employee_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ EmployeeShift + +
+ +
+
+

shift added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "employer_shift_assigned_id": "integer",
+  "role_name": "string",
+  "shift_current_time": "string",
+  "shift_status": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
List Employees Scheduled on this Shift
+

+ +
+
+
+ GET + /shift/scheduled/{employer_shift_id} +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ UserProfile + +
+ +
+
+

list of employees

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "address": "array",
+  "user_dob": "string",
+  "user_email": "string",
+  "user_iconurl": "string",
+  "user_id": "integer",
+  "user_name_first": "string",
+  "user_name_last": "string",
+  "user_phone": "string",
+  "user_status": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Add employee on shift
+

+ +
+
+
+ POST + /shift/add/employee/{employer_shift_id} +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

add employee to shift

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Shift +
+ + + +

+
Remove employee on shift
+

+ +
+
+
+ DELETE + /shift/employee/{employer_shift_assigned_id}/ +
+
+
+ + +
+
+ + +
+
+
+
employer_shift_assigned_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

employee removed

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Industry

+ +
+ + +
+ Industry +
+ + + +

+
List all industries
+

+ +
+
+
+ GET + /industry +
+
+
+ +
+
+
+

fetch industries, used in select/list + *Page 3_Account_EmployerProfile (Industry select)

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Industries + +
+ +
+
+

Industry Lists

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "industry_code": "string",
+  "industry_description": "string",
+  "industry_id": "string",
+  "industry_name": "string"
+}
+
+
+
+
+
+
+

Documents

+ +
+ + +
+ Documents +
+ + + +

+
Add new document
+

+ +
+
+
+ POST + /documents +
+
+
+ + +
+
+ +
+
+
+
+ + Documents + +
+
+
+ +

accepts document data to be added.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 

+{
+  "user_document_expiry": "string",
+  "user_document_id": "integer",
+  "user_document_issuer": "string",
+  "user_document_name": "string"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Document successfully added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
Edit document
+

+ +
+
+
+ PUT + /documents/{document_id} +
+
+
+ + +
+
+ +
+
+
+
+ + Documents + +
+
+
+ +

accepts document data to be edited.

+ + +
+
+
+ + +
+
+
+
document_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+[
+  {
+    "user_document_expiry": "string",
+    "user_document_id": "integer",
+    "user_document_issuer": "string",
+    "user_document_name": "string"
+  }
+]
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Documents + +
+ +
+
+

Document successfully updated

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "user_document_expiry": "string",
+  "user_document_id": "integer",
+  "user_document_issuer": "string",
+  "user_document_name": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
List document page
+

+ +
+
+
+ GET + /document-pages/{document_id} +
+
+
+ + +
+
+ + +
+
+
+
document_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ DocumentPages + +
+ +
+
+

Document Page List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "user_document_id": "string",
+  "user_document_page_id": "integer",
+  "user_document_page_url": "string",
+  "user_document_sort": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
List document shared
+

+ +
+
+
+ GET + /document/shared +
+
+
+ + +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
default
+
+ DocumentShared + +
+ +
+
+

Document Page List

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "employer_id": "string",
+  "user_document_id": "integer",
+  "user_document_share_id": "integer"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
Remove employer to document share
+

+ +
+
+
+ DELETE + /document/share/{document_id} +
+
+
+ + +
+
+ + +
+
+
+
document_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+
employer_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
query
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Document unshared successful

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
List all employee's documents
+

+ +
+
+
+ GET + /employee/documents/shared/{employee_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Documents + +
+ +
+
+

Employee document lists

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "user_document_expiry": "string",
+  "user_document_id": "integer",
+  "user_document_issuer": "string",
+  "user_document_name": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Documents +
+ + + +

+
Employee's document Details
+

+ +
+
+
+ GET + /employee/document/shared/{document_id} +
+
+
+ + +
+
+ + +
+
+
+
document_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Documents + +
+ +
+
+

Employee document details

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (200 OK)
+ 

+{
+  "user_document_expiry": "string",
+  "user_document_id": "integer",
+  "user_document_issuer": "string",
+  "user_document_name": "string"
+}
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Locations

+ +
+ + +
+ Locations +
+ + + +

+
Employee's list of locations
+

+ +
+
+
+ POST + /employee/locations/{employee_id} +
+
+
+ + +
+
+ +
+
+
+
+ + Locations + +
+
+
+ +

accepts locations page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_location_id": "integer",
+  "employee_location_name": "string",
+  "location_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee location added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Locations +
+ + + +

+
remove location from employee
+

+ +
+
+
+ DELETE + /employee/location/{employee_location_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_location_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Successfully remove employees locations

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+

Notes

+ +
+ + +
+ Notes +
+ + + +

+
Add Employee's notes
+

+ +
+
+
+ POST + /employee/notes/{employee_id} +
+
+
+ + +
+
+ +
+
+
+
+ + Note + +
+
+
+ +

accepts noted page data to be added.

+ + +
+
+
+ + +
+
+
+
employee_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 

+{
+  "employee_id": "integer",
+  "employee_notes": "string",
+  "employee_notes_id": "integer",
+  "employer_shift_id": "integer",
+  "location_id": "integer",
+  "to_user_id": "integer"
+}
+
+
+
+
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee notes added

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ +
+ + +
+ Notes +
+ + + +

+
Delte employee's note
+

+ +
+
+
+ DELETE + /employee/note/{employee_notes_id} +
+
+
+ + +
+
+ + +
+
+
+
employee_notes_id
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer + + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+
+

Employee note deleted

+ +
+
+
+
+
default
+
+ Error + +
+ +
+
+

Unexpected error

+ +
+
+
+
+
+
Response Example (default )
+ 

+{
+  "code": "integer(int32)",
+  "fields": "string",
+  "message": "string"
+}
+
+
+
+
+
+
+ + +

Schema definitions

+ +
+

+ Accounts: + object + + + +

+
+
+ +
+
+
+ acount_id: + object + + +
+
+ display_name: + object + + +
+
+ icon_url: + object + + +
+
+ account_type: + object + + +
+
+
+
+
+
+
+

+ Bank: + object + + + +

+
+
+ +
+
+
+ bank_id: + object + + +
+
+ bank_status: + object + + +
+
+ bank_name: + object + + +
+
+ bank_fullname: + object + + +
+
+ bank_description: + object + + +
+
+ bank_iconurl: + object + + +
+
+
+
+
+
+
+

+ BankAllotment: + object + + + +

+
+
+ +
+
+
+ user_bank_allotment_id: + object + + +
+
+ user_bank_id: + object + + +
+
+ employer_id: + object + + +
+
+ user_bank_allotment_percent: + object + + +
+
+ user_bank_allotment_fixed: + object + + +
+
+ pay_type: + object + + +
+
+
+
+
+
+
+

+ DocumentPages: + object + + + +

+
+
+ +
+
+
+ user_document_page_id: + object + + +
+
+ user_document_page_url: + object + + +
+
+ user_document_sort: + object + + +
+
+ user_document_id: + object + + +
+
+
+
+
+
+
+

+ Documents: + object + + + +

+
+
+ +
+
+
+ user_document_id: + object + + +
+
+ user_document_name: + object + + +
+
+ user_document_issuer: + object + + +
+
+ user_document_expiry: + object + + +
+
+
+
+
+
+
+

+ DocumentShared: + object + + + +

+
+
+ +
+
+
+ user_document_share_id: + object + + +
+
+ user_document_id: + object + + +
+
+ employer_id: + object + + +
+
+
+
+
+
+
+

+ EmployeeShift: + object + + + +

+
+
+ +
+
+
+ user_id: + object + + +
+
+ employer_shift_assigned_id: + object + + +
+
+ role_name: + object + + +
+
+ shift_current_time: + object + + +
+
+ user_name_last: + object + + +
+
+ user_name_first: + object + + +
+
+ user_email: + object + + +
+
+ user_iconurl: + object + + +
+
+ user_phone: + object + + +
+
+ shift_status: + object + + +
+
+
+
+
+
+
+

+ EmployeeShifts: + object + + + +

+
+
+ +
+
+
+ employer_shift_assigned_id: + object + + +
+
+ employer_id: + object + + +
+
+ employee_id: + object + + +
+
+ location_id: + object + + +
+
+ role_id: + object + + +
+
+ start_date: + object + + +
+
+ end_date: + object + + +
+
+ note: + object + + +
+
+
+
+
+
+
+

+ EmployerAddress: + object + + + +

+
+
+ +
+
+
+ employer_address_line1: + string + + +
+
+

Employer current address line one

+ +
+
+ employer_address_line2: + string + + +
+
+

Employer current address line two

+ +
+
+ employer_address_city: + string + + +
+
+

Employer current city

+ +
+
+ employer_postcode: + string + + +
+
+

Employer current postcode

+ +
+
+ employer_state: + string + + +
+
+

Employer current state/province

+ +
+
+ country_id: + string + + +
+
+

Employer current country

+ +
+
+
+
+
+
+
+

+ EmployerOwnProfile: + object + + + +

+
+
+ +
+
+
+ employer_id: + object + + +
+
+ employer_business_name: + object + + +
+
+ employer_iconurl: + object + + +
+
+ user_name_last: + object + + +
+
+ user_name_first: + object + + +
+
+ employer_email: + object + + +
+
+ employer_phone: + object + + +
+
+ industry_id: + object + + +
+
+ employer_abn: + object + + +
+
+ employer_acn: + object + + +
+
+ employer_contact_email: + object + + +
+
+ employer_contact_name: + object + + +
+
+ payroll_interval_id: + object + + +
+
+ payroll_approval_id: + object + + +
+
+ payroll_release_id: + object + + +
+
+ tax_entity_id: + object + + +
+
+ tax_reporting_id: + object + + +
+
+ employer_tax_gst: + object + + +
+
+ employer_tax_payrolltax: + object + + +
+
+ address: + object + + +
+
+
+
+
+
+
+

+ EmployerShifts: + object + + + +

+
+
+ +
+
+
+ employer_shift_id: + object + + +
+
+ employer_id: + object + + +
+
+ location_id: + object + + +
+
+ role_id: + object + + +
+
+ employer_shift_time_start: + object + + +
+
+ employer_shift_time_end: + object + + +
+
+ employer_shift_repeat: + object + + +
+
+ notes: + object + + +
+
+
+
+
+
+
+

+ EmployerShiftsMonth: + object + + + +

+
+
+ +
+
+
+ employer_shift_id: + object + + +
+
+ date: + object + + +
+
+ count: + object + + +
+
+ publish: + object + + +
+
+
+
+
+
+
+

+ Error: + object + + + +

+
+
+ +
+
+
+ code: + object + + +
+
+ message: + object + + +
+
+ fields: + object + + +
+
+
+
+
+
+
+

+ Industries: + object + + + +

+
+
+ +
+
+
+ industry_id: + object + + +
+
+ industry_name: + object + + +
+
+ industry_code: + object + + +
+
+ industry_description: + object + + +
+
+
+
+
+
+
+

+ Locations: + object + + + +

+
+
+ +
+
+
+ location_id: + object + + +
+
+ employee_location_id: + object + + +
+
+ employee_location_name: + object + + +
+
+
+
+
+
+
+

+ Note: + object + + + +

+
+
+ +
+
+
+ employee_notes_id: + object + + +
+
+ employee_id: + object + + +
+
+ to_user_id: + object + + +
+
+ location_id: + object + + +
+
+ employer_shift_id: + object + + +
+
+ employee_notes: + object + + +
+
+
+
+
+
+
+

+ PayrollApprovalOptions: + object + + + +

+
+
+ +
+
+
+ payroll_approval_id: + object + + +
+
+ payroll_approval_name: + object + + +
+
+
+
+
+
+
+

+ PayrollIntervalOptions: + object + + + +

+
+
+ +
+
+
+ payroll_interval_id: + object + + +
+
+ payroll_interval_name: + object + + +
+
+
+
+
+
+
+

+ PayrollReleaseOptions: + object + + + +

+
+
+ +
+
+
+ payroll_release_id: + object + + +
+
+ payroll_release_name: + object + + +
+
+
+
+
+
+
+

+ Role: + object + + + +

+
+
+ +
+
+
+ employee_role_id: + object + + +
+
+ employee_id: + object + + +
+
+ role_id: + object + + +
+
+
+
+
+
+
+

+ RoleDetails: + object + + + +

+
+
+ +
+
+
+ employee_role_id: + object + + +
+
+ employee_id: + object + + +
+
+ last_shift: + object + + +
+
+ first_shift: + object + + +
+
+ payroll_variations: + object + + +
+
+
+
+
+
+
+

+ RoleVariation: + object + + + +

+
+
+ +
+
+
+ employee_role_variations_id: + object + + +
+
+ employee_role_id: + object + + +
+
+ variations_type: + object + + +
+
+ variations_value: + object + + +
+
+
+
+
+
+
+

+ SuperFund: + object + + + +

+
+
+ +
+
+
+ superfund_id: + object + + +
+
+ superfund_name: + object + + +
+
+ superfund_description: + object + + +
+
+
+
+
+
+
+

+ TaxEntityTypeOptions: + object + + + +

+
+
+ +
+
+
+ tax_entity_id: + object + + +
+
+ tax_entity_name: + object + + +
+
+
+
+
+
+
+

+ TaxReportingOptions: + object + + + +

+
+
+ +
+
+
+ entity_type_id: + object + + +
+
+ entity_type_name: + object + + +
+
+
+
+
+
+
+

+ Unavailability: + object + + + +

+
+
+ +
+
+
+ employee_unavailability_id: + object + + +
+
+ employee_unavailability_date_start: + object + + +
+
+ employee_unavailability_date_endv: + object + + +
+
+ employee_id: + object + + +
+
+ notes: + object + + +
+
+ employee_unavailability_special_day: + object + + +
+
+ employee_unavailability_fullday: + object + + +
+
+
+
+
+
+
+

+ UserAddress: + object + + + +

+
+
+ +
+
+
+ user_address_line1: + string + + +
+
+

User current address line one

+ +
+
+ user_address_line2: + string + + +
+
+

User current address line two

+ +
+
+ user_address_city: + string + + +
+
+

User current city

+ +
+
+ user_postcode: + string + + +
+
+

User current postcode

+ +
+
+ user_state: + string + + +
+
+

User current state/province

+ +
+
+ country_id: + string + + +
+
+

User current country

+ +
+
+
+
+
+
+
+

+ UserBank: + object + + + +

+
+
+ +
+
+
+ user_bank_id: + object + + +
+
+ bank_id: + object + + +
+
+ user_id: + object + + +
+
+ user_bank_status: + object + + +
+
+ user_bank_name: + object + + +
+
+ user_bank_bsb: + object + + +
+
+ user_bank_number: + object + + +
+
+ created_at: + object + + +
+
+
+
+
+
+
+

+ UserEmployerSuperFund: + object + + + +

+
+
+ +
+
+
+ user_employer_superfund_id: + object + + +
+
+ user_superfund_id: + object + + +
+
+ employer_id: + object + + +
+
+ employer_name: + object + + +
+
+ user_superfund_status: + object + + +
+
+
+
+
+
+
+

+ UserProfile: + object + + + +

+
+
+ +
+
+
+ user_id: + object + + +
+
+ user_name_last: + object + + +
+
+ user_name_first: + object + + +
+
+ user_email: + object + + +
+
+ user_dob: + object + + +
+
+ user_iconurl: + object + + +
+
+ user_status: + object + + +
+
+ user_phone: + object + + +
+
+ address: + object + + +
+
+
+
+
+
+
+

+ UserSuperFund: + object + + + +

+
+
+ +
+
+
+ user_superfund_id: + object + + +
+
+ superfund_id: + object + + +
+
+ user_superfund_number: + object + + +
+
+ user_superfund_status: + object + + +
+
+
+
+
+
+ +
+
+ Documentation by Spectacle +
+
+
- - + +
+