Create benefit in kind

Creates a new benefit in kind for the employee.

Request

POST https://apisg.yourpayroll.io/api/v2/business/{businessId}/employee/{employeeId}/benefitsinkind

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

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

{
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "basisPeriod": "int32",
    "benefit": "double",
    "benefitType": "string",
    "carBenefits": "double",
    "costOfAccommodation": "double",
    "costOfHomeLeavePassagesIncidentalBenefits": "double",
    "costOfMotorVehiclesGivenToEmployee": "double",
    "driver": "double",
    "educationalExpense": "double",
    "employeesSharingPremises": "int32",
    "entranceTransferFeesAnnualSubscription": "double",
    "freeOrSubsidisedHolidays": "double",
    "furnishedType": "string",
    "gainsFromAsset": "double",
    "id": "int32",
    "insurancePremiumsPaidByEmployer": "double",
    "interestPaymentMadeByEmployer": "double",
    "otherNonMonetaryAwardsBenefits": "double",
    "paidByEmployee": "double",
    "periodOfOccupationFromDate": "date-time",
    "periodOfOccupationToDate": "date-time",
    "servantUpkeepOfCompound": "double",
    "totalRentPaidByEmployee": "double",
    "utilitiesGadgets": "double"
}

Properties

Name Type Description
addressLine1 string String
addressLine2 string String
addressLine3 string String
basisPeriod int32 Int32
benefit double Nullable
benefitType string Nullable

Possible values are:

  • Value
  • Rent
carBenefits double Nullable
costOfAccommodation double Nullable
costOfHomeLeavePassagesIncidentalBenefits double Nullable
costOfMotorVehiclesGivenToEmployee double Nullable
driver double Nullable
educationalExpense double Nullable
employeesSharingPremises int32 Nullable
entranceTransferFeesAnnualSubscription double Nullable
freeOrSubsidisedHolidays double Nullable
furnishedType string Nullable

Possible values are:

  • Partially
  • Fully
gainsFromAsset double Nullable
id int32 Int32
insurancePremiumsPaidByEmployer double Nullable
interestPaymentMadeByEmployer double Nullable
otherNonMonetaryAwardsBenefits double Nullable
paidByEmployee double Nullable
periodOfOccupationFromDate date-time Nullable
periodOfOccupationToDate date-time Nullable
servantUpkeepOfCompound double Nullable
totalRentPaidByEmployee double Nullable
utilitiesGadgets double Nullable

Response

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

Status code Description Resource
200 OK

OK