Updates the employee with the specified ID. Only fields to be updated need be specified. Fields left unspecified or null will not be changed. To update a field provide the new value, to specifically clear a value use the string "(clear)" or "0".

Request

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

Path parameters

Request body

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

{
    "anniversaryDate": "date-time",
    "australianResident": "boolean",
    "automaticallyApplyPublicHolidayNotWorkedEarningsLines": "boolean",
    "automaticallyPayEmployee": "string",
    "awardId": "int32",
    "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",
    "businessAwardPackage": "string",
    "claimMedicareLevyReduction": "boolean",
    "claimTaxFreeThreshold": "boolean",
    "closelyHeldEmployee": "boolean",
    "closelyHeldReporting": "string",
    "contractorABN": "string",
    "dateCreated": "date-time",
    "dateOfBirth": "date-time",
    "dateTaxFileDeclarationReported": "date-time",
    "dateTaxFileDeclarationSigned": "date-time",
    "disableAutoProgression": "boolean",
    "dvlPaySlipDescription": "string",
    "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",
    "employmentAgreement": "string",
    "employmentAgreementId": "int32",
    "employmentType": "string",
    "endDate": "date-time",
    "externalId": "string",
    "firstName": "string",
    "gender": "string",
    "hasApprovedWorkingHolidayVisa": "boolean",
    "hasWithholdingVariation": "boolean",
    "homePhone": "string",
    "hoursPerDay": "double",
    "hoursPerWeek": "double",
    "id": "int32",
    "includeInPortableLongServiceLeaveReport": "boolean",
    "isEnabledForTimesheets": "string",
    "isExemptFromFloodLevy": "boolean",
    "isExemptFromPayrollTax": "boolean",
    "isSeasonalWorker": "boolean",
    "jobTitle": "string",
    "leaveAccrualStartDateType": "string",
    "leaveTemplate": "string",
    "leaveYearStart": "date-time",
    "locations": "string",
    "maximumQuarterlySuperContributionsBase": "double",
    "medicareLevyExemption": "string",
    "medicareLevyReductionDependentCount": "int32",
    "medicareLevyReductionSpouse": "boolean",
    "medicareLevySurchargeWithholdingTier": "string",
    "middleName": "string",
    "mobilePhone": "string",
    "otherTaxOffset": "boolean",
    "overrideTemplateRate": "string",
    "payConditionRuleSet": "string",
    "payRateTemplate": "string",
    "paySchedule": "string",
    "paySlipNotificationType": "string",
    "portableLongServiceLeaveId": "string",
    "postalAddressIsOverseas": "boolean",
    "postalAddressLine2": "string",
    "postalCountry": "string",
    "postalPostCode": "string",
    "postalState": "string",
    "postalStreetAddress": "string",
    "postalSuburb": "string",
    "preferredName": "string",
    "previousSurname": "string",
    "primaryLocation": "string",
    "primaryPayCategory": "string",
    "rate": "double",
    "rateUnit": "string",
    "reportingDimensionValues": "string",
    "residentialAddressIsOverseas": "boolean",
    "residentialAddressLine2": "string",
    "residentialCountry": "string",
    "residentialPostCode": "string",
    "residentialState": "string",
    "residentialStreetAddress": "string",
    "residentialSuburb": "string",
    "rosteringNotificationChoices": "string",
    "seniorsTaxOffset": "boolean",
    "singleTouchPayroll": "string",
    "startDate": "date-time",
    "status": "string",
    "stslDebt": "boolean",
    "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",
    "superThresholdAmount": "double",
    "surname": "string",
    "tags": "string",
    "taxCategory": "string",
    "taxFileNumber": "string",
    "taxVariation": "double",
    "terminationReason": "string",
    "title": "string",
    "workPhone": "string",
    "workTypes": "string",
    "workingHolidayVisaCountry": "string",
    "workingHolidayVisaStartDate": "date-time"
}

Properties

Response

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