HR Person
|
URL |
Verbs |
Function |
|---|---|---|
|
HRPerson |
GET |
Query a list of all HR Persons |
| HRPerson | POST | Create a new HRPerson |
|
HRPerson/<code> |
GET |
Query a specific HR Person by employee code |
| HRPerson/<code> | POST | Update a HR Person |
Supported modifiers
|
Query String |
Definition |
Sample
|
Available |
|---|---|---|---|
|
authenticate |
Authenticate against the HRPersons eHR Password |
action=authenticate&Password=Fred123! | |
| modifiedSince | Return a list of HR Persons which have been modified since the passed timestamp | modifiedSince=2013-09-11T10:30:00 | |
| treeName and treeBranch | Return a list of HR Persons assigned to a nominated branch of a nominated tree | treeName=Colour-AUS&treeBranch=Blue | |
| includeKeyDates | Include the list of Key Dates with each HR Person | includeKeyDates=true | 4@12 |
| includeGLAllocations | Include the list of GL Allocations with each HR Person | includeGLAllocations=true | 4@12 |
| includePositions | Include the list of Positions with each HRPerson | includePositions=true | 4@12 |
| balanceForecast |
Include a Balance Forecast summary with each HRPerson * must be used in conjunction with a leaveType |
balanceForecast=true | 2019.3 |
| leaveType |
Used as part of the Balance Forecast determined by balanceForecast, specifies which Leave Type code to forecast * only valid with the balanceForecast parameter |
leaveType=202 | 2019.3 |
| toDate |
Used as part of the Balance Forecast to set the date up to which you wish to forecast * only valid with the balanceForecast parameter |
toDate=2019-12-01 | 2019.3 |
| isByAccruedDate |
Used with the Balance Forecast summary based on accrual date rather than entitled date * only valid with the balanceForecast parameter |
isByAccruedDate=true | 2019.3 |
| excludeCertifications |
Exclude HR Certifications for each HRPerson * should have ideally been an include, but retaining backwards compatibility |
excludeCertifications=true | 2020.1 |
| includeBalanceTracking | Return a list of HR Person Balances | 2023.2 | |
| active | Return a list of HR Persons which match the passed active modifier | 2023.2 |
Security Linked Menu
|
Menu Item
|
Located
|
|---|---|
| Employee Maintenance | HR |
Sample XML Response
<?xml version="1.0" encoding="UTF-8"?>
<HRPerson>
<Code>1000</Code>
<Surname>ALGER</Surname>
<Firstname>AMANDA</Firstname>
<Edition>81</Edition>
<IsActive>true</IsActive>
<EntryTimeStamp>2011-09-23T18:26:27</EntryTimeStamp>
<EntryUser>SUPER</EntryUser>
<ModifiedTimeStamp>2013-08-08T15:02:24</ModifiedTimeStamp>
<ModifiedUser>SUPER</ModifiedUser>
<Title>Miss</Title>
<UsualName>AMANDA ALGER</UsualName>
<BirthDate>1978-06-12</BirthDate>
<Position>Admin Assistant</Position>
<StartDate>2007-09-03</StartDate>
<TerminationDate/>
<Salutation>Mandy</Salutation>
<StandardDay>8.00</StandardDay>
<StandardPay>0.0000</StandardPay>
<StandardWeek>0.00</StandardWeek>
<IsPublicHolidaysAdded>false</IsPublicHolidaysAdded>
<DefaultTransactionTrees/>
<NextOfKinName>Natalie Alger</NextOfKinName>
<NextOfKinRelationship>Mother</NextOfKinRelationship>
<Notes/>
<HRNotes/>
<IsVerified>false</IsVerified>
<IsAuthorisedHR>true</IsAuthorisedHR>
<IsAuthorisedPR>true</IsAuthorisedPR>
<IsSuspended>false</IsSuspended>
<SuspendedReason/>
<GLExpenseAccountMask>20.10.2510</GLExpenseAccountMask>
<IsExcludeFromPaySlips>false</IsExcludeFromPaySlips>
<IsOnProcessPay>true</IsOnProcessPay>
<IsOnMissingReport>true</IsOnMissingReport>
<IsHoursReductionUsed>true</IsHoursReductionUsed>
<IsEarningsSummaryOptionsOnEmp>false</IsEarningsSummaryOptionsOnEmp>
<IsEarningsSummaryByStdHours>false</IsEarningsSummaryByStdHours>
<IsEarningsSummaryDisplayMthly>false</IsEarningsSummaryDisplayMthly>
<TaxConfiguration>
<TaxReference>111111111</TaxReference>
<PaymentSummaryForm>Individual Non Business</PaymentSummaryForm>
<PayrollTaxTransType>X05</PayrollTaxTransType>
<PayeeTaxStatus/>
<IsTFNDecAustralianResident>false</IsTFNDecAustralianResident>
<IsPaymentSummaryAmended>false</IsPaymentSummaryAmended>
<TFNPreviousName/>
<IsTFNDecTaxThresholdClaimed>false</IsTFNDecTaxThresholdClaimed>
<IsTFNDecHELP>false</IsTFNDecHELP>
<IsTFNDisclosureAllowed>false</IsTFNDisclosureAllowed>
<IsTFNDecStudentLoan>false</IsTFNDecStudentLoan>
<TFNDecBasis>Full Time</TFNDecBasis>
<TFNDecSignedDate/>
<IsTaxDeclarationIncludeInFile>false</IsTaxDeclarationIncludeInFile>
<NormalEarningsMethod>Module Control Default</NormalEarningsMethod>
<ForeignEmploymentType/>
<PaymentSummaryIncomeType/>
<IsSTPSeniorTaxOffset>false</IsSTPSeniorTaxOffset>
<STPVaryTaxOffsetAmount>0</STPVaryTaxOffsetAmount>
</TaxConfiguration>
<Customer>1021</Customer>
<Branch>03</Branch>
<ProfitCentre>0301</ProfitCentre>
<PayslipDeliveryMethod>Print</PayslipDeliveryMethod>
<PersonType>Permanent</PersonType>
<PersonBasis>Full Time</PersonBasis>
<DisplayFields>Date/Time</DisplayFields>
<PayGroup>Weekly</PayGroup>
<AwardClass>C004</AwardClass>
<AwardSelection>All Contracts</AwardSelection>
<StreetAddress>
<Contact/>
<Address1>675 Carl Street</Address1>
<Address2/>
<Address3/>
<Suburb>Southbank</Suburb>
<Postcode>3006</Postcode>
<State>VIC</State>
<Country>AUS</Country>
<TZone>+10:00</TZone>
<PhoneBH>(00) 0000 0000</PhoneBH>
<PhoneAH>(00) 0000 0000</PhoneAH>
<Fax>(00) 0000 0000</Fax>
<Email>amandaa@company.com.au</Email>
<Web/>
<Mobile>0411 220 100</Mobile>
</StreetAddress>
<PostalAddress>
<Contact/>
<Address1>P.O. Box 401</Address1>
<Address2/>
<Address3/>
<Suburb>Southbank</Suburb>
<Postcode>3006</Postcode>
<State>VIC</State>
<Country>AUS</Country>
<TZone>+10:00</TZone>
<PhoneBH/>
<PhoneAH/>
<Fax/>
<Email/>
<Web/>
<Mobile/>
</PostalAddress>
<NextOfKinAddress>
<Contact/>
<Address1>Unit 10</Address1>
<Address2>600 Boundry Road</Address2>
<Address3>Essendon</Address3>
<Suburb/>
<Postcode>3040</Postcode>
<State>VIC</State>
<Country>AUS</Country>
<TZone>+10:00</TZone>
<PhoneBH>(00) 9561 8542</PhoneBH>
<PhoneAH>(00) 9325 4485</PhoneAH>
<Fax/>
<Email/>
<Web/>
<Mobile>0418 578 968</Mobile>
</NextOfKinAddress>
<WorkingCalendar>Business</WorkingCalendar>
<AnnualisedTotal>33280</AnnualisedTotal>
<HRPersonCVCertifications collection="true" count="2">
<HRPersonCVCertification>
<Edition>2</Edition>
<OidString>6614.11</OidString>
<Details/>
<Notes/>
<Reference/>
<Type/>
<Level>Current</Level>
<ExpiryDate>2007-05-30</ExpiryDate>
<ObtainedDate>1998-05-16</ObtainedDate>
<IsExpired>true</IsExpired>
</HRPersonCVCertification>
<HRPersonCVCertification>
<Edition>2</Edition>
<OidString>6614.13</OidString>
<Details/>
<Notes/>
<Reference/>
<Type/>
<Level>Year 2</Level>
<ExpiryDate>2010-12-31</ExpiryDate>
<ObtainedDate>2006-12-31</ObtainedDate>
<IsExpired>true</IsExpired>
</HRPersonCVCertification>
</HRPersonCVCertifications>
<HRPersonCVEducations collection="true" count="2">
<HRPersonCVEducation>
<Edition>2</Edition>
<OidString>6615.5</OidString>
<Details/>
<Notes/>
<Reference/>
<Type/>
<Level>Year 12</Level>
<FromDate/>
<ToDate/>
<ObtainedDate>1992-12-31</ObtainedDate>
<IsExpired>false</IsExpired>
</HRPersonCVEducation>
<HRPersonCVEducation>
<Edition>3</Edition>
<OidString>6615.6</OidString>
<Details/>
<Notes/>
<Reference/>
<Type/>
<Level>PHD</Level>
<FromDate/>
<ToDate/>
<ObtainedDate>2007-07-31</ObtainedDate>
<IsExpired>false</IsExpired>
</HRPersonCVEducation>
</HRPersonCVEducations>
<HRPersonCVEmployments collection="true" count="1">
<HRPersonCVEmployment>
<Edition>4</Edition>
<OidString>6616.5</OidString>
<Details/>
<Notes/>
<Reference>Cameron's Computers</Reference>
<Type/>
<CommencedDate>2004-01-01</CommencedDate>
<CeasedDate>2006-12-25</CeasedDate>
</HRPersonCVEmployment>
</HRPersonCVEmployments>
<HRPersonCVMedicals collection="true" count="0"/>
<HRPersonCVSkills collection="true" count="3">
<HRPersonCVSkill>
<Edition>1</Edition>
<OidString>6618.12</OidString>
<Details/>
<Notes/>
<Reference/>
<Type/>
<Level>Advanced</Level>
</HRPersonCVSkill>
<HRPersonCVSkill>
<Edition>1</Edition>
<OidString>6618.14</OidString>
<Details/>
<Notes/>
<Reference/>
<Type/>
<Level>Advanced</Level>
</HRPersonCVSkill>
<HRPersonCVSkill>
<Edition>1</Edition>
<OidString>6618.15</OidString>
<Details/>
<Notes/>
<Reference/>
<Type/>
<Level>Analytically</Level>
</HRPersonCVSkill>
</HRPersonCVSkills>
<HRPersonCVTrainings collection="true" count="2">
<HRPersonCVTraining>
<Edition>2</Edition>
<OidString>6619.10</OidString>
<Details/>
<Notes/>
<Reference/>
<Type/>
<Level>Intermediate</Level>
<FromDate/>
<ToDate/>
<ObtainedDate>2007-05-25</ObtainedDate>
</HRPersonCVTraining>
<HRPersonCVTraining>
<Edition>2</Edition>
<OidString>6619.8</OidString>
<Details/>
<Notes/>
<Reference/>
<Type/>
<Level>Basic</Level>
<FromDate/>
<ToDate/>
<ObtainedDate>2006-12-31</ObtainedDate>
</HRPersonCVTraining>
</HRPersonCVTrainings>
<UserDefinedFields collection="true" count="2">
<UserDefinedField>
<Name>Car Rego</Name>
<Type>String</Type>
<Value>XCLR8</Value>
</UserDefinedField>
<UserDefinedField>
<Name>No Of Children</Name>
<Type>Integer</Type>
<Value>1</Value>
</UserDefinedField>
</UserDefinedFields>
<Trees collection="true" count="1">
<Tree>
<Name>Person Tree</Name>
<IsMandatory>false</IsMandatory>
<Value>Victoria</Value>
<Path>Location\Victoria</Path>
<ShortCode>03</ShortCode>
</Tree>
</Trees>
</HRPerson>