GET api/WeEmployeeBasic

Gets a list of Employees live from a WageEasy company database file.

Request Information

URI Parameters

(i.e.queryString parameters in the form ?param1={param1}&param2={param2})

Name	Description	Type	Additional information
include Terminated	Set to true to also include employees terminated after the terminatedSince date, false to exclude all terminated employees (mandatory).	boolean	Required
terminatedSince	Terminated employees will only be incuded if they were terminated after this date and only if include terminated is set true (mandatory). Date Formats supported include: yyyy/mm/dd, yyyy/mmm/dd, yyyy-mm-dd, yyyy-mmm-dd. Generally any unambiguous date format is acceptable. Times can also be included: Thh:mm:ss	date	Required
page	The page number to return using the pageSize parameter to define pages. Defaults to 1.	integer	Default value is 1
pageSize	The page size (number of records) to be used to find the record for the page requested. Defaults to 1000.	integer	Default value is 1000

Body Parameters

None.

Response Information

Resource Description

A list of all Employees' basic record

PagedObjectOfWeEmployeeBasicView

Name	Description	Type	Additional information
Items		Collection of WeEmployeeBasic View	None.
PageInfo		PagedListPageInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "items": [
    {
      "id": 1,
      "employeeNo": "sample string 2",
      "lastName": "sample string 3",
      "firstName": "sample string 4",
      "secondName": "sample string 5",
      "title": "sample string 6",
      "jobTitle": "sample string 7",
      "homeAddress": "sample string 8",
      "homeCity": "sample string 9",
      "homeState": "sample string 10",
      "homePostcode": "sample string 11",
      "homeCountry": "sample string 12",
      "postalAddress": "sample string 13",
      "postalCity": "sample string 14",
      "postalState": "sample string 15",
      "postalPostcode": "sample string 16",
      "postalCountry": "sample string 17",
      "birthday": "2024-05-19T09:36:36.7702296+10:00",
      "gender": "sample string 18",
      "maritalStatus": "sample string 19",
      "location": "sample string 20",
      "payPeriod": "sample string 21",
      "employmentCategory": "sample string 22",
      "employmentDate": "2024-05-19T09:36:36.7702296+10:00",
      "awardDate": "2024-05-19T09:36:36.7702296+10:00",
      "terminateDate": "2024-05-19T09:36:36.7702296+10:00",
      "terminateReason": "sample string 23",
      "awardKey": "sample string 24",
      "salaried": true,
      "taxKey": "sample string 25",
      "secondaryTaxKey": "sample string 26",
      "tertiaryTaxKey": "sample string 27",
      "forthTaxKey": "sample string 28",
      "fifthTaxKey": "sample string 29",
      "taxAdjustment": 1.1,
      "taxFileNo": "sample string 30",
      "canProvideTFNToSuperFund": true,
      "nonAustralianResident": true,
      "timeCardNo": "sample string 31",
      "glCode": "sample string 32",
      "securityPassNo": "sample string 33",
      "userPassword": "sample string 34",
      "notes": "sample string 35",
      "normalDayHours": "2024-05-19T09:36:36.7702296+10:00",
      "normalDayHoursUseAward": true,
      "standardPayHours": 1.1,
      "isStandardPays": true,
      "defaultEmail": "sample string 37",
      "defaultEmailUsedForPayslips": "sample string 38",
      "telephone1": "sample string 39",
      "telephone1Description": "sample string 40",
      "telephone2": "sample string 41",
      "telephone2Description": "sample string 42",
      "defaultPayRateKey": "sample string 43",
      "defaultDepartment": "sample string 44"
    },
    {
      "id": 1,
      "employeeNo": "sample string 2",
      "lastName": "sample string 3",
      "firstName": "sample string 4",
      "secondName": "sample string 5",
      "title": "sample string 6",
      "jobTitle": "sample string 7",
      "homeAddress": "sample string 8",
      "homeCity": "sample string 9",
      "homeState": "sample string 10",
      "homePostcode": "sample string 11",
      "homeCountry": "sample string 12",
      "postalAddress": "sample string 13",
      "postalCity": "sample string 14",
      "postalState": "sample string 15",
      "postalPostcode": "sample string 16",
      "postalCountry": "sample string 17",
      "birthday": "2024-05-19T09:36:36.7702296+10:00",
      "gender": "sample string 18",
      "maritalStatus": "sample string 19",
      "location": "sample string 20",
      "payPeriod": "sample string 21",
      "employmentCategory": "sample string 22",
      "employmentDate": "2024-05-19T09:36:36.7702296+10:00",
      "awardDate": "2024-05-19T09:36:36.7702296+10:00",
      "terminateDate": "2024-05-19T09:36:36.7702296+10:00",
      "terminateReason": "sample string 23",
      "awardKey": "sample string 24",
      "salaried": true,
      "taxKey": "sample string 25",
      "secondaryTaxKey": "sample string 26",
      "tertiaryTaxKey": "sample string 27",
      "forthTaxKey": "sample string 28",
      "fifthTaxKey": "sample string 29",
      "taxAdjustment": 1.1,
      "taxFileNo": "sample string 30",
      "canProvideTFNToSuperFund": true,
      "nonAustralianResident": true,
      "timeCardNo": "sample string 31",
      "glCode": "sample string 32",
      "securityPassNo": "sample string 33",
      "userPassword": "sample string 34",
      "notes": "sample string 35",
      "normalDayHours": "2024-05-19T09:36:36.7702296+10:00",
      "normalDayHoursUseAward": true,
      "standardPayHours": 1.1,
      "isStandardPays": true,
      "defaultEmail": "sample string 37",
      "defaultEmailUsedForPayslips": "sample string 38",
      "telephone1": "sample string 39",
      "telephone1Description": "sample string 40",
      "telephone2": "sample string 41",
      "telephone2Description": "sample string 42",
      "defaultPayRateKey": "sample string 43",
      "defaultDepartment": "sample string 44"
    }
  ],
  "pageInfo": {
    "page": 1,
    "pageSize": 2,
    "totalCount": 3,
    "totalPages": 4,
    "countThisPage": 5,
    "hasPreviousPage": true,
    "hasNextPage": true,
    "errorMessage": "sample string 8"
  }
}

application/xml, text/xml

Sample:

<PagedObjectOfWeEmployeeBasicView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <WeEmployeeBasicView>
      <Id>1</Id>
      <EmployeeNo>sample string 2</EmployeeNo>
      <LastName>sample string 3</LastName>
      <FirstName>sample string 4</FirstName>
      <SecondName>sample string 5</SecondName>
      <Title>sample string 6</Title>
      <JobTitle>sample string 7</JobTitle>
      <HomeAddress>sample string 8</HomeAddress>
      <HomeCity>sample string 9</HomeCity>
      <HomeState>sample string 10</HomeState>
      <HomePostcode>sample string 11</HomePostcode>
      <HomeCountry>sample string 12</HomeCountry>
      <PostalAddress>sample string 13</PostalAddress>
      <PostalCity>sample string 14</PostalCity>
      <PostalState>sample string 15</PostalState>
      <PostalPostcode>sample string 16</PostalPostcode>
      <PostalCountry>sample string 17</PostalCountry>
      <Birthday>2024-05-19T09:36:36.7702296+10:00</Birthday>
      <Gender>sample string 18</Gender>
      <MaritalStatus>sample string 19</MaritalStatus>
      <Location>sample string 20</Location>
      <PayPeriod>sample string 21</PayPeriod>
      <EmploymentCategory>sample string 22</EmploymentCategory>
      <EmploymentDate>2024-05-19T09:36:36.7702296+10:00</EmploymentDate>
      <AwardDate>2024-05-19T09:36:36.7702296+10:00</AwardDate>
      <TerminateDate>2024-05-19T09:36:36.7702296+10:00</TerminateDate>
      <TerminateReason>sample string 23</TerminateReason>
      <AwardKey>sample string 24</AwardKey>
      <Salaried>true</Salaried>
      <TaxKey>sample string 25</TaxKey>
      <SecondaryTaxKey>sample string 26</SecondaryTaxKey>
      <TertiaryTaxKey>sample string 27</TertiaryTaxKey>
      <ForthTaxKey>sample string 28</ForthTaxKey>
      <FifthTaxKey>sample string 29</FifthTaxKey>
      <TaxAdjustment>1.1</TaxAdjustment>
      <TaxFileNo>sample string 30</TaxFileNo>
      <CanProvideTFNToSuperFund>true</CanProvideTFNToSuperFund>
      <NonAustralianResident>true</NonAustralianResident>
      <TimeCardNo>sample string 31</TimeCardNo>
      <GLCode>sample string 32</GLCode>
      <SecurityPassNo>sample string 33</SecurityPassNo>
      <UserPassword>sample string 34</UserPassword>
      <Notes>sample string 35</Notes>
      <NormalDayHours>2024-05-19T09:36:36.7702296+10:00</NormalDayHours>
      <NormalDayHoursUseAward>true</NormalDayHoursUseAward>
      <StandardPayHours>1.1</StandardPayHours>
      <IsStandardPays>true</IsStandardPays>
      <DefaultEmail>sample string 37</DefaultEmail>
      <DefaultEmailUsedForPayslips>sample string 38</DefaultEmailUsedForPayslips>
      <Telephone1>sample string 39</Telephone1>
      <Telephone1Description>sample string 40</Telephone1Description>
      <Telephone2>sample string 41</Telephone2>
      <Telephone2Description>sample string 42</Telephone2Description>
      <DefaultPayRateKey>sample string 43</DefaultPayRateKey>
      <DefaultDepartment>sample string 44</DefaultDepartment>
    </WeEmployeeBasicView>
    <WeEmployeeBasicView>
      <Id>1</Id>
      <EmployeeNo>sample string 2</EmployeeNo>
      <LastName>sample string 3</LastName>
      <FirstName>sample string 4</FirstName>
      <SecondName>sample string 5</SecondName>
      <Title>sample string 6</Title>
      <JobTitle>sample string 7</JobTitle>
      <HomeAddress>sample string 8</HomeAddress>
      <HomeCity>sample string 9</HomeCity>
      <HomeState>sample string 10</HomeState>
      <HomePostcode>sample string 11</HomePostcode>
      <HomeCountry>sample string 12</HomeCountry>
      <PostalAddress>sample string 13</PostalAddress>
      <PostalCity>sample string 14</PostalCity>
      <PostalState>sample string 15</PostalState>
      <PostalPostcode>sample string 16</PostalPostcode>
      <PostalCountry>sample string 17</PostalCountry>
      <Birthday>2024-05-19T09:36:36.7702296+10:00</Birthday>
      <Gender>sample string 18</Gender>
      <MaritalStatus>sample string 19</MaritalStatus>
      <Location>sample string 20</Location>
      <PayPeriod>sample string 21</PayPeriod>
      <EmploymentCategory>sample string 22</EmploymentCategory>
      <EmploymentDate>2024-05-19T09:36:36.7702296+10:00</EmploymentDate>
      <AwardDate>2024-05-19T09:36:36.7702296+10:00</AwardDate>
      <TerminateDate>2024-05-19T09:36:36.7702296+10:00</TerminateDate>
      <TerminateReason>sample string 23</TerminateReason>
      <AwardKey>sample string 24</AwardKey>
      <Salaried>true</Salaried>
      <TaxKey>sample string 25</TaxKey>
      <SecondaryTaxKey>sample string 26</SecondaryTaxKey>
      <TertiaryTaxKey>sample string 27</TertiaryTaxKey>
      <ForthTaxKey>sample string 28</ForthTaxKey>
      <FifthTaxKey>sample string 29</FifthTaxKey>
      <TaxAdjustment>1.1</TaxAdjustment>
      <TaxFileNo>sample string 30</TaxFileNo>
      <CanProvideTFNToSuperFund>true</CanProvideTFNToSuperFund>
      <NonAustralianResident>true</NonAustralianResident>
      <TimeCardNo>sample string 31</TimeCardNo>
      <GLCode>sample string 32</GLCode>
      <SecurityPassNo>sample string 33</SecurityPassNo>
      <UserPassword>sample string 34</UserPassword>
      <Notes>sample string 35</Notes>
      <NormalDayHours>2024-05-19T09:36:36.7702296+10:00</NormalDayHours>
      <NormalDayHoursUseAward>true</NormalDayHoursUseAward>
      <StandardPayHours>1.1</StandardPayHours>
      <IsStandardPays>true</IsStandardPays>
      <DefaultEmail>sample string 37</DefaultEmail>
      <DefaultEmailUsedForPayslips>sample string 38</DefaultEmailUsedForPayslips>
      <Telephone1>sample string 39</Telephone1>
      <Telephone1Description>sample string 40</Telephone1Description>
      <Telephone2>sample string 41</Telephone2>
      <Telephone2Description>sample string 42</Telephone2Description>
      <DefaultPayRateKey>sample string 43</DefaultPayRateKey>
      <DefaultDepartment>sample string 44</DefaultDepartment>
    </WeEmployeeBasicView>
  </Items>
  <PageInfo>
    <Page>1</Page>
    <PageSize>2</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>4</TotalPages>
    <CountThisPage>5</CountThisPage>
    <HasPreviousPage>true</HasPreviousPage>
    <HasNextPage>true</HasNextPage>
    <ErrorMessage>sample string 8</ErrorMessage>
  </PageInfo>
</PagedObjectOfWeEmployeeBasicView>