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
Profile
Date of birth
Full name
Gender
Personal email
Personal phone
Residential Address
Postal Address
Emergency Contacts
Tenure
Remuneration
Tax Details
Super Funds
Bank Accounts
Job/Position

Metadata

System information about the person.

Column	Type	Examples	Nullable	Description
`id`	uuid	`511fa01c-0ffd-43e0-bd0f-f017955a45d5` `cd05fddc-ff46-4377-b1f7-2f46e63c42a8` `034539ad-32cc-4fad-a8f7-10e94f66d261` `c336d339-fce9-46dd-8dfe-90334a9fd0a2`	No	Internal Worknice ID for this person.
`employee_code`	string	`E2132` `E2133` `20220056` `20220057`	Yes	An optional code used to identify this person. This will typically be an ID from an external payroll system.
`role`	person_role	`account_owner` `manager` `employee`	No	The role the person has in Worknice.
`status`	person_status	`draft` `onboarding` `active` `invited`	No	The status of the person in Worknice. Typically, only people with an `active` status should be considered current employees of the organisation.
`archived`	boolean	`true` `false`	No	If `true`, this person has been removed from Worknice.
`created_at`	date_time	`2000-01-01T00:00:00Z` `2020-10-22T14:12:33+10:00` `2020-10-23T01:10:20.501+10:00` `2020-11-01T00:00:00Z`	No	The moment when the person was created in Worknice.
`invited_at`	date_time	`2000-01-01T00:00:00Z` `2020-10-22T14:12:33+10:00` `2020-10-23T01:10:20.501+10:00` `2020-11-01T00:00:00Z`	Yes	When the person was invited to Worknice and their status was transitioned to `onboarding`. If the person didn't go through the invite process, this will match their `created_at` time.
`activated_at`	date_time	`2000-01-01T00:00:00Z` `2020-10-22T14:12:33+10:00` `2020-10-23T01:10:20.501+10:00` `2020-11-01T00:00:00Z`	Yes	The moment when the person completed onboarding and their status was transitioned to `active`. If the person didn't go through onboarding, this will match their `created_at` time.
`updated_at`	date_time	`2000-01-01T00:00:00Z` `2020-10-22T14:12:33+10:00` `2020-10-23T01:10:20.501+10:00` `2020-11-01T00:00:00Z`	No	Most recent date that any part of this person's record was updated (this includes changes to bank accounts, current job etc).

Profile

The person's profile information. This is information is visible to all members of the organisation.

Column	Type	Examples	Nullable	Description
`display_name`	string	`Sally F` `Jimmy` `Kate` `Sal B.`	No	The name this person uses day-to-day. Should not be used for legal purposes.
`profile_bio`	string	`I'm the Head of People at Example Inc.` `Making sales. Loving life.` `I'm a designer.` `I'm looking after the socials. Hit me up if you've got any questions!`	Yes	A self-written bio of the person.
`profile_email`	string	`sally@example.com` `jim@example.com` `kate@example.com` `sally.b@example.com`	Yes	The person's work email address. Visible to all members of the organisation.
`profile_phone`	string	`02 1234 1234` `0211112222` `02 3232 3434` `02 3232 3433`	Yes	The person's work phone address. Visible to all members of the organisation.
`profile_pronouns`	string	`she/her` `he/him` `they/them`	Yes	The person's preferred pronouns. Visible to all members of the organisation.

Date of birth

The date of birth of this employee.

Column	Type	Examples	Nullable	Description
`date_of_birth`	date	`2021-03-12` `1992-03-25` `2020-06-10` `1999-07-02`	Yes	The person's date of birth.

Full name

The full name of the employee used for legal purposes.

Column	Type	Examples	Nullable	Description
`given_name`	string	`Sally` `James` `Kate`	Yes	The person's legal given name (a.k.a. "first name").
`other_given_names`	string	`Anne` `John` `Mary Kate` `Sara`	Yes	Any other given names the person has (a.k.a. "middle names").
`family_name`	string	`Fuller` `Van Gogh` `Da Silva` `Baker`	Yes	The person's legal family name (a.k.a. "last name" or "surname").

Gender

The stated gender of this employee.

Column	Type	Examples	Nullable	Description
`gender`	gender	`female` `male` `non_binary` `not_stated`	No	The person's stated gender.

Personal email

This employee's personal email address.

Column	Type	Examples	Nullable	Description
`personal_email`	string	`sal92@example.net` `jimmy@example.net` `katie@example.net` `sally.baker@example.net`	Yes	The person's personal email.

Personal phone

This employee's personal phone number.

Column	Type	Examples	Nullable	Description
`personal_phone`	string	`+61 401 123 132` `02 1234 1234` `0402 123 132` `0211112222`	Yes	The person's personal phone number. This could be either a mobile or landline phone.

Residential Address

A residential address for this person.

Column	Type	Examples	Nullable	Description
`residential_address_line_1`	string	`123 Fake Street` `1 Main Street` `29 Example Rd` `18 Pine St`	Yes	First line of the address that will typically include the street name and number.
`residential_address_line_2`	string	`Apartment 1` `Level 2`	Yes	An optional second line for the address.
`residential_address_city`	string	`Sydney` `Greenwich`	Yes	The city/suburb/town of the address.
`residential_address_state`	state	`NSW` `ACT` `NT` `QLD`	Yes	If the address is in Australia this will be one of the Australian state/territory codes, otherwise this will be freeform text for the subdivision appropriate for the country.
`residential_address_postcode`	string	`2000` `90210` `AL5 5NA`	Yes	If the address is in Australia this will be a 4-digit postcode, otherwise this should be an appropriate code for the country (such as a ZIP Code) or null if no code is appropriate.
`residential_address_country`	country_name	`AUSTRALIA` `UNITED KINGDOM OF GREAT BRITAIN AND NORTHERN IRELAND` `NEW ZEALAND` `TÜRKİYE`	Yes	The country of the address.

Postal Address

The postal address for this person. If the person have not provided a postal address, this will be the same as their residential address.

Column	Type	Examples	Nullable	Description
`postal_address_line_1`	string	`123 Fake Street` `1 Main Street` `29 Example Rd` `18 Pine St`	Yes	First line of the address that will typically include the street name and number.
`postal_address_line_2`	string	`Apartment 1` `Level 2`	Yes	An optional second line for the address.
`postal_address_city`	string	`Sydney` `Greenwich`	Yes	The city/suburb/town of the address.
`postal_address_state`	state	`NSW` `ACT` `NT` `QLD`	Yes	If the address is in Australia this will be one of the Australian state/territory codes, otherwise this will be freeform text for the subdivision appropriate for the country.
`postal_address_postcode`	string	`2000` `90210` `AL5 5NA`	Yes	If the address is in Australia this will be a 4-digit postcode, otherwise this should be an appropriate code for the country (such as a ZIP Code) or null if no code is appropriate.
`postal_address_country`	country_name	`AUSTRALIA` `UNITED KINGDOM OF GREAT BRITAIN AND NORTHERN IRELAND` `NEW ZEALAND` `TÜRKİYE`	Yes	The country of the address.

Emergency Contacts

If an emergency contact is provided, all 3 fields for that contact will not be null.

Column	Type	Examples	Nullable	Description
`emergency_contact_1_name`	string	`Katherine` `Mike Li`	Yes	The name of the emergency contact. May be either a full name or a given name.
`emergency_contact_1_relationship`	string	`Mother` `Friend`	Yes	A freeform description of the emergency contact's relationship to the person.
`emergency_contact_1_phone`	string	`+61 040 123 123` `08 8888 1234`	Yes	A phone number for the emergency contact.
`emergency_contact_2_name`	string	`Katherine` `Mike Li`	Yes	The name of the emergency contact. May be either a full name or a given name.
`emergency_contact_2_relationship`	string	`Mother` `Friend`	Yes	A freeform description of the emergency contact's relationship to the person.
`emergency_contact_2_phone`	string	`+61 040 123 123` `08 8888 1234`	Yes	A phone number for the emergency contact.

Tenure

Details about the person's pay.

Column	Type	Examples	Nullable	Description
`start_date`	date	`2021-03-12` `1992-03-25` `2020-06-10` `1999-07-02`	No	The date the person started working for the organisation.

Remuneration

Details about the person's pay.

Column	Type	Examples	Nullable	Description
`employment_basis`	employment_basis	`full_time` `part_time` `labour_hire` `casual`	Yes	The basis on which the person is employed for their current primary job.
`pay_rate`	decimal	`34.5601` `0.0001` `999999999.999999`	Yes	The rate of pay in the `pay_period`.
`pay_period`	pay_period	`year` `hour`	Yes	The period used for the `pay_rate`.

Tax Details

Information required specifically for tax purposes.

Column	Type	Examples	Nullable	Description
`tax_file_number_exemption`	tax_file_number_exemption	`none` `pending` `pensioner` `under_18`	Yes	Either `none` or the reason why the person does has not provided a tax file number. If this field is omitted all other tax fields will be ignored.
`tax_file_number`	tax_file_number	`123456782`	Yes	Present only if `tax_file_number_exemption` is `none`.
`residency_status`	residency_status	`australian_resident` `foreign_resident` `working_holiday_maker`	Yes	The person's residency status for tax purposes.
`has_loan_or_student_debt`	boolean	`true` `false`	Yes	Does the person have Higher Education Loan Program (HELP), VET Student Loan (VSL), Financial Supplement (FS), Student Start-up Loan (SSL) or Trade Support Loan (TSL) debt.
`tax_free_threshold_claimed`	boolean	`true` `false`	Yes	Whether the person is claiming the tax free threshold from this payer.

Super Funds

Note: Worknice does not currently capture information for self-managed superannuation funds. If the super_nomination is self_managed the details for the self-managed fund will need to be gathered manually.

Column	Type	Examples	Nullable	Description
`super_fund_1_nomination`	super_nomination	`regulated` `not_entitled` `employer_nominated` `self_managed`	Yes	The person's superannuation nomination choice.
`super_fund_1_usi`	string	`AA12341234`	Yes	The USI of the person's chosen super fund. This will only be included if the person has chosen `regulated` or `employer_nominated` as their `super_nomination`.
`super_fund_1_member_name`	string	`Anthony Jones` `Otto Weber`	Yes	The name used for the person's superannuation membership.
`super_fund_1_member_number`	string	`123 1234 1234` `A2001111`	Yes	The person's membership number as provided by the superannuation fund.

Bank Accounts

The person's bank accounts to pay into. The allocation method fields are used as sentinels to indicate the presence of the other bank account fields. All other fields will be present for a bank account if the allocation method is not null (excluding the allocation field for the "remainder" allocation method). Across the accounts there can be a mix of "fixed_amount", "per_long_hundred" and "remainder" allocation methods.

If any account has the "fixed_amount" allocation method there will also be an account with the "remainder" allocation method.
If there are no accounts with a "fixed_amount" allocation method and the total of the "per_long_hundred" allocations does not equal 120, there will be an account with a "remainder" allocation method.
There will never be more than 1 account with the "remainder" allocation method.

Column	Type	Examples	Nullable	Description
`bank_account_1_allocation_method`	allocation_method	`fixed_amount` `per_long_hundred` `remainder`	Yes	The method used to allocate the payment to this account. `"fixed_amount"` means the `allocation` field will be a dollar amount to allocate to this account. `"per_long_hundred"` means the allocation will a fraction of `120` to allocate to this account (e.g. an allocation of `60` is equivalent to 50%). `"remainder"` means the remainder after all other accounts have been paid should be allocated to this account (at most 1 account will have this allocation method).
`bank_account_1_allocation`	decimal	`250` `80`	Yes	If the allocation method is `"fixed_amount"` this is the dollar amount to allocate to this account, if the allocation method is `"per_long_hundred"` this is the fraction of `120` to allocate to this account (e.g. an allocation of `40` is equivalent to one third or ≈33.33%). Null otherwise.
`bank_account_1_bsb`	bsb	`123123`	Yes	The BSB of the bank account.
`bank_account_1_name`	string	`Gabriel Dupont`	Yes	The name of the bank account.
`bank_account_1_number`	string	`123 456 789`	Yes	The number for the bank account as entered by the user (may include whitespace).
`bank_account_2_allocation_method`	allocation_method	`fixed_amount` `per_long_hundred` `remainder`	Yes	The method used to allocate the payment to this account. `"fixed_amount"` means the `allocation` field will be a dollar amount to allocate to this account. `"per_long_hundred"` means the allocation will a fraction of `120` to allocate to this account (e.g. an allocation of `60` is equivalent to 50%). `"remainder"` means the remainder after all other accounts have been paid should be allocated to this account (at most 1 account will have this allocation method).
`bank_account_2_allocation`	decimal	`250` `80`	Yes	If the allocation method is `"fixed_amount"` this is the dollar amount to allocate to this account, if the allocation method is `"per_long_hundred"` this is the fraction of `120` to allocate to this account (e.g. an allocation of `40` is equivalent to one third or ≈33.33%). Null otherwise.
`bank_account_2_bsb`	bsb	`123123`	Yes	The BSB of the bank account.
`bank_account_2_name`	string	`Gabriel Dupont`	Yes	The name of the bank account.
`bank_account_2_number`	string	`123 456 789`	Yes	The number for the bank account as entered by the user (may include whitespace).
`bank_account_3_allocation_method`	allocation_method	`fixed_amount` `per_long_hundred` `remainder`	Yes	The method used to allocate the payment to this account. `"fixed_amount"` means the `allocation` field will be a dollar amount to allocate to this account. `"per_long_hundred"` means the allocation will a fraction of `120` to allocate to this account (e.g. an allocation of `60` is equivalent to 50%). `"remainder"` means the remainder after all other accounts have been paid should be allocated to this account (at most 1 account will have this allocation method).
`bank_account_3_allocation`	decimal	`250` `80`	Yes	If the allocation method is `"fixed_amount"` this is the dollar amount to allocate to this account, if the allocation method is `"per_long_hundred"` this is the fraction of `120` to allocate to this account (e.g. an allocation of `40` is equivalent to one third or ≈33.33%). Null otherwise.
`bank_account_3_bsb`	bsb	`123123`	Yes	The BSB of the bank account.
`bank_account_3_name`	string	`Gabriel Dupont`	Yes	The name of the bank account.
`bank_account_3_number`	string	`123 456 789`	Yes	The number for the bank account as entered by the user (may include whitespace).
`bank_account_4_allocation_method`	allocation_method	`fixed_amount` `per_long_hundred` `remainder`	Yes	The method used to allocate the payment to this account. `"fixed_amount"` means the `allocation` field will be a dollar amount to allocate to this account. `"per_long_hundred"` means the allocation will a fraction of `120` to allocate to this account (e.g. an allocation of `60` is equivalent to 50%). `"remainder"` means the remainder after all other accounts have been paid should be allocated to this account (at most 1 account will have this allocation method).
`bank_account_4_allocation`	decimal	`250` `80`	Yes	If the allocation method is `"fixed_amount"` this is the dollar amount to allocate to this account, if the allocation method is `"per_long_hundred"` this is the fraction of `120` to allocate to this account (e.g. an allocation of `40` is equivalent to one third or ≈33.33%). Null otherwise.
`bank_account_4_bsb`	bsb	`123123`	Yes	The BSB of the bank account.
`bank_account_4_name`	string	`Gabriel Dupont`	Yes	The name of the bank account.
`bank_account_4_number`	string	`123 456 789`	Yes	The number for the bank account as entered by the user (may include whitespace).
`bank_account_5_allocation_method`	allocation_method	`fixed_amount` `per_long_hundred` `remainder`	Yes	The method used to allocate the payment to this account. `"fixed_amount"` means the `allocation` field will be a dollar amount to allocate to this account. `"per_long_hundred"` means the allocation will a fraction of `120` to allocate to this account (e.g. an allocation of `60` is equivalent to 50%). `"remainder"` means the remainder after all other accounts have been paid should be allocated to this account (at most 1 account will have this allocation method).
`bank_account_5_allocation`	decimal	`250` `80`	Yes	If the allocation method is `"fixed_amount"` this is the dollar amount to allocate to this account, if the allocation method is `"per_long_hundred"` this is the fraction of `120` to allocate to this account (e.g. an allocation of `40` is equivalent to one third or ≈33.33%). Null otherwise.
`bank_account_5_bsb`	bsb	`123123`	Yes	The BSB of the bank account.
`bank_account_5_name`	string	`Gabriel Dupont`	Yes	The name of the bank account.
`bank_account_5_number`	string	`123 456 789`	Yes	The number for the bank account as entered by the user (may include whitespace).

Job/Position

Details about the current job and position held by the person. If the person has multiple positions their "primary" position will be used.

Column	Type	Examples	Nullable	Description
`job_id`	uuid	`511fa01c-0ffd-43e0-bd0f-f017955a45d5` `cd05fddc-ff46-4377-b1f7-2f46e63c42a8` `034539ad-32cc-4fad-a8f7-10e94f66d261` `c336d339-fce9-46dd-8dfe-90334a9fd0a2`	Yes	Internal Worknice ID for the person's primary job.
`job_title`	string	`Head of Sales` `Account Manager` `CEO`	Yes	Title of the person's primary job.
`position_id`	uuid	`511fa01c-0ffd-43e0-bd0f-f017955a45d5` `cd05fddc-ff46-4377-b1f7-2f46e63c42a8` `034539ad-32cc-4fad-a8f7-10e94f66d261` `c336d339-fce9-46dd-8dfe-90334a9fd0a2`	Yes	Internal Worknice ID for the person's primary position.
`position_code`	string	`SA001` `CEO` `AM-20-1`	Yes	An optional code used to identify the person's primary position.
`manager_position_id`	uuid	`511fa01c-0ffd-43e0-bd0f-f017955a45d5` `cd05fddc-ff46-4377-b1f7-2f46e63c42a8` `034539ad-32cc-4fad-a8f7-10e94f66d261` `c336d339-fce9-46dd-8dfe-90334a9fd0a2`	Yes	Internal Worknice ID for the position of the person's manager. A person might have a managing position that is not currently filled. In that case this value will be present, but the `manager_person_id` field will be null.
`manager_person_id`	uuid	`511fa01c-0ffd-43e0-bd0f-f017955a45d5` `cd05fddc-ff46-4377-b1f7-2f46e63c42a8` `034539ad-32cc-4fad-a8f7-10e94f66d261` `c336d339-fce9-46dd-8dfe-90334a9fd0a2`	Yes	Internal Worknice ID for the person's manager. A person might have a managing position that is not currently filled. In that case this value will be null, but the `manager_position_id` field will be present.