PayRules

Predict-match a PayRules record

Returns the closest matching existing record for a partial payload. Used by upsert-style integrations to find an existing row before creating.

post/resource/PayRules/PREDICT

Request

  • Base URL
    https://your-subdomain.deputy.deputy.com/api/v1
  • URL
    https://your-subdomain.deputy.deputy.com/api/v1/resource/PayRules/PREDICT
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://once.deputy.com/my/oauth/login
      Token URL: https://once.deputy.com/my/oauth/access_token

Request body

Idinteger required
PayTitlestring required
RemunerationTypeinteger required
RemunerationByinteger required
AnnualSalarynumber double
HourlyRatenumber double
IsMultiplierboolean
MultiplierValuenumber double
MultiplierBaseRateinteger
MinimumTypeinteger
MaximumTypeinteger
MinimumValuenumber double
MaximumValuenumber double
MinimumShiftLengthstring
MaximumShiftLengthstring
AdvancedCalculationstring
IsExportedboolean required
UnitValuenumber double
Scheduleinteger
RecommendWithinteger
DexmlScriptinteger
DexmlScriptParamstring
PeriodTypeinteger
PayPortionRuleinteger
PayrollCategorystring
Commentstring
RateTypeinteger
RateTagstring
Creatorinteger
Createdstring date-time
Modifiedstring required
CtIdstring
CrIdstring
StpClassstring
StpCodestring
MultiplierBaseRateObjectobject
ScheduleObjectobject
DexmlScriptObjectobject

Response

Success

Idinteger required
PayTitlestring required
RemunerationTypeinteger required
RemunerationByinteger required
AnnualSalarynumber double
HourlyRatenumber double
IsMultiplierboolean
MultiplierValuenumber double
MultiplierBaseRateinteger
MinimumTypeinteger
MaximumTypeinteger
MinimumValuenumber double
MaximumValuenumber double
MinimumShiftLengthstring
MaximumShiftLengthstring
AdvancedCalculationstring
IsExportedboolean required
UnitValuenumber double
Scheduleinteger
RecommendWithinteger
DexmlScriptinteger
DexmlScriptParamstring
PeriodTypeinteger
PayPortionRuleinteger
PayrollCategorystring
Commentstring
RateTypeinteger
RateTagstring
Creatorinteger
Createdstring date-time
Modifiedstring required
CtIdstring
CrIdstring
StpClassstring
StpCodestring
MultiplierBaseRateObjectobject
ScheduleObjectobject
DexmlScriptObjectobject

Changes

No recorded changes to this operation across all 1 revision of this API.