Data Transfer Format
Overview
A snapshot of people in an organisation can be exported as a CSV file. The first row of the file is a header row containing the column names and each subsequent row contains data for a person. The file is encoded in UTF-8 and uses a comma (,) as the delimiter.
An export can either be a “full export” containing a row for every person in the account or a “partial export” containing a row for every person that has been added or updated since the last export.
The order of columns in the export file is not guaranteed — you must use the column names to identify each column. New columns may be introduced at any time.
Each column is explained in detail on this page and has been grouped into the following sections for ease of reference:
Metadata
| Column | Type | Examples | Nullable | Description |
|---|---|---|---|---|
id | uuid | No | ||
employee_code | string | Yes | ||
role | person_role | No | ||
status | person_status | No | ||
archived | boolean | No | ||
created_at | date_time | No | ||
invited_at | date_time | Yes | ||
activated_at | date_time | Yes | ||
updated_at | date_time | No |
Profile
| Column | Type | Examples | Nullable | Description |
|---|---|---|---|---|
display_name | string | No | ||
profile_bio | string | Yes | ||
profile_email | string | Yes | ||
profile_phone | string | Yes | ||
profile_pronouns | string | Yes |
Personal Details
| Column | Type | Examples | Nullable | Description |
|---|---|---|---|---|
given_name | string | Yes | ||
other_given_names | string | Yes | ||
family_name | string | Yes | ||
gender | gender | No | ||
date_of_birth | date | Yes | ||
personal_email | string | Yes | ||
personal_phone | string | Yes |
Residential Address
| Column | Type | Examples | Nullable | Description |
|---|---|---|---|---|
residential_address_line_1 | string | Yes | ||
residential_address_line_2 | string | Yes | ||
residential_address_city | string | Yes | ||
residential_address_state | state | Yes | ||
residential_address_postcode | string | Yes | ||
residential_address_country | country_name | Yes |
Postal Address
| Column | Type | Examples | Nullable | Description |
|---|---|---|---|---|
postal_address_line_1 | string | Yes | ||
postal_address_line_2 | string | Yes | ||
postal_address_city | string | Yes | ||
postal_address_state | state | Yes | ||
postal_address_postcode | string | Yes | ||
postal_address_country | country_name | Yes |
Emergency Contacts
| Column | Type | Examples | Nullable | Description |
|---|---|---|---|---|
emergency_contact_1_name | string | Yes | ||
emergency_contact_1_relationship | string | Yes | ||
emergency_contact_1_phone | string | Yes | ||
emergency_contact_2_name | string | Yes | ||
emergency_contact_2_relationship | string | Yes | ||
emergency_contact_2_phone | string | Yes |
Tenure
| Column | Type | Examples | Nullable | Description |
|---|---|---|---|---|
start_date | date | No |
Remuneration
| Column | Type | Examples | Nullable | Description |
|---|---|---|---|---|
employment_basis | employment_basis | Yes | ||
pay_rate | decimal | Yes | ||
pay_period | pay_period | Yes |
Tax Details
| Column | Type | Examples | Nullable | Description |
|---|---|---|---|---|
tax_file_number_exemption | tax_file_number_exemption | Yes | ||
tax_file_number | tax_file_number | Yes | ||
residency_status | residency_status | Yes | ||
has_loan_or_student_debt | boolean | Yes | ||
tax_free_threshold_claimed | boolean | Yes |
Super Funds
| Column | Type | Examples | Nullable | Description |
|---|---|---|---|---|
super_fund_1_nomination | super_nomination | Yes | ||
super_fund_1_usi | string | Yes | ||
super_fund_1_member_name | string | Yes | ||
super_fund_1_member_number | string | Yes |
Bank Accounts
| Column | Type | Examples | Nullable | Description |
|---|---|---|---|---|
bank_account_1_allocation_method | allocation_method | Yes | ||
bank_account_1_allocation | decimal | Yes | ||
bank_account_1_bsb | bsb | Yes | ||
bank_account_1_name | string | Yes | ||
bank_account_1_number | string | Yes | ||
bank_account_2_allocation_method | allocation_method | Yes | ||
bank_account_2_allocation | decimal | Yes | ||
bank_account_2_bsb | bsb | Yes | ||
bank_account_2_name | string | Yes | ||
bank_account_2_number | string | Yes | ||
bank_account_3_allocation_method | allocation_method | Yes | ||
bank_account_3_allocation | decimal | Yes | ||
bank_account_3_bsb | bsb | Yes | ||
bank_account_3_name | string | Yes | ||
bank_account_3_number | string | Yes | ||
bank_account_4_allocation_method | allocation_method | Yes | ||
bank_account_4_allocation | decimal | Yes | ||
bank_account_4_bsb | bsb | Yes | ||
bank_account_4_name | string | Yes | ||
bank_account_4_number | string | Yes | ||
bank_account_5_allocation_method | allocation_method | Yes | ||
bank_account_5_allocation | decimal | Yes | ||
bank_account_5_bsb | bsb | Yes | ||
bank_account_5_name | string | Yes | ||
bank_account_5_number | string | Yes |
Job/Position
| Column | Type | Examples | Nullable | Description |
|---|---|---|---|---|
job_id | uuid | Yes | ||
job_title | string | Yes | ||
position_id | uuid | Yes | ||
position_code | string | Yes | ||
manager_position_id | uuid | Yes | ||
manager_person_id | uuid | Yes |