If the employee with the specified ID already exists, update it. Otherwise, create a new employee.

Request

POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/employee/unstructured

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

The request body takes a complete UnstructuredEmployeeModel resource, containing the following writable properties:

{
    "afsDebt": "string",
    "anniversaryDate": "date-time",
    "australianResident": "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",
    "claimTaxFreeThreshold": "string",
    "dateCreated": "date-time",
    "dateOfBirth": "date-time",
    "dateTaxFileDeclarationReported": "date-time",
    "dateTaxFileDeclarationSigned": "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",
    "employmentAgreement": "string",
    "employmentType": "string",
    "endDate": "date-time",
    "externalId": "string",
    "firstName": "string",
    "gender": "string",
    "hasApprovedWorkingHolidayVisa": "string",
    "hasWithholdingVariation": "string",
    "helpDebt": "string",
    "homePhone": "string",
    "hoursPerWeek": "double",
    "id": "int32",
    "isEnabledForTimesheets": "string",
    "isExemptFromFloodLevy": "string",
    "isExemptFromPayrollTax": "string",
    "jobTitle": "string",
    "leaveTemplate": "string",
    "locations": "string",
    "maximumQuarterlySuperContributionsBase": "double",
    "medicareLevyExemption": "string",
    "middleName": "string",
    "mobilePhone": "string",
    "otherTaxOffset": "string",
    "payConditionRuleSet": "string",
    "payRateTemplate": "string",
    "paySchedule": "string",
    "paySlipNotificationType": "string",
    "postalAddressLine2": "string",
    "postalCity": "string",
    "postalCounty": "string",
    "postalPostCode": "string",
    "postalState": "string",
    "postalStreetAddress": "string",
    "postalSuburb": "string",
    "preferredName": "string",
    "previousSurname": "string",
    "primaryLocation": "string",
    "primaryPayCategory": "string",
    "rate": "double",
    "rateUnit": "string",
    "residentialAddressLine2": "string",
    "residentialCity": "string",
    "residentialCounty": "string",
    "residentialPostCode": "string",
    "residentialState": "string",
    "residentialStreetAddress": "string",
    "residentialSuburb": "string",
    "rosteringNotificationChoices": "string",
    "seniorsTaxOffset": "string",
    "startDate": "date-time",
    "status": "string",
    "superFund1_AllocatedPercentage": "double",
    "superFund1_FixedAmount": "double",
    "superFund1_FundName": "string",
    "superFund1_MemberNumber": "string",
    "superFund2_AllocatedPercentage": "double",
    "superFund2_FixedAmount": "double",
    "superFund2_FundName": "string",
    "superFund2_MemberNumber": "string",
    "superFund3_AllocatedPercentage": "double",
    "superFund3_FixedAmount": "double",
    "superFund3_FundName": "string",
    "superFund3_MemberNumber": "string",
    "superThresholdAmount": "double",
    "surname": "string",
    "tags": "string",
    "taxFileNumber": "string",
    "taxVariation": "string",
    "title": "string",
    "workPhone": "string",
    "workTypes": "string"
}

Properties

Name Type
afsDebt string
anniversaryDate date-time
australianResident 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
claimTaxFreeThreshold string
dateCreated date-time
dateOfBirth date-time
dateTaxFileDeclarationReported date-time
dateTaxFileDeclarationSigned 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
employmentAgreement string
employmentType string
endDate date-time
externalId string
firstName string
gender string
hasApprovedWorkingHolidayVisa string
hasWithholdingVariation string
helpDebt string
homePhone string
hoursPerWeek double
id int32
isEnabledForTimesheets string
isExemptFromFloodLevy string
isExemptFromPayrollTax string
jobTitle string
leaveTemplate string
locations string
maximumQuarterlySuperContributionsBase double
medicareLevyExemption string
middleName string
mobilePhone string
otherTaxOffset string
payConditionRuleSet string
payRateTemplate string
paySchedule string
paySlipNotificationType string
postalAddressLine2 string
postalCity string
postalCounty string
postalPostCode string
postalState string
postalStreetAddress string
postalSuburb string
preferredName string
previousSurname string
primaryLocation string
primaryPayCategory string
rate double
rateUnit string
residentialAddressLine2 string
residentialCity string
residentialCounty string
residentialPostCode string
residentialState string
residentialStreetAddress string
residentialSuburb string
rosteringNotificationChoices string
seniorsTaxOffset string
startDate date-time
status string
superFund1_AllocatedPercentage double
superFund1_FixedAmount double
superFund1_FundName string
superFund1_MemberNumber string
superFund2_AllocatedPercentage double
superFund2_FixedAmount double
superFund2_FundName string
superFund2_MemberNumber string
superFund3_AllocatedPercentage double
superFund3_FixedAmount double
superFund3_FundName string
superFund3_MemberNumber string
superThresholdAmount double
surname string
tags string
taxFileNumber string
taxVariation string
title string
workPhone string
workTypes string

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK