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

Request

POST https://keypay.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",
    "overrideTemplateRate": "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",
    "superFund1_ProductCode": "string",
    "superFund2_AllocatedPercentage": "double",
    "superFund2_FixedAmount": "double",
    "superFund2_FundName": "string",
    "superFund2_MemberNumber": "string",
    "superFund2_ProductCode": "string",
    "superFund3_AllocatedPercentage": "double",
    "superFund3_FixedAmount": "double",
    "superFund3_FundName": "string",
    "superFund3_MemberNumber": "string",
    "superFund3_ProductCode": "string",
    "superThresholdAmount": "double",
    "surname": "string",
    "tags": "string",
    "taxFileNumber": "string",
    "taxVariation": "string",
    "title": "string",
    "workPhone": "string",
    "workTypes": "string"
}

Properties

Name Type Description
afsDebt string String
anniversaryDate date-time Nullable
australianResident 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
claimTaxFreeThreshold string String
dateCreated date-time DateTime
dateOfBirth date-time Nullable
dateTaxFileDeclarationReported date-time Nullable
dateTaxFileDeclarationSigned 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
employmentAgreement string String
employmentType string String
endDate date-time Nullable
externalId string String
firstName string String
gender string String
hasApprovedWorkingHolidayVisa string String
hasWithholdingVariation string String
helpDebt string String
homePhone string String
hoursPerWeek double Nullable
id int32 Int32
isEnabledForTimesheets string String
isExemptFromFloodLevy string String
isExemptFromPayrollTax string String
jobTitle string String
leaveTemplate string String
locations string String
maximumQuarterlySuperContributionsBase double Nullable
medicareLevyExemption string String
middleName string String
mobilePhone string String
otherTaxOffset string String
overrideTemplateRate string String
payConditionRuleSet string String
payRateTemplate string String
paySchedule string String
paySlipNotificationType string String
postalAddressLine2 string String
postalCity string String
postalCounty string String
postalPostCode string String
postalState string String
postalStreetAddress string String
postalSuburb string String
preferredName string String
previousSurname string String
primaryLocation string String
primaryPayCategory string String
rate double Nullable
rateUnit string String
residentialAddressLine2 string String
residentialCity string String
residentialCounty string String
residentialPostCode string String
residentialState string String
residentialStreetAddress string String
residentialSuburb string String
rosteringNotificationChoices string String
seniorsTaxOffset string String
startDate date-time Nullable
status string EmployeeStatusEnum

Possible values are:

  • Active
  • Terminated
  • Incomplete
superFund1_AllocatedPercentage double Nullable
superFund1_FixedAmount double Nullable
superFund1_FundName string String
superFund1_MemberNumber string String
superFund1_ProductCode string String
superFund2_AllocatedPercentage double Nullable
superFund2_FixedAmount double Nullable
superFund2_FundName string String
superFund2_MemberNumber string String
superFund2_ProductCode string String
superFund3_AllocatedPercentage double Nullable
superFund3_FixedAmount double Nullable
superFund3_FundName string String
superFund3_MemberNumber string String
superFund3_ProductCode string String
superThresholdAmount double Nullable
surname string String
tags string String
taxFileNumber string String
taxVariation string String
title string String
workPhone string String
workTypes string String

Response

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

Status code Description Resource
200 OK

OK