Setting Junior Rates

The Employment Contract Config endpoint is used to configure many components of a pay rate, including:

  • General Settings
  • Employment Type and Active
  • Junior Rates
  • Pay Rule Shared Settings

This page will go through Junior Rates

URL and Payload

URL

curl --location --request POST 'https://{install}.{geo}.deputy.com/api/management/v2/compliance/contract-config:batch-save'

Sample

{
  "configs": [
    {
      "id": "<long>",
      "contractId": "<long>",
      "category": "CONTRACT_CONFIG_CATEGORY_UNKNOWN",
      "config": "<string>",
      "status": "CONTRACT_CONFIG_STATUS_INACTIVE"
    },
    {
      "id": "<long>",
      "contractId": "<long>",
      "category": "CONTRACT_CONFIG_CATEGORY_UNKNOWN",
      "config": "<string>",
      "status": "CONTRACT_CONFIG_STATUS_INACTIVE"
    }
  ]
}

Example -

{
  "configs": \[  
            { 
                 "id": 323,  
                "contractId": 403,  
                "category": "CONTRACT_CONFIG_CATEGORY_JUNIOR_RATE",  
                "config": "{\"rates\": [{\"age\": 15, \"rate\": \"20\", \"tooltipContent\": \"lowest-rate\"}, {\"age\": 16, \"rate\": \"21\", \"tooltipContent\": \"minimum-rate\"}, {\"age\": 17, \"rate\": \"22\", \"tooltipContent\": \"minimum-rate\"}, {\"age\": 18, \"rate\": \"23\", \"tooltipContent\": \"minimum-rate\"}, {\"age\": 19, \"rate\": \"24\", \"tooltipContent\": \"minimum-rate\"}, {\"age\": 20, \"rate\": \"25\", \"tooltipContent\": \"minimum-rate\"}, {\"age\": 21, \"rate\": \"25\", \"tooltipContent\": \"highest-rate\"}]}",  
                "status": "CONTRACT_CONFIG_STATUS_ACTIVE"
            },
{
   "id": 324,
                "contractId": 404,
                "category": "CONTRACT_CONFIG_CATEGORY_JUNIOR_RATE",
                "config": "{\"rates\": [{\"age\": 15, \"rate\": 0.15}, {\"age\": 16, \"rate\": 0.16}, {\"age\": 17, \"rate\": 0.17}, {\"age\": 18, \"rate\": 0}, {\"age\": 19, \"rate\": 0}, {\"age\": 20, \"rate\": 0}, {\"age\": 21, \"rate\": 0}], \"payType\": \"MULTIPLIER\"}",
                "status": "CONTRACT_CONFIG_STATUS_ACTIVE"
}
  
  ]}

Response

{
  "success": "<boolean>",
  "error": "<string>"
}

Data Elements - Junior Rates

Data ElementMandatoryInfo
contract_IdYesPay Rate id assigned to
categoryYes

This selects the type of contract config being set. Options are:

CONTRACT_CONFIG_CATEGORY_GLOBAL_SETTINGS = 2;
CONTRACT_CONFIG_CATEGORY_JUNIOR_RATE = 3;
CONTRACT_CONFIG_CATEGORY_CONTRACT_DETAILS = 4;
CONTRACT_CONFIG_CATEGORY_PAY_POLICY_CONTEXT = 5;
CONTRACT_CONFIG_CATEGORY_SHARED_CONTEXT = 6;

configYesSee below - variable based on what config is being set.
statusYes"CONTRACT_CONFIG_STATUS_ACTIVE" for active

Config - Junior Rates

The example above shows how rates are configured for both per hour and percentage based queries.


What’s Next

Did this page help you?