GetEmployeeCompensationsForPeriods
- 1 Minute to read
- Print
- DarkLight
- PDF
GetEmployeeCompensationsForPeriods
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
The API has been introduced for the users to get the calculated compensation items based on the following filter options:
- HomeBudgetEnity (Codes)
- EmployeeNumbers
- Employee number and EmployeePosition
- Compensation Item
- Time (year)
- Account
Note
Users can use multiple filters to generate required data depending on the use case.
Method
POST
Endpoint Url Syntax
Content Type
text/xml
Headers
| Key | Value |
|---|---|
| SOAPAction | http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19/GetEmployeeCompensationsForPeriods |
Syntax
public EmployeeCompensation[] GetEmployeeCompensationsForPeriods(string LoginName, string Password, string TenantCode, string scenarioCode, Filters[] FilterCollection, int startIndex)
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19">
<soapenv:Header />
<soapenv:Body>
<ns:GetEmployeeCompensationsForPeriods>
<!--Optional:-->
<ns:LoginName>benparker@planful.com</ns:LoginName>
<!--Optional:-->
<ns:Password>password</ns:Password>
<!--Optional:-->
<ns:TenantCode>AKSMaster</ns:TenantCode>
<!--Optional:-->
<ns:scenarioCode>2021 Plan1</ns:scenarioCode>
<!--Optional:-->
<ns:FilterCollection>
<!--Zero or more repetitions:-->
<ns:Filters>
<ns:FilterOption>Account</ns:FilterOption>
<!--Optional:-->
<ns:Values>
<!--Zero or more repetitions:-->
<ns:string>60000</ns:string>
</ns:Values>
</ns:Filters>
<ns:Filters>
<ns:FilterOption>Employees</ns:FilterOption>
<!--Optional:-->
<ns:Values>
<!--Zero or more repetitions:-->
<ns:string>5038</ns:string>
<ns:string>5039111</ns:string>
</ns:Values>
</ns:Filters>
</ns:FilterCollection>
<ns:startIndex>1</ns:startIndex>
</ns:GetEmployeeCompensationsForPeriods>
</soapenv:Body>
</soapenv:Envelope> Success Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetEmployeeCompensationsForPeriodsResponse xmlns="http://www.HostAnalytics.com/API/SOAP/StateFree/Common/2009/03/19">
<GetEmployeeCompensationsForPeriodsResult>
<EmployeeCompensation>
<EmployeeInfo>
<HomeBudgetEntityCode>France - Sales</HomeBudgetEntityCode>
<HomeBudgetEntityName />
<Number>5038</Number>
<Name>Ruth Bell</Name>
</EmployeeInfo>
<Positions>
<EmployeePositionSummary>
<PositionName>Sales Manager</PositionName>
<PositionEntityCode>France - Sales</PositionEntityCode>
<PositionEntityName />
<CompensationItems>
<CompensationItem>
<Code>Salaries</Code>
<Name>Salaries - Full Time</Name>
<Account>
<Code>60000</Code>
<Name>Salaries - Full Time</Name>
</Account>
<CalculatedAmounts>
<CalculatedAmount>
<FiscalYear>2021</FiscalYear>
<FiscalMonth>1</FiscalMonth>
<PeriodName>Jan-21</PeriodName>
<LCAmount>3466.666667</LCAmount>
<CCAmount>4224.618667</CCAmount>
<PositionCurrencyAmount>3466.666667</PositionCurrencyAmount>
</CalculatedAmount>
<CalculatedAmount>
<FiscalYear>2021</FiscalYear>
<FiscalMonth>2</FiscalMonth>
<PeriodName>Feb-21</PeriodName>
<LCAmount>3466.666667</LCAmount>
<CCAmount>4206.938667</CCAmount>
<PositionCurrencyAmount>3466.666667</PositionCurrencyAmount>
</CalculatedAmount>
<CalculatedAmount>
<FiscalYear>2021</FiscalYear>
<FiscalMonth>3</FiscalMonth>
<PeriodName>Mar-21</PeriodName>
<LCAmount>3466.666667</LCAmount>
<CCAmount>4217.477334</CCAmount>
<PositionCurrencyAmount>3466.666667</PositionCurrencyAmount>
</CalculatedAmount>
<CalculatedAmount>
<FiscalYear>2021</FiscalYear>
<FiscalMonth>4</FiscalMonth>
<PeriodName>Apr-21</PeriodName>
<LCAmount>3466.666667</LCAmount>
<CCAmount>4193.522667</CCAmount>
<PositionCurrencyAmount>3466.666667</PositionCurrencyAmount>
</CalculatedAmount>
<CalculatedAmount>
<FiscalYear>2021</FiscalYear>
<FiscalMonth>5</FiscalMonth>
<PeriodName>May-21</PeriodName>
<LCAmount>3466.666667</LCAmount>
<CCAmount>4217.304000</CCAmount>
<PositionCurrencyAmount>3466.666667</PositionCurrencyAmount>
</CalculatedAmount>
<CalculatedAmount>
<FiscalYear>2021</FiscalYear>
<FiscalMonth>6</FiscalMonth>
<PeriodName>Jun-21</PeriodName>
<LCAmount>3466.666667</LCAmount>
<CCAmount>4192.690667</CCAmount>
<PositionCurrencyAmount>3466.666667</PositionCurrencyAmount>
</CalculatedAmount>
<CalculatedAmount>
<FiscalYear>2021</FiscalYear>
<FiscalMonth>7</FiscalMonth>
<PeriodName>Jul-21</PeriodName>
<LCAmount>3466.666667</LCAmount>
<CCAmount>4144.850667</CCAmount>
<PositionCurrencyAmount>3466.666667</PositionCurrencyAmount>
</CalculatedAmount>
<CalculatedAmount>
<FiscalYear>2021</FiscalYear>
<FiscalMonth>8</FiscalMonth>
<PeriodName>Aug-21</PeriodName>
<LCAmount>3466.666667</LCAmount>
<CCAmount>4193.453334</CCAmount>
<PositionCurrencyAmount>3466.666667</PositionCurrencyAmount>
</CalculatedAmount>
<CalculatedAmount>
<FiscalYear>2021</FiscalYear>
<FiscalMonth>9</FiscalMonth>
<PeriodName>Sep-21</PeriodName>
<LCAmount>3466.666667</LCAmount>
<CCAmount>4202.016000</CCAmount>
<PositionCurrencyAmount>3466.666667</PositionCurrencyAmount>
</CalculatedAmount>
<CalculatedAmount>
<FiscalYear>2021</FiscalYear>
<FiscalMonth>10</FiscalMonth>
<PeriodName>Oct-21</PeriodName>
<LCAmount>3466.666667</LCAmount>
<CCAmount>4171.960000</CCAmount>
<PositionCurrencyAmount>3466.666667</PositionCurrencyAmount>
</CalculatedAmount>
<CalculatedAmount>
<FiscalYear>2021</FiscalYear>
<FiscalMonth>11</FiscalMonth>
<PeriodName>Nov-21</PeriodName>
<LCAmount>3466.666667</LCAmount>
<CCAmount>4178.165334</CCAmount>
<PositionCurrencyAmount>3466.666667</PositionCurrencyAmount>
</CalculatedAmount>
<CalculatedAmount>
<FiscalYear>2021</FiscalYear>
<FiscalMonth>12</FiscalMonth>
<PeriodName>Dec-21</PeriodName>
<LCAmount>3466.666667</LCAmount>
<CCAmount>4187.144000</CCAmount>
<PositionCurrencyAmount>3466.666667</PositionCurrencyAmount>
</CalculatedAmount>
<PositionCurrencyAmount>3466.666667</PositionCurrencyAmount>
</CalculatedAmount>
</CalculatedAmounts>
</CompensationItem>
</CompensationItems>
</EmployeePositionSummary>
</Positions>
</EmployeeCompensation>
</GetEmployeeCompensationsForPeriodsResult>
</GetEmployeeCompensationsForPeriodsResponse>
</soap:Body>
</soap:Envelope> Invalid Responses
An invalid response could be due to:
• Invalid or no data for Default Scenario
• Invalid filter value for a group of filters
• Invalid or employees out of the Budget cycle
• Invalid data for compensation items:
- Compensations not mapped to employees ( or) out of the Budget cycle
- For compensation Items with no user access
• Invalid or zero compensation item value for:
- Compensation items value calculated by system as zero for all the scenario months
- Compensation item value is 0 explicitly input by the user
- Compensation items with values calculated by system for some months and 0 for some months
- For employees whose data is not processed (status is ‘Not processed’)
- For employees out of the Budget cycle
Was this article helpful?