Sets the opening balances for this employee.

Request

POST https://apimy.yourpayroll.io/api/v2/business/{businessId}/employee/{employeeId}/openingbalances

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

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

{
    "benefitsInKind": {
        "benefitsInKindItems": [
            {
                "amount": "double",
                "benefitsInKindType": "string",
                "description": "string",
                "taxExempt": "boolean"
            }
        ]
    },
    "employeeId": "int32",
    "employerLiabilities": [
        {
            "amount": "double",
            "employerLiabilityCategoryId": "int32",
            "name": "string"
        }
    ],
    "financialYearStartingYear": "int32",
    "grossEarnings": "double",
    "leaveBalances": [
        {
            "amount": "double",
            "leaveCategoryId": "int32",
            "name": "string",
            "unitType": "string"
        }
    ],
    "locationName": "string",
    "payrollHistory": {
        "annualEarningsEndDate": "date-time",
        "annualEarningsStartDate": "date-time",
        "hasPayrollHistory": "boolean",
        "numberOfPeriods": "int32",
        "payPeriod": "string",
        "totalAllowances": "double",
        "totalBiksTaxExempt": "double",
        "totalBiksTaxable": "double",
        "totalCP38": "double",
        "totalDeductions": "double",
        "totalEPFEmployee": "double",
        "totalEPFEmployer": "double",
        "totalGrossEarnings": "double",
        "totalSocsoEmployee": "double",
        "totalSocsoEmployer": "double",
        "totalTax": "double",
        "totalZakat": "double"
    },
    "statutoryContributionsAndPcb": {
        "additionalEmployeeEpfAmount": "double",
        "additionalEmployerEpfAmount": "double",
        "cP38Amount": "double",
        "employeeEisAmount": "double",
        "employeeSocsoAmount": "double",
        "employerEisAmount": "double",
        "employerSocsoAmount": "double",
        "hrdfAmount": "double",
        "mandatoryEmployeeEpfAmount": "double",
        "mandatoryEmployerEpfAmount": "double",
        "pcbAmount": "double",
        "tp1ReliefAmount": "double",
        "tp1ZakatAmount": "double"
    },
    "taxReliefs": {
        "taxReliefTotal": "double",
        "taxReliefs": [
            {
                "amount": "double",
                "description": "string",
                "override": "boolean",
                "reliefNumber": "int32",
                "threshold": "double",
                "total": "double",
                "type": "string"
            }
        ],
        "taxYear": "int32"
    },
    "totalHours": "double"
}

Properties

Name Type Description
benefitsInKind object OpeningBalancesMyBenefitsInKindModel
benefitsInKind.benefitsInKindItems[] array
benefitsInKind.benefitsInKindItems[].amount double Decimal
benefitsInKind.benefitsInKindItems[].benefitsInKindType string MyBenefitsInKindType

Possible values are:

  • MotorCar
  • PetrolWithoutCar
  • DriverProvided
  • HouseholdFurnishings
  • BenefitsOrGifts
  • MonthlyBills
  • OtherAssets
  • DentalBenefit
  • ChildcareBenefit
  • FoodAndDrink
  • FreeTransportation
  • ObligatoryInsurance
  • GroupInsurance
  • LeavePassage
  • BenefitsEmploymentDuties
  • DiscountsGoodsAndServices
  • BenefitsMonthlyBills
  • BenefitsMedicalTreatment
  • PetrolBenefits
  • Other
  • LivingAccommodation
benefitsInKind.benefitsInKindItems[].description string String
benefitsInKind.benefitsInKindItems[].taxExempt boolean Boolean
employeeId int32 Nullable
employerLiabilities[] array
employerLiabilities[].amount double Decimal
employerLiabilities[].employerLiabilityCategoryId int32 Int32
employerLiabilities[].name string String
financialYearStartingYear int32 Nullable
grossEarnings double Nullable
leaveBalances[] array
leaveBalances[].amount double Decimal
leaveBalances[].leaveCategoryId int32 Int32
leaveBalances[].name string String
leaveBalances[].unitType string LeaveUnitTypeEnum

Possible values are:

  • Hours
  • Days
  • Weeks
locationName string String
payrollHistory object OpeningBalancesPayrollHistoryModel
payrollHistory.annualEarningsEndDate date-time Nullable
payrollHistory.annualEarningsStartDate date-time Nullable
payrollHistory.hasPayrollHistory boolean Boolean
payrollHistory.numberOfPeriods int32 Int32
payrollHistory.payPeriod string Nullable

Possible values are:

  • Weekly
  • Fortnightly
  • Monthly
  • AdHoc
  • Initial
  • PreviousEmployer
  • FourWeekly
  • Quarterly
  • Annually
  • HistoricGrossEarnings
  • HalfMonthly
payrollHistory.totalAllowances double Decimal
payrollHistory.totalBiksTaxExempt double Decimal
payrollHistory.totalBiksTaxable double Decimal
payrollHistory.totalCP38 double Decimal
payrollHistory.totalDeductions double Decimal
payrollHistory.totalEPFEmployee double Decimal
payrollHistory.totalEPFEmployer double Decimal
payrollHistory.totalGrossEarnings double Decimal
payrollHistory.totalSocsoEmployee double Decimal
payrollHistory.totalSocsoEmployer double Decimal
payrollHistory.totalTax double Decimal
payrollHistory.totalZakat double Decimal
statutoryContributionsAndPcb object OpeningBalancesStatutoryContributionsModel
statutoryContributionsAndPcb.additionalEmployeeEpfAmount double Decimal
statutoryContributionsAndPcb.additionalEmployerEpfAmount double Decimal
statutoryContributionsAndPcb.cP38Amount double Decimal
statutoryContributionsAndPcb.employeeEisAmount double Decimal
statutoryContributionsAndPcb.employeeSocsoAmount double Decimal
statutoryContributionsAndPcb.employerEisAmount double Decimal
statutoryContributionsAndPcb.employerSocsoAmount double Decimal
statutoryContributionsAndPcb.hrdfAmount double Decimal
statutoryContributionsAndPcb.mandatoryEmployeeEpfAmount double Decimal
statutoryContributionsAndPcb.mandatoryEmployerEpfAmount double Decimal
statutoryContributionsAndPcb.pcbAmount double Decimal
statutoryContributionsAndPcb.tp1ReliefAmount double Decimal
statutoryContributionsAndPcb.tp1ZakatAmount double Decimal
taxReliefs object OpeningBalancesTaxReliefModel
taxReliefs.taxReliefTotal double Decimal
taxReliefs.taxReliefs[] array
taxReliefs.taxReliefs[].amount double Decimal
taxReliefs.taxReliefs[].description string String
taxReliefs.taxReliefs[].override boolean Boolean
taxReliefs.taxReliefs[].reliefNumber int32 Int32
taxReliefs.taxReliefs[].threshold double Decimal
taxReliefs.taxReliefs[].total double Decimal
taxReliefs.taxReliefs[].type string TaxReliefTypeEnum

Possible values are:

  • IndividualAndDependentRelatives
  • MedicalTreatment
  • BasicSupportingEquipment
  • DisabledIndividual
  • EducationFeesDegrees
  • MedicalExpenses
  • CompleteMedicalExamination
  • LifestyleExpenses
  • PurchaseOfBreastfeedingEquipment
  • ChildCareFees
  • NetDepositInSSPN
  • Spouse
  • DisabledHusbandWife
  • UnmarriedChildUnder18
  • UnmarriedChildOver18Education
  • UnmarriedChildOver18FullTimeEducation
  • DisabledChild
  • LifeInsuranceAndEPF
  • DeferredAnnuityAndPRS
  • EducationAndMedicalInsurance
  • ContributionToTheSOCSO
  • EmployeesProvidentFundOrApprovedScheme
  • DisabledChildOver18FullTimeEducation
  • HusbandWifePayment
  • PaymentCommissionerOfTourism
  • MedicalTreatmentOneMotherOnly
  • MedicalTreatmentOneFatherOnly
  • EducationFeesCourses
  • LifestyleExpensesB
taxReliefs.taxYear int32 Int32
totalHours double Nullable

Response

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

Status code Description Resource
200 OK

OK