Percentage Allocation Rule Assignments - Aggregated
Use percentage allocation rules to change wages or to pay extra based on time entered in a timecard. Adjustments can be made based on multiple labor accounts and selection criteria, such as a labor category or cost center, or both.
Prerequisites
A person ID is the same identifier as personKey and employee ID, and is not the same as a person number.
Example
In this example, we assign, verify, delete, and pass a request that makes no change to multiple people's percentage allocation rule assignments.
Create or update assignments
The create or update request:
- uses
personIdentityto identify the person using their person number - uses
percentageAllocationRuleinsidepersonAssignmentsto define the percentage allocation rule to assign
Example request
Call POST /v1/commons/persons/assignments/multi_upsert with the following request payload.
[
{
"personIdentity": {
"personNumber": "90107"
},
"personAssignments": {
"percentageAllocationRule": {
"assignments": [
{
"effectiveDate": "2020-03-11",
"expirationDate": "2020-03-26",
"processor": {
"qualifier": "PA1"
}
},
{
"effectiveDate": "2020-03-26",
"expirationDate": "3000-01-01",
"processor": {
"qualifier": "PA2"
}
}
]
}
}
},
{
"personIdentity": {
"personNumber": "20335"
},
"personAssignments": {
"percentageAllocationRule": {
"assignments": [
{
"effectiveDate": "2020-03-11",
"expirationDate": "3000-01-01",
"processor": {
"qualifier": "PA1"
}
}
]
}
}
}
]
Example response
A success response returns HTTP status code 200 and a response body similar to the following example.
[
{
"personIdentity": {
"personNumber": "90107"
},
"personAssignments": {
"percentageAllocationRule": {
"assignments": [
{
"effectiveDate": "2020-03-11",
"expirationDate": "2020-03-26",
"processor": {
"qualifier": "PA1"
}
},
{
"effectiveDate": "2020-03-26",
"expirationDate": "3000-01-01",
"processor": {
"qualifier": "PA2"
}
}
]
}
}
},
{
"personIdentity": {
"personNumber": "20335"
},
"personAssignments": {
"percentageAllocationRule": {
"assignments": [
{
"effectiveDate": "2020-03-11",
"expirationDate": "3000-01-01",
"processor": {
"qualifier": "PA1"
}
}
]
}
}
}
]
Verify assignments
You can use the bulk multi-read operation to verify assignments for multiple people at once.
Example request
To verify, call POST /v1/commons/persons/assignments/multi_read with the following request payload.
{
"where": {
"employees": {
"key": "personNumber",
"values": [
"90107","20335"
]
},
"personAssignments": [
"percentageAllocationRule"
]
}
}
Example response
A success response returns HTTP status code 200 and a response body similar to the following example.
[
{
"personIdentity": {
"personNumber": "90107"
},
"personAssignments": {
"percentageAllocationRule": {
"assignments": [
{
"effectiveDate": "2020-03-11",
"expirationDate": "2020-03-26",
"processor": {
"qualifier": "PA1"
}
},
{
"effectiveDate": "2020-03-26",
"expirationDate": "3000-01-01",
"processor": {
"qualifier": "PA2"
}
}
]
}
}
},
{
"personIdentity": {
"personNumber": "20335"
},
"personAssignments": {
"percentageAllocationRule": {
"assignments": [
{
"effectiveDate": "2020-03-11",
"expirationDate": "3000-01-01",
"processor": {
"qualifier": "PA1"
}
}
]
}
}
}
]
Make no change to assignments
When working with large numbers of people, you may wish to pass a request payload that makes no changes to a person's percentage allocation rule assignments.
In the following example, the system makes no changes. Setting a null assignmentProfile and passing the unAssignExisting Boolean as false both result in no changes to a person's assignments.
Example request
Call POST /v1/commons/persons/assignments/multi_upsert with the following request payload.
[
{
"personIdentity": {
"personNumber": "10020"
},
"personAssignments": {
"percentageAllocationRule": {
"assignments": null
}
}
},
{
"personIdentity": {
"personNumber": "10030"
},
"personAssignments": {
"percentageAllocationRule": {
"unAssignExisting":false
}
}
}
]
Example response
A success response returns HTTP status code 200 and a response body similar to the following example.
[
{
"personIdentity": {
"personNumber": "10020"
},
"personAssignments": {
"percentageAllocationRule": {}
}
},
{
"personIdentity": {
"personNumber": "10030"
},
"personAssignments": {
"percentageAllocationRule": {}
}
}
]
Delete assignments
You can delete, or unassign, percentage allocation rule assignments. To delete our example's percentage allocation rule assignments, call POST /v1/commons/persons/assignments/multi_upsert using the unAssignExisting property.
Example request
Call POST /v1/commons/persons/assignments/multi_upsert with the following request payload.
[
{
"personIdentity": {
"personNumber": "10020"
},
"personAssignments": {
"percentageAllocationRule": {
"unAssignExisting":true
}
}
},
{
"personIdentity": {
"personNumber": "10030"
},
"personAssignments": {
"percentageAllocationRule": {
"unAssignExisting":true
}
}
}
]
Example response
A success response returns HTTP status code 200 and a response body similar to the following example.
[
{
"personIdentity": {
"personNumber": "10020"
},
"personAssignments": {
"percentageAllocationRule": {}
}
},
{
"personIdentity": {
"personNumber": "10030"
},
"personAssignments": {
"percentageAllocationRule": {}
}
}
]
Note: You can verify that the assignments were deleted by calling POST /v1/commons/persons/assignments/multi_read with a request payload specifying all of the affected person identities.
Updated over 1 year ago