Methods

  • post - Bulk Evaluate Shift Costings
  • post - Evaluate Shift Costings
  • post - Get Shift Costings for Employee

Resource

{
    "employmentAgreementId": "int32",
    "employmentAgreementName": "string",
    "payConditionRuleSetId": "int32",
    "payConditionRuleSetName": "string",
    "shifts": [
        {
            "consolidatedShifts": [
                "string"
            ],
            "cost": "double",
            "costBreakdown": [
                {
                    "cost": "double",
                    "endTime": "date-time",
                    "liabilityCategoryId": "int32",
                    "liabilityCategoryName": "string",
                    "locationId": "int32",
                    "locationName": "string",
                    "payCategoryId": "int32",
                    "payCategoryName": "string",
                    "rate": "double",
                    "startTime": "date-time",
                    "type": "string",
                    "units": "double"
                }
            ],
            "endTime": "date-time",
            "evaluationResults": [
                {
                    "matchResult": "string",
                    "ruleName": "string"
                }
            ],
            "externalId": "string",
            "startTime": "date-time"
        }
    ],
    "transactionExternalId": "string",
    "transactionId": "uuid"
}

Properties

Name Type Description
employmentAgreementId int32 Int32
employmentAgreementName string String
payConditionRuleSetId int32 Int32
payConditionRuleSetName string String
shifts[] array
shifts[].consolidatedShifts[] array of string
shifts[].cost double Decimal
shifts[].costBreakdown[] array
shifts[].costBreakdown[].cost double Decimal
shifts[].costBreakdown[].endTime date-time Nullable
shifts[].costBreakdown[].liabilityCategoryId int32 Nullable
shifts[].costBreakdown[].liabilityCategoryName string String
shifts[].costBreakdown[].locationId int32 Nullable
shifts[].costBreakdown[].locationName string String
shifts[].costBreakdown[].payCategoryId int32 Nullable
shifts[].costBreakdown[].payCategoryName string String
shifts[].costBreakdown[].rate double Decimal
shifts[].costBreakdown[].startTime date-time Nullable
shifts[].costBreakdown[].type string String
shifts[].costBreakdown[].units double Decimal
shifts[].endTime date-time DateTime
shifts[].evaluationResults[] array
shifts[].evaluationResults[].matchResult string RuleMatchResult

Possible values are:

  • NoMatch
  • Match
  • DisabledForRuleSet
  • DisabledForEmployee
  • ExcludedCustomRule
shifts[].evaluationResults[].ruleName string String
shifts[].externalId string String
shifts[].startTime date-time DateTime
transactionExternalId string String
transactionId uuid Guid