GetEmployeeAllocationsData

7 Minutes to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

We have introduced an API to pull allocations data of employees from the Planful Application for the WorkForce Integrations. To pull allocations data the user has to process all the employees. All the employees mapped to compensation items should be processed, if the accounts mapped to those compensation items are updated.

Note

Per API call the system will pull the allocations data upto 500 employees for a specified single year.

• Scenario
• Employee Number
• Employee Name
• Position Description
• Home Budget Entity
• Compensation Item
• Seg1 to Seg 8
• Fiscal Year
• Fiscal Months/periods (month name and fiscal month)
• Allocation percentage
• Amount (LC, CC, and Position Budget entity currency)

You can filter the Allocations data using the below-mentioned fields for the filtering combination:
• Scenario
• Fiscal Year
• Employee Number
• Position Description
• Home Budget Entity
• Compensation Item
• Accounts
• Fiscal Month/Period specified as numeric

Note

Scenario and FiscalYear are mandatory fields.

The below fields will be optional and needs to be provided as part of AllocationFilters :
• Employees
• Positions
• HomeBudgetEntities
• CompensationItems
• FiscalMonths
• Accounts

All the allocation data will be extracted for existing employee positions if the Employee Number is provided. Similarly, the specific employee position data will be extracted if the Employee Number and Position Description are provided.
Note: Accounts and Compensation Item fields are available in the API response irrespective of the tenant configuration, By Compensation or By Department.

Notes

Per API call the system will pull the allocations data upto 500 employees for a specified single year.

Method
POST

Endpoint Url Syntax
/Allocation/GetEmployeesAllocationsData

Headers

Key	Value
APIKey	Key

Sample Request:


				{
				"Scenario": "2021 Plan1",
				"FiscalYear": 2021,
				"AllocationFilters": [
				{
				"FilterOption": "Employees",
				"Values": [ "5038", "5039" ]
				},
				{
				"FilterOption": "FiscalMonths",
				"Values": [ "1", "2" ]
				}
				]
				}

Sample Reponse:



				{
				"Scenario": "2021 Plan1",
				"EmployeeAllocations": [
				{
				"EmployeeInfo": {
				"HomeBudgetEntityCode": "France - Sales",
				"HomeBudgetEntityName": "",
				"Number": "5038",
				"Name": "Ruth Bell"
				},
				"Positions": [
				{
				"PositionName": "Sales Manager",
				"CompensationItems": [
				{
				"Code": "Salaries",
				"Name": "Salaries - Full Time",
				"AllocationAmounts": [
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "60000"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "1",
				"PeriodName": "Jan-21",
				"LCAmount": "3466.666667",
				"CCAmount": "4224.618667",
				"PositionCurrencyAmount": "3466.666667",
				"AllocationPercentage": "100"
				},
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "60000"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "2",
				"PeriodName": "Feb-21",
				"LCAmount": "3466.666667",
				"CCAmount": "4206.938667",
				"PositionCurrencyAmount": "3466.666667",
				"AllocationPercentage": "100"
				}
				]
				},
				{
				"Code": "Bonus",
				"Name": "Bonus",
				"AllocationAmounts": [
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "60050"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "1",
				"PeriodName": "Jan-21",
				"LCAmount": "14.444456",
				"CCAmount": "17.602592",
				"PositionCurrencyAmount": "14.444456",
				"AllocationPercentage": "100"
				},
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "60050"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "2",
				"PeriodName": "Feb-21",
				"LCAmount": "14.444456",
				"CCAmount": "17.528925",
				"PositionCurrencyAmount": "14.444456",
				"AllocationPercentage": "100"
				}
				]
				},
				{
				"Code": "FTE",
				"Name": "FTE",
				"AllocationAmounts": [
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "S61000"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "1",
				"PeriodName": "Jan-21",
				"LCAmount": "1.000000",
				"CCAmount": "1.000000",
				"PositionCurrencyAmount": "1.000000",
				"AllocationPercentage": "100"
				},
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "S61000"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "2",
				"PeriodName": "Feb-21",
				"LCAmount": "1.000000",
				"CCAmount": "1.000000",
				"PositionCurrencyAmount": "1.000000",
				"AllocationPercentage": "100"
				}
				]
				},
				{
				"Code": "Headcount",
				"Name": "Headcount",
				"AllocationAmounts": [
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "S61002"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "1",
				"PeriodName": "Jan-21",
				"LCAmount": "1.000000",
				"CCAmount": "1.000000",
				"PositionCurrencyAmount": "1.000000",
				"AllocationPercentage": "100"
				},
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "S61002"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "2",
				"PeriodName": "Feb-21",
				"LCAmount": "1.000000",
				"CCAmount": "1.000000",
				"PositionCurrencyAmount": "1.000000",
				"AllocationPercentage": "100"
				}
				]
				}
				]
				}
				]
				},
				{
				"EmployeeInfo": {
				"HomeBudgetEntityCode": "France - Sales",
				"HomeBudgetEntityName": "",
				"Number": "5039",
				"Name": "Jana Montgomery"
				},
				"Positions": [
				{
				"PositionName": "Sales Engineer",
				"CompensationItems": [
				{
				"Code": "Salaries",
				"Name": "Salaries - Full Time",
				"AllocationAmounts": [
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "60000"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "1",
				"PeriodName": "Jan-21",
				"LCAmount": "3466.666667",
				"CCAmount": "4224.618667",
				"PositionCurrencyAmount": "3466.666667",
				"AllocationPercentage": "100"
				},
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "60000"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "2",
				"PeriodName": "Feb-21",
				"LCAmount": "3466.666667",
				"CCAmount": "4206.938667",
				"PositionCurrencyAmount": "3466.666667",
				"AllocationPercentage": "100"
				}
				]
				},
				{
				"Code": "Bonus",
				"Name": "Bonus",
				"AllocationAmounts": [
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "60050"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "1",
				"PeriodName": "Jan-21",
				"LCAmount": "14.444456",
				"CCAmount": "17.602592",
				"PositionCurrencyAmount": "14.444456",
				"AllocationPercentage": "100"
				},
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "60050"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "2",
				"PeriodName": "Feb-21",
				"LCAmount": "14.444456",
				"CCAmount": "17.528925",
				"PositionCurrencyAmount": "14.444456",
				"AllocationPercentage": "100"
				}
				]
				},
				{
				"Code": "FTE",
				"Name": "FTE",
				"AllocationAmounts": [
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "S61000"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "1",
				"PeriodName": "Jan-21",
				"LCAmount": "1.000000",
				"CCAmount": "1.000000",
				"PositionCurrencyAmount": "1.000000",
				"AllocationPercentage": "100"
				},
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "S61000"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "2",
				"PeriodName": "Feb-21",
				"LCAmount": "1.000000",
				"CCAmount": "1.000000",
				"PositionCurrencyAmount": "1.000000",
				"AllocationPercentage": "100"
				}
				]
				},
				{
				"Code": "Headcount",
				"Name": "Headcount",
				"AllocationAmounts": [
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "S61002"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "1",
				"PeriodName": "Jan-21",
				"LCAmount": "1.000000",
				"CCAmount": "1.000000",
				"PositionCurrencyAmount": "1.000000",
				"AllocationPercentage": "100"
				},
				{
				"Segments": [
				{
				"SegmentName": "Account",
				"SegmentValue": "S61002"
				},
				{
				"SegmentName": "Entity",
				"SegmentValue": "EUR1"
				},
				{
				"SegmentName": "Department",
				"SegmentValue": "100"
				},
				{
				"SegmentName": "Product",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Project",
				"SegmentValue": "0000"
				},
				{
				"SegmentName": "Customer",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Custom2",
				"SegmentValue": "000"
				},
				{
				"SegmentName": "Interco",
				"SegmentValue": "ICDefault"
				}
				],
				"FiscalYear": "2021",
				"FiscalMonth": "2",
				"PeriodName": "Feb-21",
				"LCAmount": "1.000000",
				"CCAmount": "1.000000",
				"PositionCurrencyAmount": "1.000000",
				"AllocationPercentage": "100"
				}
				]
				}
				]
				}
				]
				}
				]
				}

Was this article helpful?

What's Next

GetEmployeeCompensationsForPeriods