Update a lump sum

Update an existing lump sum.

Request

PUT https://apisg.yourpayroll.io/api/v2/business/{businessId}/employee/{employeeId}/lumpsum/{id}

Path parameters

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

Request body

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

{
    "approved": "boolean",
    "basisPeriod": "int32",
    "dateOfApproval": "date-time",
    "employingEntityId": "int32",
    "id": "int32",
    "paymentBasis": "string",
    "paymentReason": "string",
    "retirementBenefitsFund": "string",
    "serviceLength": "string"
}

Properties

Name Type Description
approved boolean Nullable
basisPeriod int32 Int32
dateOfApproval date-time Nullable
employingEntityId int32 Nullable
id int32 Int32
paymentBasis string String
paymentReason string String
retirementBenefitsFund string String
serviceLength string String

Response

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

Status code Description Resource
200 OK

OK