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 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",
    "paygWithholdingAmount": "double",
    "sfssAmount": "double",
    "superContribution": "double",
    "totalHours": "double"
}

Properties

Name Type
deductions[] array
deductions[].amount double
deductions[].deductionCategoryId int32
deductions[].isMemberVoluntary boolean
deductions[].isRESC boolean
deductions[].name string
deductions[].taxExempt boolean
earningsLines[] array
earningsLines[].amount double
earningsLines[].isStandardPayCategory boolean
earningsLines[].name string
earningsLines[].payCategoryId int32
earningsLines[].payCategoryType string
employeeId int32
employerContribution double
employerLiabilities[] array
employerLiabilities[].amount double
employerLiabilities[].employerLiabilityCategoryId int32
employerLiabilities[].name string
etpTypeO object
etpTypeO.generatePaymentSummary boolean
etpTypeO.isAmended boolean
etpTypeO.lumpSumD double
etpTypeO.paymentDate date-time
etpTypeO.taxFreeComponent double
etpTypeO.taxWithheld double
etpTypeO.taxableComponent double
etpTypeR object
etpTypeR.generatePaymentSummary boolean
etpTypeR.isAmended boolean
etpTypeR.lumpSumD double
etpTypeR.paymentDate date-time
etpTypeR.taxFreeComponent double
etpTypeR.taxWithheld double
etpTypeR.taxableComponent double
financialYearStartingYear int32
grossEarnings double
helpAmount double
leaveBalances[] array
leaveBalances[].amount double
leaveBalances[].leaveCategoryId int32
leaveBalances[].name string
locationName string
paygWithholdingAmount double
sfssAmount double
superContribution double
totalHours double

Response

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

Status code Description Resource
200 OK

OK