Methods

  • get - Get contractor by identifier
  • post - Create or update contractor
  • put - Update contractor

Resource

{
    "abn": "string",
    "automaticallyPayEmployee": "string",
    "bankAccount1_AccountName": "string",
    "bankAccount1_AccountNumber": "string",
    "bankAccount1_AllocatedPercentage": "double",
    "bankAccount1_BSB": "string",
    "bankAccount1_FixedAmount": "double",
    "bankAccount2_AccountName": "string",
    "bankAccount2_AccountNumber": "string",
    "bankAccount2_AllocatedPercentage": "double",
    "bankAccount2_BSB": "string",
    "bankAccount2_FixedAmount": "double",
    "bankAccount3_AccountName": "string",
    "bankAccount3_AccountNumber": "string",
    "bankAccount3_AllocatedPercentage": "double",
    "bankAccount3_BSB": "string",
    "bankAccount3_FixedAmount": "double",
    "commissionerInstalmentRate": "double",
    "dateCreated": "date-time",
    "dateOfBirth": "date-time",
    "emailAddress": "string",
    "emergencyContact1_Address": "string",
    "emergencyContact1_AlternateContactNumber": "string",
    "emergencyContact1_ContactNumber": "string",
    "emergencyContact1_Name": "string",
    "emergencyContact1_Relationship": "string",
    "emergencyContact2_Address": "string",
    "emergencyContact2_AlternateContactNumber": "string",
    "emergencyContact2_ContactNumber": "string",
    "emergencyContact2_Name": "string",
    "emergencyContact2_Relationship": "string",
    "employingEntityABN": "string",
    "employingEntityId": "string",
    "endDate": "date-time",
    "externalId": "string",
    "firstName": "string",
    "hoursPerDay": "double",
    "hoursPerWeek": "double",
    "id": "int32",
    "isEnabledForTimesheets": "string",
    "locations": "string",
    "middleName": "string",
    "mobilePhone": "string",
    "paySchedule": "string",
    "payrollId": "string",
    "postalAddressIsOverseas": "boolean",
    "postalAddressLine2": "string",
    "postalCountry": "string",
    "postalPostCode": "string",
    "postalState": "string",
    "postalStreetAddress": "string",
    "postalSuburb": "string",
    "preferredName": "string",
    "primaryLocation": "string",
    "primaryPayCategory": "string",
    "rate": "double",
    "rateUnit": "string",
    "registeredForGst": "string",
    "reportingDimensionValues": "string",
    "residentialAddressIsOverseas": "boolean",
    "residentialAddressLine2": "string",
    "residentialCountry": "string",
    "residentialPostCode": "string",
    "residentialState": "string",
    "residentialStreetAddress": "string",
    "residentialSuburb": "string",
    "startDate": "date-time",
    "status": "string",
    "superFund1_AllocatedPercentage": "double",
    "superFund1_EmployerNominatedFund": "boolean",
    "superFund1_FixedAmount": "double",
    "superFund1_FundName": "string",
    "superFund1_MemberNumber": "string",
    "superFund1_ProductCode": "string",
    "superFund2_AllocatedPercentage": "double",
    "superFund2_EmployerNominatedFund": "boolean",
    "superFund2_FixedAmount": "double",
    "superFund2_FundName": "string",
    "superFund2_MemberNumber": "string",
    "superFund2_ProductCode": "string",
    "superFund3_AllocatedPercentage": "double",
    "superFund3_EmployerNominatedFund": "boolean",
    "superFund3_FixedAmount": "double",
    "superFund3_FundName": "string",
    "superFund3_MemberNumber": "string",
    "superFund3_ProductCode": "string",
    "surname": "string",
    "taxCalculation": "string",
    "taxFileNumber": "string",
    "terminationReason": "string",
    "title": "string",
    "tradingName": "string",
    "workTypes": "string"
}

Properties

Name Type Description
abn string String
automaticallyPayEmployee string String
bankAccount1_AccountName string String
bankAccount1_AccountNumber string String
bankAccount1_AllocatedPercentage double Nullable
bankAccount1_BSB string String
bankAccount1_FixedAmount double Nullable
bankAccount2_AccountName string String
bankAccount2_AccountNumber string String
bankAccount2_AllocatedPercentage double Nullable
bankAccount2_BSB string String
bankAccount2_FixedAmount double Nullable
bankAccount3_AccountName string String
bankAccount3_AccountNumber string String
bankAccount3_AllocatedPercentage double Nullable
bankAccount3_BSB string String
bankAccount3_FixedAmount double Nullable
commissionerInstalmentRate double Nullable
dateCreated date-time DateTime
dateOfBirth date-time Nullable
emailAddress string String
emergencyContact1_Address string String
emergencyContact1_AlternateContactNumber string String
emergencyContact1_ContactNumber string String
emergencyContact1_Name string String
emergencyContact1_Relationship string String
emergencyContact2_Address string String
emergencyContact2_AlternateContactNumber string String
emergencyContact2_ContactNumber string String
emergencyContact2_Name string String
emergencyContact2_Relationship string String
employingEntityABN string String
employingEntityId string String
endDate date-time Nullable
externalId string String
firstName string String
hoursPerDay double Nullable
hoursPerWeek double Nullable
id int32 Int32
isEnabledForTimesheets string String
locations string String
middleName string String
mobilePhone string String
paySchedule string String
payrollId string String
postalAddressIsOverseas boolean Nullable
postalAddressLine2 string String
postalCountry string String
postalPostCode string String
postalState string String
postalStreetAddress string String
postalSuburb string String
preferredName string String
primaryLocation string String
primaryPayCategory string String
rate double Nullable
rateUnit string String
registeredForGst string String
reportingDimensionValues string String
residentialAddressIsOverseas boolean Nullable
residentialAddressLine2 string String
residentialCountry string String
residentialPostCode string String
residentialState string String
residentialStreetAddress string String
residentialSuburb string String
startDate date-time Nullable
status string EmployeeStatusEnum

Possible values are:

  • Active
  • Terminated
  • Incomplete
superFund1_AllocatedPercentage double Nullable
superFund1_EmployerNominatedFund boolean Nullable
superFund1_FixedAmount double Nullable
superFund1_FundName string String
superFund1_MemberNumber string String
superFund1_ProductCode string String
superFund2_AllocatedPercentage double Nullable
superFund2_EmployerNominatedFund boolean Nullable
superFund2_FixedAmount double Nullable
superFund2_FundName string String
superFund2_MemberNumber string String
superFund2_ProductCode string String
superFund3_AllocatedPercentage double Nullable
superFund3_EmployerNominatedFund boolean Nullable
superFund3_FixedAmount double Nullable
superFund3_FundName string String
superFund3_MemberNumber string String
superFund3_ProductCode string String
surname string String
taxCalculation string String
taxFileNumber string String
terminationReason string String
title string String
tradingName string String
workTypes string String