GET api/Entitlement/Balances

Used to fetch login user leave dashboard balance

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

EmployeeEntitlementsBalanceDTO

Collection of EmployeeEntitlementsBalanceDTO

Name	Type	Additional information
EntitlementAssignmentId	integer	None.
EntitlementTypeName	string	None.
EntitlementTypeCode	string	None.
EntitlementAssignmentBalanceQty	decimal number	None.
EntitlementTransactions	Collection of EntitlementTransaction	None.
EntitlementGroupQualifyingPeriod	byte	None.
EmployeeEntitlementGroupStartDate	date	None.
LastAnniversaryDate	date	None.
IsHideProjection	boolean	None.
IsPayrollUseOnly	boolean	None.
Disclaimer	string	None.
EmployeeEntitlementGroupEndDate	date	None.
StandardQuantityPerYear	decimal number	None.
LastPaymentDate	date	None.
EntitlementUOM	string	None.
IsDisplayBalance	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "EntitlementAssignmentId": 1,
    "EntitlementTypeName": "sample string 2",
    "EntitlementTypeCode": "sample string 3",
    "EntitlementAssignmentBalanceQty": 1.0,
    "EntitlementTransactions": [
      {
        "Id": 1,
        "EmployeeId": 2,
        "EntitlementAssignmentId": 3,
        "Type": "sample string 4",
        "Quantity": 1.0,
        "EffectiveDate": "2024-06-29T07:34:59.1825585+10:00",
        "ExpiryDate": "2024-06-29T07:34:59.1825585+10:00",
        "Status": "sample string 5",
        "Comment": "sample string 6"
      },
      {
        "Id": 1,
        "EmployeeId": 2,
        "EntitlementAssignmentId": 3,
        "Type": "sample string 4",
        "Quantity": 1.0,
        "EffectiveDate": "2024-06-29T07:34:59.1825585+10:00",
        "ExpiryDate": "2024-06-29T07:34:59.1825585+10:00",
        "Status": "sample string 5",
        "Comment": "sample string 6"
      }
    ],
    "EntitlementGroupQualifyingPeriod": 64,
    "EmployeeEntitlementGroupStartDate": "2024-06-29T07:34:59.1835439+10:00",
    "LastAnniversaryDate": "2024-06-29T07:34:59.1835439+10:00",
    "IsHideProjection": true,
    "IsPayrollUseOnly": true,
    "Disclaimer": "sample string 6",
    "EmployeeEntitlementGroupEndDate": "2024-06-29T07:34:59.1835439+10:00",
    "StandardQuantityPerYear": 1.0,
    "LastPaymentDate": "2024-06-29T07:34:59.1835439+10:00",
    "EntitlementUOM": "sample string 7",
    "IsDisplayBalance": true
  },
  {
    "EntitlementAssignmentId": 1,
    "EntitlementTypeName": "sample string 2",
    "EntitlementTypeCode": "sample string 3",
    "EntitlementAssignmentBalanceQty": 1.0,
    "EntitlementTransactions": [
      {
        "Id": 1,
        "EmployeeId": 2,
        "EntitlementAssignmentId": 3,
        "Type": "sample string 4",
        "Quantity": 1.0,
        "EffectiveDate": "2024-06-29T07:34:59.1825585+10:00",
        "ExpiryDate": "2024-06-29T07:34:59.1825585+10:00",
        "Status": "sample string 5",
        "Comment": "sample string 6"
      },
      {
        "Id": 1,
        "EmployeeId": 2,
        "EntitlementAssignmentId": 3,
        "Type": "sample string 4",
        "Quantity": 1.0,
        "EffectiveDate": "2024-06-29T07:34:59.1825585+10:00",
        "ExpiryDate": "2024-06-29T07:34:59.1825585+10:00",
        "Status": "sample string 5",
        "Comment": "sample string 6"
      }
    ],
    "EntitlementGroupQualifyingPeriod": 64,
    "EmployeeEntitlementGroupStartDate": "2024-06-29T07:34:59.1835439+10:00",
    "LastAnniversaryDate": "2024-06-29T07:34:59.1835439+10:00",
    "IsHideProjection": true,
    "IsPayrollUseOnly": true,
    "Disclaimer": "sample string 6",
    "EmployeeEntitlementGroupEndDate": "2024-06-29T07:34:59.1835439+10:00",
    "StandardQuantityPerYear": 1.0,
    "LastPaymentDate": "2024-06-29T07:34:59.1835439+10:00",
    "EntitlementUOM": "sample string 7",
    "IsDisplayBalance": true
  }
]

text/xml

Sample:

<ArrayOfEmployeeEntitlementsBalanceDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <EmployeeEntitlementsBalanceDTO>
    <Disclaimer>sample string 6</Disclaimer>
    <EmployeeEntitlementGroupEndDate>2024-06-29T07:34:59.1835439+10:00</EmployeeEntitlementGroupEndDate>
    <EmployeeEntitlementGroupStartDate>2024-06-29T07:34:59.1835439+10:00</EmployeeEntitlementGroupStartDate>
    <EntitlementAssignmentBalanceQty>1</EntitlementAssignmentBalanceQty>
    <EntitlementAssignmentId>1</EntitlementAssignmentId>
    <EntitlementGroupQualifyingPeriod>64</EntitlementGroupQualifyingPeriod>
    <EntitlementTransactions>
      <EntitlementTransaction>
        <Comment>sample string 6</Comment>
        <EffectiveDate>2024-06-29T07:34:59.1825585+10:00</EffectiveDate>
        <EmployeeId>2</EmployeeId>
        <EntitlementAssignmentId>3</EntitlementAssignmentId>
        <ExpiryDate>2024-06-29T07:34:59.1825585+10:00</ExpiryDate>
        <Id>1</Id>
        <Quantity>1</Quantity>
        <Status>sample string 5</Status>
        <Type>sample string 4</Type>
      </EntitlementTransaction>
      <EntitlementTransaction>
        <Comment>sample string 6</Comment>
        <EffectiveDate>2024-06-29T07:34:59.1825585+10:00</EffectiveDate>
        <EmployeeId>2</EmployeeId>
        <EntitlementAssignmentId>3</EntitlementAssignmentId>
        <ExpiryDate>2024-06-29T07:34:59.1825585+10:00</ExpiryDate>
        <Id>1</Id>
        <Quantity>1</Quantity>
        <Status>sample string 5</Status>
        <Type>sample string 4</Type>
      </EntitlementTransaction>
    </EntitlementTransactions>
    <EntitlementTypeCode>sample string 3</EntitlementTypeCode>
    <EntitlementTypeName>sample string 2</EntitlementTypeName>
    <EntitlementUOM>sample string 7</EntitlementUOM>
    <IsDisplayBalance>true</IsDisplayBalance>
    <IsHideProjection>true</IsHideProjection>
    <IsPayrollUseOnly>true</IsPayrollUseOnly>
    <LastAnniversaryDate>2024-06-29T07:34:59.1835439+10:00</LastAnniversaryDate>
    <LastPaymentDate>2024-06-29T07:34:59.1835439+10:00</LastPaymentDate>
    <StandardQuantityPerYear>1</StandardQuantityPerYear>
  </EmployeeEntitlementsBalanceDTO>
  <EmployeeEntitlementsBalanceDTO>
    <Disclaimer>sample string 6</Disclaimer>
    <EmployeeEntitlementGroupEndDate>2024-06-29T07:34:59.1835439+10:00</EmployeeEntitlementGroupEndDate>
    <EmployeeEntitlementGroupStartDate>2024-06-29T07:34:59.1835439+10:00</EmployeeEntitlementGroupStartDate>
    <EntitlementAssignmentBalanceQty>1</EntitlementAssignmentBalanceQty>
    <EntitlementAssignmentId>1</EntitlementAssignmentId>
    <EntitlementGroupQualifyingPeriod>64</EntitlementGroupQualifyingPeriod>
    <EntitlementTransactions>
      <EntitlementTransaction>
        <Comment>sample string 6</Comment>
        <EffectiveDate>2024-06-29T07:34:59.1825585+10:00</EffectiveDate>
        <EmployeeId>2</EmployeeId>
        <EntitlementAssignmentId>3</EntitlementAssignmentId>
        <ExpiryDate>2024-06-29T07:34:59.1825585+10:00</ExpiryDate>
        <Id>1</Id>
        <Quantity>1</Quantity>
        <Status>sample string 5</Status>
        <Type>sample string 4</Type>
      </EntitlementTransaction>
      <EntitlementTransaction>
        <Comment>sample string 6</Comment>
        <EffectiveDate>2024-06-29T07:34:59.1825585+10:00</EffectiveDate>
        <EmployeeId>2</EmployeeId>
        <EntitlementAssignmentId>3</EntitlementAssignmentId>
        <ExpiryDate>2024-06-29T07:34:59.1825585+10:00</ExpiryDate>
        <Id>1</Id>
        <Quantity>1</Quantity>
        <Status>sample string 5</Status>
        <Type>sample string 4</Type>
      </EntitlementTransaction>
    </EntitlementTransactions>
    <EntitlementTypeCode>sample string 3</EntitlementTypeCode>
    <EntitlementTypeName>sample string 2</EntitlementTypeName>
    <EntitlementUOM>sample string 7</EntitlementUOM>
    <IsDisplayBalance>true</IsDisplayBalance>
    <IsHideProjection>true</IsHideProjection>
    <IsPayrollUseOnly>true</IsPayrollUseOnly>
    <LastAnniversaryDate>2024-06-29T07:34:59.1835439+10:00</LastAnniversaryDate>
    <LastPaymentDate>2024-06-29T07:34:59.1835439+10:00</LastPaymentDate>
    <StandardQuantityPerYear>1</StandardQuantityPerYear>
  </EmployeeEntitlementsBalanceDTO>
</ArrayOfEmployeeEntitlementsBalanceDTO>

multipart/form-data

Sample:

<ArrayOfEmployeeEntitlementsBalanceDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><EmployeeEntitlementsBalanceDTO><Disclaimer>sample string 6</Disclaimer><EmployeeEntitlementGroupEndDate>2024-06-29T07:34:59.1835439+10:00</EmployeeEntitlementGroupEndDate><EmployeeEntitlementGroupStartDate>2024-06-29T07:34:59.1835439+10:00</EmployeeEntitlementGroupStartDate><EntitlementAssignmentBalanceQty>1</EntitlementAssignmentBalanceQty><EntitlementAssignmentId>1</EntitlementAssignmentId><EntitlementGroupQualifyingPeriod>64</EntitlementGroupQualifyingPeriod><EntitlementTransactions><EntitlementTransaction><Comment>sample string 6</Comment><EffectiveDate>2024-06-29T07:34:59.1825585+10:00</EffectiveDate><EmployeeId>2</EmployeeId><EntitlementAssignmentId>3</EntitlementAssignmentId><ExpiryDate>2024-06-29T07:34:59.1825585+10:00</ExpiryDate><Id>1</Id><Quantity>1</Quantity><Status>sample string 5</Status><Type>sample string 4</Type></EntitlementTransaction><EntitlementTransaction><Comment>sample string 6</Comment><EffectiveDate>2024-06-29T07:34:59.1825585+10:00</EffectiveDate><EmployeeId>2</EmployeeId><EntitlementAssignmentId>3</EntitlementAssignmentId><ExpiryDate>2024-06-29T07:34:59.1825585+10:00</ExpiryDate><Id>1</Id><Quantity>1</Quantity><Status>sample string 5</Status><Type>sample string 4</Type></EntitlementTransaction></EntitlementTransactions><EntitlementTypeCode>sample string 3</EntitlementTypeCode><EntitlementTypeName>sample string 2</EntitlementTypeName><EntitlementUOM>sample string 7</EntitlementUOM><IsDisplayBalance>true</IsDisplayBalance><IsHideProjection>true</IsHideProjection><IsPayrollUseOnly>true</IsPayrollUseOnly><LastAnniversaryDate>2024-06-29T07:34:59.1835439+10:00</LastAnniversaryDate><LastPaymentDate>2024-06-29T07:34:59.1835439+10:00</LastPaymentDate><StandardQuantityPerYear>1</StandardQuantityPerYear></EmployeeEntitlementsBalanceDTO><EmployeeEntitlementsBalanceDTO><Disclaimer>sample string 6</Disclaimer><EmployeeEntitlementGroupEndDate>2024-06-29T07:34:59.1835439+10:00</EmployeeEntitlementGroupEndDate><EmployeeEntitlementGroupStartDate>2024-06-29T07:34:59.1835439+10:00</EmployeeEntitlementGroupStartDate><EntitlementAssignmentBalanceQty>1</EntitlementAssignmentBalanceQty><EntitlementAssignmentId>1</EntitlementAssignmentId><EntitlementGroupQualifyingPeriod>64</EntitlementGroupQualifyingPeriod><EntitlementTransactions><EntitlementTransaction><Comment>sample string 6</Comment><EffectiveDate>2024-06-29T07:34:59.1825585+10:00</EffectiveDate><EmployeeId>2</EmployeeId><EntitlementAssignmentId>3</EntitlementAssignmentId><ExpiryDate>2024-06-29T07:34:59.1825585+10:00</ExpiryDate><Id>1</Id><Quantity>1</Quantity><Status>sample string 5</Status><Type>sample string 4</Type></EntitlementTransaction><EntitlementTransaction><Comment>sample string 6</Comment><EffectiveDate>2024-06-29T07:34:59.1825585+10:00</EffectiveDate><EmployeeId>2</EmployeeId><EntitlementAssignmentId>3</EntitlementAssignmentId><ExpiryDate>2024-06-29T07:34:59.1825585+10:00</ExpiryDate><Id>1</Id><Quantity>1</Quantity><Status>sample string 5</Status><Type>sample string 4</Type></EntitlementTransaction></EntitlementTransactions><EntitlementTypeCode>sample string 3</EntitlementTypeCode><EntitlementTypeName>sample string 2</EntitlementTypeName><EntitlementUOM>sample string 7</EntitlementUOM><IsDisplayBalance>true</IsDisplayBalance><IsHideProjection>true</IsHideProjection><IsPayrollUseOnly>true</IsPayrollUseOnly><LastAnniversaryDate>2024-06-29T07:34:59.1835439+10:00</LastAnniversaryDate><LastPaymentDate>2024-06-29T07:34:59.1835439+10:00</LastPaymentDate><StandardQuantityPerYear>1</StandardQuantityPerYear></EmployeeEntitlementsBalanceDTO></ArrayOfEmployeeEntitlementsBalanceDTO>