Sets the opening balances for this employee.

Request

POST https://keypay.yourpayroll.com.au/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 OpeningBalancesEditModel resource, containing the following writable properties:

{
    "deductions": [
        {
            "amount": "double",
            "deductionCategoryId": "int32",
            "isMemberVoluntary": "boolean",
            "isRESC": "boolean",
            "name": "string",
            "taxExempt": "boolean"
        }
    ],
    "earningsLines": [
        {
            "amount": "double",
            "isStandardPayCategory": "boolean",
            "name": "string",
            "payCategoryId": "int32",
            "payCategoryType": "string"
        }
    ],
    "employeeId": "int32",
    "employerContribution": "double",
    "employerLiabilities": [
        {
            "amount": "double",
            "employerLiabilityCategoryId": "int32",
            "name": "string"
        }
    ],
    "etpTypeO": {
        "generatePaymentSummary": "boolean",
        "isAmended": "boolean",
        "lumpSumD": "double",
        "paymentDate": "date-time",
        "taxFreeComponent": "double",
        "taxWithheld": "double",
        "taxableComponent": "double"
    },
    "etpTypeR": {
        "generatePaymentSummary": "boolean",
        "isAmended": "boolean",
        "lumpSumD": "double",
        "paymentDate": "date-time",
        "taxFreeComponent": "double",
        "taxWithheld": "double",
        "taxableComponent": "double"
    },
    "financialYearStartingYear": "int32",
    "grossEarnings": "double",
    "helpAmount": "double",
    "leaveBalances": [
        {
            "amount": "double",
            "leaveCategoryId": "int32",
            "name": "string"
        }
    ],
    "locationName": "string",
    "nationalInsurance": {
        "categoryData": [
            {
                "category": "string",
                "eligibleEarnings": "double",
                "employeeContribution": "double",
                "employerContribution": "double",
                "lelCalculation": "double",
                "ptCalculation": "double",
                "stCalculation": "double",
                "uelCalculation": "double",
                "uelPlusCalculation": "double"
            }
        ]
    },
    "paygWithholdingAmount": "double",
    "pension": {
        "employeePensionContributionAmount": "double",
        "employerPensionContributionAmount": "double",
        "taxReliefPensionAmount": "double"
    },
    "previousEmployer": {
        "financialYearStarting": "int32",
        "taxWithheld": "double",
        "taxablePay": "double"
    },
    "sfssAmount": "double",
    "studentLoanAmount": "double",
    "superContribution": "double",
    "totalHours": "double"
}

Properties

Name Type Description
deductions[] array
deductions[].amount double Decimal
deductions[].deductionCategoryId int32 Int32
deductions[].isMemberVoluntary boolean Boolean
deductions[].isRESC boolean Boolean
deductions[].name string String
deductions[].taxExempt boolean Boolean
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
employeeId int32 Nullable
employerContribution double Nullable
employerLiabilities[] array
employerLiabilities[].amount double Decimal
employerLiabilities[].employerLiabilityCategoryId int32 Int32
employerLiabilities[].name string String
etpTypeO object OpeningBalancesEtpModel
etpTypeO.generatePaymentSummary boolean Boolean
etpTypeO.isAmended boolean Boolean
etpTypeO.lumpSumD double Nullable
etpTypeO.paymentDate date-time Nullable
etpTypeO.taxFreeComponent double Nullable
etpTypeO.taxWithheld double Nullable
etpTypeO.taxableComponent double Nullable
etpTypeR object OpeningBalancesEtpModel
etpTypeR.generatePaymentSummary boolean Boolean
etpTypeR.isAmended boolean Boolean
etpTypeR.lumpSumD double Nullable
etpTypeR.paymentDate date-time Nullable
etpTypeR.taxFreeComponent double Nullable
etpTypeR.taxWithheld double Nullable
etpTypeR.taxableComponent double Nullable
financialYearStartingYear int32 Nullable
grossEarnings double Nullable
helpAmount double Nullable
leaveBalances[] array
leaveBalances[].amount double Decimal
leaveBalances[].leaveCategoryId int32 Int32
leaveBalances[].name string String
locationName string String
nationalInsurance object OpeningNationalInsuranceModel
nationalInsurance.categoryData[] array
nationalInsurance.categoryData[].category string Nullable

Possible values are:

  • A
  • B
  • C
  • H
  • J
  • M
  • Z
nationalInsurance.categoryData[].eligibleEarnings double Decimal
nationalInsurance.categoryData[].employeeContribution double Decimal
nationalInsurance.categoryData[].employerContribution double Decimal
nationalInsurance.categoryData[].lelCalculation double Decimal
nationalInsurance.categoryData[].ptCalculation double Decimal
nationalInsurance.categoryData[].stCalculation double Decimal
nationalInsurance.categoryData[].uelCalculation double Decimal
nationalInsurance.categoryData[].uelPlusCalculation double Decimal
paygWithholdingAmount double Nullable
pension object OpeningPensionsModel
pension.employeePensionContributionAmount double Nullable
pension.employerPensionContributionAmount double Nullable
pension.taxReliefPensionAmount double Nullable
previousEmployer object PreviousEmployerEditModel
previousEmployer.financialYearStarting int32 Int32
previousEmployer.taxWithheld double Decimal
previousEmployer.taxablePay double Decimal
sfssAmount double Nullable
studentLoanAmount double Nullable
superContribution double Nullable
totalHours double Nullable

Response

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

Status code Description Resource
200 OK

OK