Sets the opening balances for this employee.

Request

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

{
    "deductions": [
        {
            "amount": "double",
            "deductionCategoryId": "int32",
            "isMemberVoluntary": "boolean",
            "isRESC": "boolean",
            "isRescStatusReadOnly": "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"
        }
    ],
    "financialYearStartingYear": "int32",
    "grossEarnings": "double",
    "helpAmount": "double",
    "leaveBalances": [
        {
            "amount": "double",
            "leaveCategoryId": "int32",
            "name": "string",
            "unitType": "string"
        }
    ],
    "locationName": "string",
    "methodB2PaygWithholdingAmount": "double",
    "paygWithholdingAmount": "double",
    "primaryEtpType": {
        "etpType": "string",
        "generatePaymentSummary": "boolean",
        "isAmended": "boolean",
        "lumpSumD": "double",
        "paymentDate": "date-time",
        "taxFreeComponent": "double",
        "taxWithheld": "double",
        "taxableComponent": "double"
    },
    "secondaryEtpType": {
        "etpType": "string",
        "generatePaymentSummary": "boolean",
        "isAmended": "boolean",
        "lumpSumD": "double",
        "paymentDate": "date-time",
        "taxFreeComponent": "double",
        "taxWithheld": "double",
        "taxableComponent": "double"
    },
    "sfssAmount": "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[].isRescStatusReadOnly 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
  • MethodB2AdditionalPaymentsOpeningBalance
  • StatutorySickPay
  • StatutoryMaternityPay
  • StatutoryAdoptionPay
  • StatutoryPaternityPay
  • StatutorySharedParentalPay
  • ExtraPay
  • RedundancyPayRetirementAllowance
  • GenuineRedundancyLeaveLoading
  • HolidayPay
  • TerminationHolidayPay
  • AccLevy
  • AverageEarnings
  • TerminationAverageEarnings
  • RelevantDailyPay
  • TerminationRelevantDailyPay
  • TerminationPublicHolidayPay
  • GST
  • KeepingInTouchDay
  • LumpSumGratuity
  • LumpSumNoticePay
  • LumpSumExGratiaPayment
  • LumpSumOther
  • CompensationForLossOfOffice
  • Pre93RetirementBenefits
  • Post93RetirementBenefits
  • RestDayEmployerRequested
  • RestDayEmployeeRequested
  • PublicHoliday
  • EtpSuperableTypeOTaxable
  • EtpSuperableTypeOTaxFree
  • EtpTypeOUnusedLeavePayment
  • StatutoryParentalBereavementPay
  • UKPensionDeathBenefit
  • JobKeeperStart
  • JobKeeperFinish
  • JobKeeperTopUp
  • RestDay
  • EtpTypeSTaxable
  • EtpTypeSTaxFree
  • EtpTypePTaxable
  • EtpTypePTaxFree
  • EtpSuperableTypePTaxable
  • EtpSuperableTypePTaxFree
  • EtpTypePUnusedLeavePayment
  • JobKeeperTier
  • JobKeeperCancelTier
  • TerminationPayment
  • FlexibleDrawdownPayment
  • FlexibleDrawdownPaymentNonTaxable
  • PayrollHistory
  • PreviousYearEarnings
employeeId int32 Nullable
employerContribution double Nullable
employerLiabilities[] array
employerLiabilities[].amount double Decimal
employerLiabilities[].employerLiabilityCategoryId int32 Int32
employerLiabilities[].name string String
financialYearStartingYear int32 Nullable
grossEarnings double Nullable
helpAmount 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
methodB2PaygWithholdingAmount double Nullable
paygWithholdingAmount double Nullable
primaryEtpType object OpeningBalancesEtpModel
primaryEtpType.etpType string EtpTypeEnum

Possible values are:

  • O
  • P
  • R
  • S
primaryEtpType.generatePaymentSummary boolean Boolean
primaryEtpType.isAmended boolean Boolean
primaryEtpType.lumpSumD double Nullable
primaryEtpType.paymentDate date-time Nullable
primaryEtpType.taxFreeComponent double Nullable
primaryEtpType.taxWithheld double Nullable
primaryEtpType.taxableComponent double Nullable
secondaryEtpType object OpeningBalancesEtpModel
secondaryEtpType.etpType string EtpTypeEnum

Possible values are:

  • O
  • P
  • R
  • S
secondaryEtpType.generatePaymentSummary boolean Boolean
secondaryEtpType.isAmended boolean Boolean
secondaryEtpType.lumpSumD double Nullable
secondaryEtpType.paymentDate date-time Nullable
secondaryEtpType.taxFreeComponent double Nullable
secondaryEtpType.taxWithheld double Nullable
secondaryEtpType.taxableComponent double Nullable
sfssAmount 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