Accounts and Branches

Account ID

This action returns the account ID(s) that are available for the logged in authenticated user.

Get Account ID
MethodGET: Accounts
ParametersNone
Response
FieldDetailsExample
Account IDUnique ID of the accounts6ebc9d471a7c49c0ba6796ce4df29205,
4eb62cb48c9f429c93bc26664c1a5a4d

List Branches

Use this account to list the available branches in the account for the logged in authenticated user.

Branches are how enableHR separates and organises Employees. Put simply, branches are set up in enableHR to mirror the organisation’s structure. There are two types of branches:

  1. “Legal entity” branches are used when the name of the branch needs to appear on documents generated by the system, such as a contract or a letter for instance.
  2. “Department / group” branches sit below a legal entity and are used to reflect the organisation’s structure. Typically, they represent locations or departments/teams. For instance, "Operations", "Sales", "New South Wales" or "Auckland" would operate under the parent legal entity / company.
List Branches
MethodGET: List Branches
ParametersAccount ID - Unique identifier of the Account
Response
Field Name on the ScreenDetailsExample
Branch IDUnique ID of the branch39c4e9b0418e4236b6a8ac4bce927a9e
Branch NameBranch Name as per the setupBrighton Store
PathHierarchical position of the branchIf exists – /Trumps incorporated/Brighton Store
If not exists - /Brighton Store
Branch TypeType of branch setup in enableHRAllow values: Legal Entity, Department
Parent Branch - IDUnique ID of the parent branche15b0e829753458095cf3e54ed967ac5
Parent Branch - NameName of the parent branchTrumps incorporated
Parent Branch - PathHierarchical position of the parent branchTrumps incorporated
Child Branch - IDUnique ID of the Child branch
Child Branch - NameName of the the Child branch
Child Branch - PathHierarchical position of the Child branch
Line1:Line 1 of the Branch132 Test Street
Line2:Line 2 of the Branch
Suburb:Suburb of the BranchMelbourne
State:State where the suburb is locatedVIC
Post Code:Postal code of the Suburb3000
Country:Country of the SuburbAustralia
Account Settings

Retrieve Branch Details

This action will return more details about a branch for the logged in authenticated user.

Branches are how enableHR separates and organises Employees. Put simply, branches are set up in enableHR to mirror the organisation’s structure.

A branch can have an unlimited number of sub-branches. Sub-branches can be linked to one and only one parent branch.

You can define specific branches for the applicant portal and the WHS portal.

Retrieve Branch Details
MethodGET: Retrieve Branch Details
ParametersAccount ID - Unique identifier of the Account
Branch ID - Unique identifier of the Branch
Response
Field Name on the ScreenDetailsExample
Branch IDUnique ID of the branch39c4e9b0418e4236b6a8ac4bce927a9e
Branch NameBranch Name as per the setupBrighton Store
PathHierarchical position of the branchIf exists – /Trumps incorporated/ Trumps Private Limited
If not exists - / Trumps Private Limited
Branch TypeType of branch setup in enableHRAllow values: Legal Entity, Department
Legal NameLegal name for the branchTrumps Brandings
Trading NameThe name under which the branch is operatingTrumps Private Limited
Business NumberAustralian Business Number of the branch1231234343
Parent Branch - IDUnique ID of the parent branche15b0e829753458095cf3e54ed967ac5
Parent Branch - NameName of the parent branchTrumps incorporated
Parent Branch - PathHierarchical position of the parent branchTrumps incorporated
Child Branch - IDUnique ID of the Child branch
Child Branch - NameName of the the Child branch
Child Branch - PathHierarchical position of the Child branch
Line1:Line 1 of the Branch132 Test Street
Line2:Line 2 of the Branch
Suburb:Suburb of the BranchMelbourne
State:State where the suburb is locatedVIC
Post Code:Postal code of the Suburb3000
Country:Country of the SuburbAustralia
Branch Name for Applicant PortalApplicant Portal name as stored in the branch setupIf exists - Trumps Recruitment
If not exists - Blank
Branch Name for WHS PortalWHS Portal name as stored in the branch setupIf exists - Trumps Injury Reporting
If not exists - Blank
Phone NumberPhone number of the branch0450999999
Mobile NumberMobile number of the branch0450999999
Fax NumberFax number of the branch123456456
EmailEmail address setup for the branch
WebsiteWebsite URL setup for the branch
Entity Details
Account Details
© 2021 enableHR · All rights reserved