Create voluntary CPF contributions

Adds voluntary CPF contributions to the specified pay run.

Request

POST https://apisg.yourpayroll.io/api/v2/business/{businessId}/payrun/{payRunId}/voluntarycpf

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

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

{
    "cpfAdjustments": {
        "<key>": "array"
    },
    "employeeIdType": "string",
    "payRunId": "int32",
    "replaceExisting": "boolean",
    "suppressCalculations": "boolean"
}

Properties

Name Type Description
cpfAdjustments object Dictionary
cpfAdjustments.<key> map of array List
cpfAdjustments.<key>.amount double Decimal
cpfAdjustments.<key>.contributionType string String
cpfAdjustments.<key>.employeeExternalId string String
cpfAdjustments.<key>.employeeId string String
cpfAdjustments.<key>.employeeName string String
cpfAdjustments.<key>.externalId string String
cpfAdjustments.<key>.id int32 Int32
cpfAdjustments.<key>.locationId string String
cpfAdjustments.<key>.locationName string String
cpfAdjustments.<key>.notes string String
employeeIdType string IdType

Possible values are:

  • Standard
  • External
payRunId int32 Int32
replaceExisting boolean Boolean
suppressCalculations boolean Boolean

Response

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

Status code Description Resource
200 OK

OK