UkSapApiCalculationResultViewModel resource

Methods

  • get - Get statutory adoption pay calculation for pay run

Resource

{
    "averageWeeklyEarnings": "double",
    "calculationTypeUsed": "string",
    "log": [
        {
            "category": "string",
            "message": "string",
            "messages": [
                "string"
            ],
            "type": "string"
        }
    ],
    "payments": [
        {
            "amount": "double",
            "breakdown": [
                {
                    "amount": "double",
                    "date": "date-time"
                }
            ],
            "daysPaid": "int32",
            "doNotPayReason": "string",
            "endDate": "date-time",
            "id": "int32",
            "include": "boolean",
            "isPending": "boolean",
            "offsetSap": "boolean",
            "payRunId": "int32",
            "startDate": "date-time",
            "status": "string",
            "statusDescription": "string",
            "weekNumber": "int32"
        }
    ],
    "rates": {
        "<key>": "int32"
    },
    "status": "string"
}

Properties

Name Type Description
averageWeeklyEarnings double Decimal
calculationTypeUsed string SapCalculationTypeEnum

Possible values are:

  • AlignWithPayPeriod
  • WeeklyPayments
log[] array
log[].category string StatutoryLeaveLogCategoryEnum

Possible values are:

  • General
  • AWE
log[].message string String
log[].messages[] array of string
log[].type string StatutoryLeaveLogEventTypeEnum

Possible values are:

  • Info
  • Error
  • Warning
  • Success
payments[] array
payments[].amount double Nullable
payments[].breakdown[] array
payments[].breakdown[].amount double Decimal
payments[].breakdown[].date date-time DateTime
payments[].daysPaid int32 Int32
payments[].doNotPayReason string Nullable

Possible values are:

  • NotEmployedLongEnough
  • AweNotHighEnough
  • LeaveNoticeInvalid
  • MedicalEvidenceInvalid
  • BabyBornNoticeInvalid
  • InLegalCustody
  • WorkAfterBirth
  • PayCurtailedShpp
payments[].endDate date-time DateTime
payments[].id int32 Int32
payments[].include boolean Boolean
payments[].isPending boolean Boolean
payments[].offsetSap boolean Boolean
payments[].payRunId int32 Nullable
payments[].startDate date-time DateTime
payments[].status string Nullable

Possible values are:

  • Paid
  • Pending
  • Dnp
  • AlreadyPaid
payments[].statusDescription string String
payments[].weekNumber int32 Int32
rates object IDictionary
rates.<key> map of int32 Int32
status string SapEligibilityEnum

Possible values are:

  • NotEligible
  • Eligible