Sets the opening balances for this employee.

Request

POST https://apisg.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 SgOpeningBalancesModel resource, containing the following writable properties:

{
    "clearanceTaxAmount": "double",
    "cpf": {
        "cpfEmployeeContributionAmount": "double",
        "cpfEmployerContributionAmount": "double",
        "employerVoluntaryCpfAmount": "double",
        "employerVoluntaryMediSaveAmount": "double"
    },
    "deductions": [
        {
            "amount": "double",
            "deductionCategoryId": "int32",
            "name": "string"
        }
    ],
    "earningsLines": [
        {
            "amount": "double",
            "isStandardPayCategory": "boolean",
            "name": "string",
            "payCategoryId": "int32",
            "payCategoryType": "string"
        }
    ],
    "employeeId": "int32",
    "employerLiabilities": [
        {
            "amount": "double",
            "employerLiabilityCategoryId": "int32",
            "name": "string"
        }
    ],
    "financialYearStartingYear": "int32",
    "grossEarnings": "double",
    "leaveBalances": [
        {
            "amount": "double",
            "leaveCategoryId": "int32",
            "name": "string",
            "unitType": "string"
        }
    ],
    "locationName": "string",
    "numMonths": "int32",
    "totalHours": "double",
    "withholdingTaxAmount": "double"
}

Properties

Name Type Description
clearanceTaxAmount double Nullable
cpf object OpeningBalanceCpfModel
cpf.cpfEmployeeContributionAmount double Nullable
cpf.cpfEmployerContributionAmount double Nullable
cpf.employerVoluntaryCpfAmount double Nullable
cpf.employerVoluntaryMediSaveAmount double Nullable
deductions[] array
deductions[].amount double Decimal
deductions[].deductionCategoryId int32 Int32
deductions[].name string String
earningsLines[] array
earningsLines[].amount double Decimal
earningsLines[].isStandardPayCategory boolean Boolean
earningsLines[].name string String
earningsLines[].payCategoryId int32 Int32
earningsLines[].payCategoryType string PayCategoryType

Possible values are:

  • Standard
  • LeaveLoading
  • GenuineRedundancyLeavePayment
  • OpeningBalanceAllowances
  • EtpTypeRTaxable
  • EtpTypeRTaxFree
  • EtpTypeOTaxable
  • EtpTypeOTaxFree
  • EtpLumpSumD
  • StatutorySickPay
  • StatutoryMaternityPay
  • StatutoryAdoptionPay
  • StatutoryPaternityPay
  • StatutorySharedParentalPay
  • ExtraPay
  • RedundancyPayRetirementAllowance
  • GenuineRedundancyLeaveLoading
  • KeepingInTouchDay
  • AnnualHolidaysCashOut
  • HolidayPay
  • AccLevy
  • AverageEarnings
  • TerminationHolidayPay
  • TerminationAverageEarnings
  • MethodB2AdditionalPaymentsOpeningBalance
  • TerminationRelevantDailyPay
  • RelevantDailyPay
  • LumpSumGratuity
  • LumpSumNoticePay
  • LumpSumExGratiaPayment
  • LumpSumOther
  • CompensationForLossOfOffice
  • Pre93RetirementBenefits
  • Post93RetirementBenefits
  • TerminationPublicHolidayPay
  • RestDayEmployerRequested
  • RestDayEmployeeRequested
  • PublicHoliday
  • EtpSuperableTypeOTaxable
  • EtpSuperableTypeOTaxFree
  • EtpTypeOUnusedLeavePayment
  • StatutoryParentalBereavementPay
  • UKPensionDeathBenefit
  • JobKeeperStart
  • JobKeeperFinish
  • JobKeeperTopUp
  • RestDay
  • GST
  • EtpTypeSTaxable
  • EtpTypeSTaxFree
  • EtpTypePTaxable
  • EtpTypePTaxFree
  • EtpSuperableTypePTaxable
  • EtpSuperableTypePTaxFree
  • EtpTypePUnusedLeavePayment
  • JobKeeperTier
  • JobKeeperCancelTier
  • TerminationPayment
  • FlexibleDrawdownPayment
  • FlexibleDrawdownPaymentNonTaxable
  • PayrollHistory
  • PreviousYearEarnings
  • JobMakerNomination
  • JobMakerRenomination
  • JobMakerPeriod
  • JobMakerCancelNomination
  • JobMakerCancelRenomination
  • JobMakerCancelPeriod
  • NormalTerminationLeaveLoading
  • PublicHolidayWorked
  • PublicHolidayNotWorked
  • UnusedLeavePaymentNormalTermination
  • BackPayment
  • UkOccupationalSickPay
  • PaidFamilyAndDomesticViolenceLeave
  • UkOccupationalMaternityPay
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
numMonths int32 Nullable
totalHours double Nullable
withholdingTaxAmount double Nullable

Response

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

Status code Description Resource
200 OK

OK