POST api/ChangeEmployee
All requests to change an Employee are considered to be new requests and must be a POST. Do not use PUT or DELETE, rather set the ChangeType to one of Add, Change, or Delete and POST the request.
Request Information
URI Parameters
(i.e.queryString parameters in the form ?param1={param1}¶m2={param2})
None.
Body Parameters
ChangeEmployeeViewName | Description | Type | Additional information |
---|---|---|---|
Change  EmployeeId |
The unique id assigned to this ChangeEmployee request once it is validated and saved. ReadOnly |
integer |
None. |
ChangeType |
Indicates the type of request being made:
Use: Required |
string |
Required Matching: ([^'"])* Max length: 20 |
ChangeStatus |
Indicates the status of the current request. Leave blank when submitting a new request. ReadOnly |
string |
Matching: ([^'"])* Max length: 20 |
ReceivedDate |
Set when a validated request is saved. ReadOnly |
date |
None. |
ReceivedDate  Time |
Set when a validated request is saved. ReadOnly |
date |
None. |
PickedUpDate  Time |
Set when a validated request is picked up by the DTS and inserted in to the Payroll Database staged table. ReadOnly |
date |
None. |
PickedUpDate |
Set when a validated request is picked up by the DTS and inserted in to the Payroll Database staged table. ReadOnly |
date |
None. |
RejectedDate  Time |
Set when a validated request is accepted and implemented by payroll. ReadOnly |
date |
None. |
RejectedDate |
Set when a validated request is Rejected by payroll. ReadOnly |
date |
None. |
ImplementedDate  Time |
Set when a validated request is Rejected by payroll. ReadOnly |
date |
None. |
ImplementedDate |
Set when a validated request is accepted and implemented by payroll. ReadOnly |
date |
None. |
EffectiveDate |
Use to give an indication to payroll when this change should be applied. It is a suggestion only. |
date |
None. |
Validation  Result |
Set automatically to: 0 when a request is submitted; 1 when a request is validated. ReadOnly |
integer |
None. |
ErrorMessage |
May contain errors identified when the request is processed by payroll. ReadOnly |
string |
Matching: ([^'"])* Max length: 500 |
EmpCode |
The unique code identifing the actual ChangeEmployee record in question. This code is required input on ALL requests. Meridian: Maximum length allowed is 8 characters.WageEasy: Maximim length allowed is 20 characters.Required |
string |
Required Matching: ([^'"])* |
Surname |
The employee's surname (last name/family name). Required when the ChangeType is Add, optional for all other ChangeTypes. Meridian: Maximum length allowed is 40 characters.WageEasy: Maximum length allowed is 50 characters.Required |
string |
Matching: ([^"])* |
Location |
The employee's location for payroll purposes. Meridian: Required when the ChangeType is Add, optional for all other ChangeTypes.Allowed values: Must be one of the valid Location values in the target payroll database. WageEasy: Location codes may be found using api/Lookups?type=Location |
string |
Matching: ([^"])* |
PayrollCompany |
The employee's payroll company. Meridian: Required when the ChangeType is Add, optional for all other ChangeTypes.Allowed values: Must be one of the valid Payroll Company codes in the target payroll database. Maximum length allowed is 10 characters.WageEasy: PayrollCompany codes may be found using api/Lookups?type=PayrollCompany |
string |
Matching: ([^'"])* Max length: 10 |
PayFrequency |
The pay frequency or cycle the Employee will be paid on. Meridian: Required when the ChangeType is Add, optional for all other ChangeTypes.Allowed values: Must be one of the valid PayFrequency codes in the target payroll database. Maximum length allowed is 10 characters.WageEasy: PayFrequency codes may be found using api/Lookups?type=PayFrequency |
string |
Matching: ([^'"])* |
PayPoint |
The pay point where the Employee will be paid. Meridian: Required when the ChangeType is Add, optional for all other ChangeTypes.Allowed values: Must be one of the valid PayPoint codes in the target payroll database. Maximum length allowed is 10 characters.WageEasy: PayPoint codes may be found using api/Lookups?type=PayPoint |
string |
Matching: ([^'"])* Max length: 30 |
Title |
The employee's salutation or title (e.g. Mr, Mrs, Sir, Doctor or Air Vice Marshall, etc). Meridian: Allowed values: Must be one of the valid Title values in the target payroll database. Maximum length allowed is 50 characters.WageEasy: Maximum length allowed is 15 characters. Title codes may be found using api/Lookups?type=Title |
string |
Matching: ([^'"])* |
Gender |
The employee's sex (gender). Typically allowed values: Male, Female or Other but refer to the Gender Lookup for a full list Gender codes may be found at using api/Lookups?type=Gender |
string |
Matching: ([^'"])* Max length: 20 |
FirstName |
The employee's first name (given name/Christian name). Meridian: Maximum length allowed is 20 characters.WageEasy: Maximum length allowed is 30 characters. |
string |
Matching: ([^"])* Max length: 30 |
MiddleName |
The employee's middle name. Meridian: Maximum length allowed is 15 characters. |
string |
Matching: ([^"])* |
PreferredName |
The employee's preferred name. Meridian: Maximum length allowed is 15 characters. |
string |
Matching: ([^"])* |
MaritalStatus |
The employee's marital status. Typically allowed values: Divorced, Married, Not Applicable, Single, Widowed but refer to teh MaritalStatus lookup MaritalStatus codes may be found using api/Lookups?type=MaritalStatus |
string |
Matching: ([^'"])* |
Street |
The street address where the Employee lives. Meridian: Maximum length allowed is 40 characters.WageEasy: Maximum length allowed is 225 characters. |
string |
Matching: ([^"])* |
SuburbCity |
The suburb where the Employee lives.
Meridian: WageEasy: |
string |
Matching: ([^"])* Max length: 40 |
State |
The state in which the Employee lives.
Meridian: WageEasy: |
string |
Matching: ([^'"])* |
Postcode |
The postcode where the Employee lives. |
string |
Matching: ([^'"])* Max length: 10 |
Country |
The country in which the Employee lives. Meridian: Maximum length allowed is 30 characters.WageEasy: Maximum length allowed is 40 characters. Country codes may be found using api/Lookups?type=Country |
string |
Matching: ([^'"])* Max length: 100 |
PostalStreet |
The street address for the employee's postal address. Meridian: Maximum length allowed is 40 characters.WageEasy: Maximum length allowed is 225 characters. |
string |
Matching: ([^"])* |
PostalSuburb  City |
The suburb for the employee's postal address. Meridian: Maximum length allowed is 30 characters.WageEasy: Maximum length allowed is |
string |
Matching: ([^"])* Max length: 40 |
PostalState |
The state for the employee's postal address. Meridian: Maximum length allowed is 6 characters.WageEasy: Maximum length allowed is 10 characters. State codes may be found using api/Lookups?type=State |
string |
Matching: ([^'"])* |
PostalPostcode |
The post code for the employee's postal address. |
string |
Matching: ([^'"])* Max length: 10 |
PostalCountry |
The country for the employee's postal address. Meridian: Maximum length allowed is 30 characters.WageEasy: Maximum length allowed is 40 characters. |
string |
Matching: ([^'"])* Max length: 100 |
Telephone1 |
The employee's primary or default telephone number. |
string |
Matching: ([^'"])* Max length: 20 |
Telephone2 |
The employee's alternative (mobile) telephone number. |
string |
Matching: ([^'"])* Max length: 20 |
PaymentMethod |
The method used to actually pay the ChangeEmployee. Allowed values:Envelope, DirectDeposit, TransferEFT, AdviceOnly |
string |
Matching: ([^'"])* Max length: 20 |
HiredDate |
The date the Employee commence work. |
date |
None. |
DefaultEmail |
The employee's preferred email address. Meridian: Maximum length allowed is 100 characters.WageEasy: Maximum length allowed is 85 characters. |
string |
Matching: ([^"])* Max length: 100 |
DefaultEmailUsed  ForPayslips |
Is the employee's default email to be used as the address for emailing pay advices Meridian: Allowed values:True or False WageEasy: |
boolean |
None. |
DateOfBirth |
The employee's date of birth. |
date |
None. |
AboriginalTorres  Strait |
Indicates the employee's Aborginal or Torres Strait Islander status. Allowed values:Unknown, Aboriginal, Islander, Declined, Both, Neither |
string |
Matching: ([^'"])* Max length: 10 |
Job  Classification |
The employee's job classification. Meridian: Allowed values:Must be one of the valid job classification values in the target payroll database. JobClassification codes may be found using api/Lookups?type=JobClassification |
string |
Matching: ([^'"])* |
WorkersCompCode |
The employee's job classification. Meridian: Allowed values:Must be one of the valid job classification values in the target payroll database. WageEasy: WorkersCompCode codes may be found using api/Lookups?type=WorkersComp |
string |
Matching: ([^'"])* Max length: 10 |
UserDefined  Fields |
UserDefinedFields A semi colon separated list of fieldname=value pairs Each field name must start with u{c|f|i|d|b|l}EE followed by a fieldname |
string |
None. |
ChangeEmployee  AddDedView |
Collection of ChangeEmployee  AddDedView |
None. |
|
ChangeEmployee  AddRateView |
Collection of ChangeEmployee  AddRateView |
None. |
|
ChangeEmployee  BankView |
Collection of ChangeEmployee  BankView |
None. |
|
ChangeEmployee  DetailView |
Collection of ChangeEmployee  DetailView |
None. |
|
ChangeEmployee  LeaveView |
Collection of ChangeEmployee  LeaveView |
None. |
|
ChangeEmployee  SuperContView |
Collection of ChangeEmployee  SuperContView |
None. |
|
ChangeEmployee  EmailView |
The Employee Email View is a placeholder for a future release. This property is currently not supported, and the "DefaultEmail" property should be used instead. |
Collection of ChangeEmployee  EmailView |
None. |
Immediate  Immediately |
boolean |
None. |
|
PostedDate | date |
None. |
|
PostedDateTime | date |
None. |
|
UserId | integer |
None. |
|
UserName | string |
None. |
|
UserType | string |
None. |
|
PayrollDatabase | globally unique identifier |
None. |
|
DatabaseType | string |
None. |
|
SuppressedDate | date |
None. |
|
SuppressedDate  Time |
date |
None. |
|
ActionedDate | date |
None. |
|
ActionedDate  Time |
date |
None. |
|
PayrollLink  Token |
globally unique identifier |
None. |
|
OnBoarding | boolean |
None. |
|
ReferenceNumber |
Either not include any value for the ReferenceNumber field or to ensure the ReferenceNumber field is unique for each POST request when value is provided to this field. |
string |
None. |
Comment | string |
None. |
|
IsEss | boolean |
None. |
Request Formats
application/json, text/json
{ "changeEmployeeId": 1, "changeType": "sample string 1", "changeStatus": "sample string 2", "receivedDate": "2024-11-20T21:44:53.4261506+11:00", "receivedDateTime": "2024-11-20T21:44:53.4261506+11:00", "pickedUpDateTime": "2024-11-20T21:44:53.4261506+11:00", "pickedUpDate": "2024-11-20T21:44:53.4261506+11:00", "rejectedDateTime": "2024-11-20T21:44:53.4261506+11:00", "rejectedDate": "2024-11-20T21:44:53.4261506+11:00", "implementedDateTime": "2024-11-20T21:44:53.4261506+11:00", "implementedDate": "2024-11-20T21:44:53.4261506+11:00", "effectiveDate": "2024-11-20T21:44:53.4261506+11:00", "validationResult": 1, "errorMessage": "sample string 3", "empCode": "sample string 4", "surname": "sample string 5", "location": "sample string 6", "payrollCompany": "sample string 7", "payFrequency": "sample string 8", "payPoint": "sample string 9", "title": "sample string 10", "gender": "sample string 11", "firstName": "sample string 12", "middleName": "sample string 13", "preferredName": "sample string 14", "maritalStatus": "sample string 15", "street": "sample string 16", "suburbCity": "sample string 17", "state": "sample string 18", "postcode": "sample string 19", "country": "sample string 20", "postalStreet": "sample string 21", "postalSuburbCity": "sample string 22", "postalState": "sample string 23", "postalPostcode": "sample string 24", "postalCountry": "sample string 25", "telephone1": "sample string 26", "telephone2": "sample string 27", "paymentMethod": "sample string 28", "hiredDate": "2024-11-20T21:44:53.4261506+11:00", "defaultEmail": "sample string 29", "defaultEmailUsedForPayslips": true, "dateOfBirth": "2024-11-20T21:44:53.4261506+11:00", "aboriginalTorresStrait": "sample string 30", "jobClassification": "sample string 31", "workersCompCode": "sample string 32", "userDefinedFields": "sample string 33", "changeEmployeeAddDedView": [ { "changeEmployeeAddDedId": 1, "changeEmployeeId": 1, "changeType": "sample string 1", "changeStatus": "sample string 2", "empCode": "sample string 3", "addDedCode": "sample string 4", "loadFromRegister": true, "value": 1.0, "standard": 1.0, "costAccount": "sample string 5", "memberNumber": "sample string 6" } ], "changeEmployeeAddRateView": [ { "changeEmployeeAddRateId": 1, "changeEmployeeId": 1, "changeType": "sample string 1", "changeStatus": "sample string 2", "empCode": "sample string 3", "rateCode": "sample string 4", "rate": 1.1 } ], "changeEmployeeBankView": [ { "changeEmployeeBankId": 1, "changeEmployeeId": 1, "changeType": "sample string 1", "changeStatus": "sample string 2", "empCode": "sample string 3", "bsbCode": "sample string 4", "accountNumber": "sample string 5", "eftCode": "sample string 6", "accountName": "sample string 7", "payAmount": 1.0, "balanceOfPay": true, "order": 1, "bankName": "sample string 8", "bankBranchName": "sample string 9", "bankState": "sample string 10" } ], "changeEmployeeDetailView": [ { "changeEmployeeDetailId": 1, "changeEmployeeId": 1, "changeType": "sample string 1", "changeStatus": "sample string 2", "tfn": "sample string 3", "abn": "sample string 4", "basisOfPayment": "sample string 5", "isAustralianResident": true, "isWorkingHolidayMaker": true, "visaCountry": "sample string 6", "medicareClaimsReduction": true, "medicareNumberOfChildren": 1, "hecs": true, "sfss": true, "generateAutopay": "sample string 7", "employmentType": "sample string 8", "minimumPay": 1.0, "maximumPay": 1.0, "serviceHoursToDate": 1.0, "normalHours": 1.0, "payClass": "sample string 9", "rateIncreaseCode": "sample string 10", "yearlySalary": 1.0, "autopayAmount": 1.0, "normalRate": 1.0, "timeAndHalfRate": 1.0, "doubleTimeRate": 1.0, "otherRate": 1.0, "awardRate": 1.0, "defaultCostAccount": "sample string 11", "workPlannerCode": "sample string 12", "terminationDate": "2024-11-20T21:44:53.4261506+11:00", "terminationReason": "sample string 13", "nzStudentLoan": true, "nzSpecifySLRate": true, "nzStudentLoanTaxRate": 1.0, "nzExcludeFromEMS": true, "nzWithholdingTax": true, "irdEmployeeName": "sample string 14", "tfnDateSigned": "2024-11-20T21:44:53.4261506+11:00", "tfnForSuper": "sample string 15", "taxScaleCode": "sample string 16", "specifyTaxRate": 1.0, "familyTaxBenefit": true, "otherRebates": true, "totalRebates": 1.0, "dailyTaxing": true, "variationDate": "2024-11-20T21:44:53.4261506+11:00", "reportableFringeBenefit": 1.0, "otherIncome": 1.0, "nonCashBenefit": 1.0, "paymentType": "sample string 17", "earningsType": "sample string 18", "contractHoursCode": "sample string 19", "autopayType": "sample string 20", "workPatternCode": "sample string 21", "workPatternCycleStartDay": 1, "workPatternEffectiveFrom": "2024-11-20T21:44:53.4261506+11:00", "awardCode": "sample string 22", "awardClassificationCode": "sample string 23", "awardCategoryCode": "sample string 24", "awardConditionGroup": "sample string 25", "awardUseThisRate": 1.0, "awardNormalHours": 1.0, "awardYearlySalary": 1.0, "personalEmail": "sample string 26", "basisOfEmployment": "sample string 27", "tfnPensioner": true, "tfnTaxFree": true, "tfnTaxOffset": true, "tfnPreviousSurname": "sample string 28", "reportingTo": "sample string 29", "tfnEmployeeDeclaration": true, "abnPayeeDeclaration": true, "atoConsent": true, "isAnnualisedSalary": true, "annualisedAnniversaryDate": "2024-11-20T21:44:53.4261506+11:00" } ], "changeEmployeeLeaveView": [ { "changeEmployeeLeaveId": 1, "changeEmployeeId": 1, "changeType": "sample string 1", "changeStatus": "sample string 2", "empCode": "sample string 3", "leaveType": "sample string 4", "leaveCode": "sample string 5", "costAccount": "sample string 6", "leaveLoadingClass": "sample string 7", "ytdLeaveLoading": 1.0, "entitlementDate": "2024-11-20T21:44:53.4261506+11:00", "entitlementHours": 1.0, "proRataDate": "2024-11-20T21:44:53.4261506+11:00", "proRataHours": 1.0, "rate": 1.0, "nonEntMonths": 1, "firstEntitlementPeriod": true, "referenceNumber": "sample string 8" } ], "changeEmployeeSuperContView": [ { "changeEmployeeSuperContId": 1, "changeEmployeeId": 1, "changeType": "sample string 1", "changeStatus": "sample string 2", "empCode": "sample string 3", "fundCode": "sample string 4", "dateJoined": "2024-11-20T21:44:53.4261506+11:00", "membershipNumber": "sample string 5", "accountName": "sample string 6", "categoryCode": "sample string 7", "salaryForSuper": 1.0, "contributionCode": "sample string 8", "contributionType": "sample string 9", "contributionAmount": 1.0, "allocation": 1.0, "costAccount": "sample string 10", "isPrimaryContribution": true, "defaultFund": true, "usi": "sample string 11", "smsf": true, "esa": "sample string 12", "fundABN": "sample string 13", "fundName": "sample string 14", "fundBSB": "sample string 15", "fundAddress1": "sample string 16", "fundAddress2": "sample string 17", "fundSuburb": "sample string 18", "fundState": "sample string 19", "fundPostcode": "sample string 20", "fundPhone": "sample string 21", "fundAccountNumber": "sample string 22" } ], "changeEmployeeEmailView": [ { "changeEmployeeEmailId": 1, "changeEmployeeId": 1, "changeType": "sample string 1", "changeStatus": "sample string 2", "empCode": "sample string 3", "emailAddress": "sample string 4", "useAsDefault": true, "useForPayslips": true, "zipPassword": "sample string 5", "useForPaymentSummaries": true, "emailType": "sample string 6" } ], "immediateImmediately": true, "postedDate": "2024-11-20T21:44:53.4261506+11:00", "postedDateTime": "2024-11-20T21:44:53.4261506+11:00", "userId": 1, "userName": "sample string 35", "userType": "sample string 36", "payrollDatabase": "cbb2a223-c82e-4245-9426-d175f73a5aff", "databaseType": "sample string 38", "suppressedDate": "2024-11-20T21:44:53.4261506+11:00", "suppressedDateTime": "2024-11-20T21:44:53.4261506+11:00", "actionedDate": "2024-11-20T21:44:53.4261506+11:00", "actionedDateTime": "2024-11-20T21:44:53.4261506+11:00", "payrollLinkToken": "da7f5daf-bcc8-4a4c-a16f-4e989dfb7b67", "onBoarding": true, "referenceNumber": "sample string 39", "comment": "sample string 40", "isEss": true }
application/xml, text/xml
<ChangeEmployeeView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ChangeEmployeeId>1</ChangeEmployeeId> <ChangeType>sample string 1</ChangeType> <ChangeStatus>sample string 2</ChangeStatus> <ReceivedDate>2024-11-20T21:44:53.4261506+11:00</ReceivedDate> <ReceivedDateTime>2024-11-20T21:44:53.4261506+11:00</ReceivedDateTime> <PickedUpDateTime>2024-11-20T21:44:53.4261506+11:00</PickedUpDateTime> <PickedUpDate>2024-11-20T21:44:53.4261506+11:00</PickedUpDate> <RejectedDateTime>2024-11-20T21:44:53.4261506+11:00</RejectedDateTime> <RejectedDate>2024-11-20T21:44:53.4261506+11:00</RejectedDate> <ImplementedDateTime>2024-11-20T21:44:53.4261506+11:00</ImplementedDateTime> <ImplementedDate>2024-11-20T21:44:53.4261506+11:00</ImplementedDate> <EffectiveDate>2024-11-20T21:44:53.4261506+11:00</EffectiveDate> <ValidationResult>1</ValidationResult> <ErrorMessage>sample string 3</ErrorMessage> <EmpCode>sample string 4</EmpCode> <Surname>sample string 5</Surname> <Location>sample string 6</Location> <PayrollCompany>sample string 7</PayrollCompany> <PayFrequency>sample string 8</PayFrequency> <PayPoint>sample string 9</PayPoint> <Title>sample string 10</Title> <Gender>sample string 11</Gender> <FirstName>sample string 12</FirstName> <MiddleName>sample string 13</MiddleName> <PreferredName>sample string 14</PreferredName> <MaritalStatus>sample string 15</MaritalStatus> <Street>sample string 16</Street> <SuburbCity>sample string 17</SuburbCity> <State>sample string 18</State> <Postcode>sample string 19</Postcode> <Country>sample string 20</Country> <PostalStreet>sample string 21</PostalStreet> <PostalSuburbCity>sample string 22</PostalSuburbCity> <PostalState>sample string 23</PostalState> <PostalPostcode>sample string 24</PostalPostcode> <PostalCountry>sample string 25</PostalCountry> <Telephone1>sample string 26</Telephone1> <Telephone2>sample string 27</Telephone2> <PaymentMethod>sample string 28</PaymentMethod> <HiredDate>2024-11-20T21:44:53.4261506+11:00</HiredDate> <DefaultEmail>sample string 29</DefaultEmail> <DefaultEmailUsedForPayslips>true</DefaultEmailUsedForPayslips> <DateOfBirth>2024-11-20T21:44:53.4261506+11:00</DateOfBirth> <AboriginalTorresStrait>sample string 30</AboriginalTorresStrait> <JobClassification>sample string 31</JobClassification> <WorkersCompCode>sample string 32</WorkersCompCode> <UserDefinedFields>sample string 33</UserDefinedFields> <ChangeEmployeeAddDedView> <ChangeEmployeeAddDedView> <ChangeEmployeeAddDedId>1</ChangeEmployeeAddDedId> <ChangeEmployeeId>1</ChangeEmployeeId> <ChangeType>sample string 1</ChangeType> <ChangeStatus>sample string 2</ChangeStatus> <EmpCode>sample string 3</EmpCode> <AddDedCode>sample string 4</AddDedCode> <LoadFromRegister>true</LoadFromRegister> <Value>1</Value> <Standard>1</Standard> <CostAccount>sample string 5</CostAccount> <MemberNumber>sample string 6</MemberNumber> </ChangeEmployeeAddDedView> </ChangeEmployeeAddDedView> <ChangeEmployeeAddRateView> <ChangeEmployeeAddRateView> <ChangeEmployeeAddRateId>1</ChangeEmployeeAddRateId> <ChangeEmployeeId>1</ChangeEmployeeId> <ChangeType>sample string 1</ChangeType> <ChangeStatus>sample string 2</ChangeStatus> <EmpCode>sample string 3</EmpCode> <RateCode>sample string 4</RateCode> <Rate>1.1</Rate> </ChangeEmployeeAddRateView> </ChangeEmployeeAddRateView> <ChangeEmployeeBankView> <ChangeEmployeeBankView> <ChangeEmployeeBankId>1</ChangeEmployeeBankId> <ChangeEmployeeId>1</ChangeEmployeeId> <ChangeType>sample string 1</ChangeType> <ChangeStatus>sample string 2</ChangeStatus> <EmpCode>sample string 3</EmpCode> <BSBCode>sample string 4</BSBCode> <AccountNumber>sample string 5</AccountNumber> <EFTCode>sample string 6</EFTCode> <AccountName>sample string 7</AccountName> <PayAmount>1</PayAmount> <BalanceOfPay>true</BalanceOfPay> <Order>1</Order> <BankName>sample string 8</BankName> <BankBranchName>sample string 9</BankBranchName> <BankState>sample string 10</BankState> </ChangeEmployeeBankView> </ChangeEmployeeBankView> <ChangeEmployeeDetailView> <ChangeEmployeeDetailView> <ChangeEmployeeDetailId>1</ChangeEmployeeDetailId> <ChangeEmployeeId>1</ChangeEmployeeId> <ChangeType>sample string 1</ChangeType> <ChangeStatus>sample string 2</ChangeStatus> <TFN>sample string 3</TFN> <ABN>sample string 4</ABN> <BasisOfPayment>sample string 5</BasisOfPayment> <IsAustralianResident>true</IsAustralianResident> <IsWorkingHolidayMaker>true</IsWorkingHolidayMaker> <VisaCountry>sample string 6</VisaCountry> <MedicareClaimsReduction>true</MedicareClaimsReduction> <MedicareNumberOfChildren>1</MedicareNumberOfChildren> <HECS>true</HECS> <SFSS>true</SFSS> <GenerateAutopay>sample string 7</GenerateAutopay> <EmploymentType>sample string 8</EmploymentType> <MinimumPay>1</MinimumPay> <MaximumPay>1</MaximumPay> <ServiceHoursToDate>1</ServiceHoursToDate> <NormalHours>1</NormalHours> <PayClass>sample string 9</PayClass> <RateIncreaseCode>sample string 10</RateIncreaseCode> <YearlySalary>1</YearlySalary> <AutopayAmount>1</AutopayAmount> <NormalRate>1</NormalRate> <TimeAndHalfRate>1</TimeAndHalfRate> <DoubleTimeRate>1</DoubleTimeRate> <OtherRate>1</OtherRate> <AwardRate>1</AwardRate> <DefaultCostAccount>sample string 11</DefaultCostAccount> <WorkPlannerCode>sample string 12</WorkPlannerCode> <TerminationDate>2024-11-20T21:44:53.4261506+11:00</TerminationDate> <TerminationReason>sample string 13</TerminationReason> <NZStudentLoan>true</NZStudentLoan> <NZSpecifySLRate>true</NZSpecifySLRate> <NZStudentLoanTaxRate>1</NZStudentLoanTaxRate> <NZExcludeFromEMS>true</NZExcludeFromEMS> <NZWithholdingTax>true</NZWithholdingTax> <IRDEmployeeName>sample string 14</IRDEmployeeName> <TFNDateSigned>2024-11-20T21:44:53.4261506+11:00</TFNDateSigned> <TFNForSuper>sample string 15</TFNForSuper> <TaxScaleCode>sample string 16</TaxScaleCode> <SpecifyTaxRate>1</SpecifyTaxRate> <FamilyTaxBenefit>true</FamilyTaxBenefit> <OtherRebates>true</OtherRebates> <TotalRebates>1</TotalRebates> <DailyTaxing>true</DailyTaxing> <VariationDate>2024-11-20T21:44:53.4261506+11:00</VariationDate> <ReportableFringeBenefit>1</ReportableFringeBenefit> <OtherIncome>1</OtherIncome> <NonCashBenefit>1</NonCashBenefit> <PaymentType>sample string 17</PaymentType> <EarningsType>sample string 18</EarningsType> <ContractHoursCode>sample string 19</ContractHoursCode> <AutopayType>sample string 20</AutopayType> <WorkPatternCode>sample string 21</WorkPatternCode> <WorkPatternCycleStartDay>1</WorkPatternCycleStartDay> <WorkPatternEffectiveFrom>2024-11-20T21:44:53.4261506+11:00</WorkPatternEffectiveFrom> <AwardCode>sample string 22</AwardCode> <AwardClassificationCode>sample string 23</AwardClassificationCode> <AwardCategoryCode>sample string 24</AwardCategoryCode> <AwardConditionGroup>sample string 25</AwardConditionGroup> <AwardUseThisRate>1</AwardUseThisRate> <AwardNormalHours>1</AwardNormalHours> <AwardYearlySalary>1</AwardYearlySalary> <PersonalEmail>sample string 26</PersonalEmail> <BasisOfEmployment>sample string 27</BasisOfEmployment> <TFNPensioner>true</TFNPensioner> <TFNTaxFree>true</TFNTaxFree> <TFNTaxOffset>true</TFNTaxOffset> <TFNPreviousSurname>sample string 28</TFNPreviousSurname> <ReportingTo>sample string 29</ReportingTo> <TFNEmployeeDeclaration>true</TFNEmployeeDeclaration> <ABNPayeeDeclaration>true</ABNPayeeDeclaration> <ATOConsent>true</ATOConsent> <IsAnnualisedSalary>true</IsAnnualisedSalary> <AnnualisedAnniversaryDate>2024-11-20T21:44:53.4261506+11:00</AnnualisedAnniversaryDate> </ChangeEmployeeDetailView> </ChangeEmployeeDetailView> <ChangeEmployeeLeaveView> <ChangeEmployeeLeaveView> <ChangeEmployeeLeaveId>1</ChangeEmployeeLeaveId> <ChangeEmployeeId>1</ChangeEmployeeId> <ChangeType>sample string 1</ChangeType> <ChangeStatus>sample string 2</ChangeStatus> <EmpCode>sample string 3</EmpCode> <LeaveType>sample string 4</LeaveType> <LeaveCode>sample string 5</LeaveCode> <CostAccount>sample string 6</CostAccount> <LeaveLoadingClass>sample string 7</LeaveLoadingClass> <YTDLeaveLoading>1</YTDLeaveLoading> <EntitlementDate>2024-11-20T21:44:53.4261506+11:00</EntitlementDate> <EntitlementHours>1</EntitlementHours> <ProRataDate>2024-11-20T21:44:53.4261506+11:00</ProRataDate> <ProRataHours>1</ProRataHours> <Rate>1</Rate> <NonEntMonths>1</NonEntMonths> <FirstEntitlementPeriod>true</FirstEntitlementPeriod> <ReferenceNumber>sample string 8</ReferenceNumber> </ChangeEmployeeLeaveView> </ChangeEmployeeLeaveView> <ChangeEmployeeSuperContView> <ChangeEmployeeSuperContView> <ChangeEmployeeSuperContId>1</ChangeEmployeeSuperContId> <ChangeEmployeeId>1</ChangeEmployeeId> <ChangeType>sample string 1</ChangeType> <ChangeStatus>sample string 2</ChangeStatus> <EmpCode>sample string 3</EmpCode> <FundCode>sample string 4</FundCode> <DateJoined>2024-11-20T21:44:53.4261506+11:00</DateJoined> <MembershipNumber>sample string 5</MembershipNumber> <AccountName>sample string 6</AccountName> <CategoryCode>sample string 7</CategoryCode> <SalaryForSuper>1</SalaryForSuper> <ContributionCode>sample string 8</ContributionCode> <ContributionType>sample string 9</ContributionType> <ContributionAmount>1</ContributionAmount> <Allocation>1</Allocation> <CostAccount>sample string 10</CostAccount> <IsPrimaryContribution>true</IsPrimaryContribution> <DefaultFund>true</DefaultFund> <USI>sample string 11</USI> <SMSF>true</SMSF> <ESA>sample string 12</ESA> <FundABN>sample string 13</FundABN> <FundName>sample string 14</FundName> <FundBSB>sample string 15</FundBSB> <FundAddress1>sample string 16</FundAddress1> <FundAddress2>sample string 17</FundAddress2> <FundSuburb>sample string 18</FundSuburb> <FundState>sample string 19</FundState> <FundPostcode>sample string 20</FundPostcode> <FundPhone>sample string 21</FundPhone> <FundAccountNumber>sample string 22</FundAccountNumber> </ChangeEmployeeSuperContView> </ChangeEmployeeSuperContView> <ChangeEmployeeEmailView> <ChangeEmployeeEmailView> <ChangeEmployeeEmailId>1</ChangeEmployeeEmailId> <ChangeEmployeeId>1</ChangeEmployeeId> <ChangeType>sample string 1</ChangeType> <ChangeStatus>sample string 2</ChangeStatus> <EmpCode>sample string 3</EmpCode> <EmailAddress>sample string 4</EmailAddress> <UseAsDefault>true</UseAsDefault> <UseForPayslips>true</UseForPayslips> <ZIPPassword>sample string 5</ZIPPassword> <UseForPaymentSummaries>true</UseForPaymentSummaries> <EmailType>sample string 6</EmailType> </ChangeEmployeeEmailView> </ChangeEmployeeEmailView> <ImmediateImmediately>true</ImmediateImmediately> <PostedDate>2024-11-20T21:44:53.4261506+11:00</PostedDate> <PostedDateTime>2024-11-20T21:44:53.4261506+11:00</PostedDateTime> <UserId>1</UserId> <UserName>sample string 35</UserName> <UserType>sample string 36</UserType> <PayrollDatabase>cbb2a223-c82e-4245-9426-d175f73a5aff</PayrollDatabase> <DatabaseType>sample string 38</DatabaseType> <SuppressedDate>2024-11-20T21:44:53.4261506+11:00</SuppressedDate> <SuppressedDateTime>2024-11-20T21:44:53.4261506+11:00</SuppressedDateTime> <ActionedDate>2024-11-20T21:44:53.4261506+11:00</ActionedDate> <ActionedDateTime>2024-11-20T21:44:53.4261506+11:00</ActionedDateTime> <PayrollLinkToken>da7f5daf-bcc8-4a4c-a16f-4e989dfb7b67</PayrollLinkToken> <OnBoarding>true</OnBoarding> <ReferenceNumber>sample string 39</ReferenceNumber> <Comment>sample string 40</Comment> <IsEss>true</IsEss> </ChangeEmployeeView>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The unique identifier assigned to the new request (ChangeEmployeeId : int)
ChangeEmployeeResponseViewName | Description | Type | Additional information |
---|---|---|---|
Change  EmployeeId |
integer |
None. |
Response Formats
application/json, text/json
{ "changeEmployeeId": 1 }
application/xml, text/xml
<ChangeEmployeeResponseView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ChangeEmployeeId>1</ChangeEmployeeId> </ChangeEmployeeResponseView>