Apply statutory adoption payments to pay run

Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/sap/employee/{employeeId}

Path parameters

Parameter name Value Description Additional
employeeId int32 Required
payRunId int32 Required
businessId string Required

Request body

The request body takes a complete UkApplySapPaymentsApiModel resource, containing the following writable properties:

{
    "doNotPayReason": "string",
    "payments": [
        {
            "amount": "double",
            "daysPaid": "int32",
            "doNotPayReason": "string",
            "endDate": "date-time",
            "id": "int32",
            "include": "boolean",
            "isPending": "boolean",
            "offsetSap": "boolean",
            "payRunId": "int32",
            "startDate": "date-time",
            "status": "string",
            "weekNumber": "int32"
        }
    ]
}

Properties

Name Type Description
doNotPayReason string Nullable

Possible values are:

  • NotEmployedLongEnough
  • AweNotHighEnough
  • LeaveNoticeInvalid
  • MedicalEvidenceInvalid
  • BabyBornNoticeInvalid
  • InLegalCustody
  • WorkAfterBirth
  • PayCurtailedShpp
payments[] array
payments[].amount double Nullable
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[].weekNumber int32 Int32

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK