Assigning a Pay Rule Priority

Priority is important for when there are conflicts between pay rules.

For example, if you have a simple pay rate with the following rules:
Public Holiday
Sunday

Which rate should be paid if it is both a Sunday and a Public Holiday? The priority ordering tells the system which one to take first. This API sets the ordering.


URL and Payload

URL

curl --location --request POST 'https://{install}.{geo}.deputy.com/api/management/v2/compliance/contract-pay-rule-ordering'

Sample

{
  "contractId": "<long>",
  "payRuleIds": [
    "<long>",
    "<long>"
  ]
}

Response

{
  "success": "<boolean>"
}

Data Elements

Data ElementMandatoryInfo
contractIdYesId of the policy
payRuleIdsYesOrdering of the ids of the pay rules associated to the policy

Debugging Tip:

The base pay rule must always be included and be on the bottom of the list. Priority goes top down.


What’s Next

Did this page help you?