Direct Integration API

(0 reviews)

OtherIncome

Sample Request

{
    "Package": {
        "Content": {
            "Application": {
                "OtherIncome": [
                    {
                        "PercentOwned": {
                            "Owner": {
                                "@Percent": "100",
                                "@x_Party": "bbcc2a6dde95"
                            },
                            "@Proportions": "Equal"
                        },
                        "@Amount": "1234",
                        "@Frequency": "Fortnightly",
                        "@SequenceNumber": "0",
                        "@Type": "Dividends",
                        "@UniqueID": "a154c478ea2d",
                        "@GovernmentBenefitsType": "Accident Compensation"
                    }
                ]
            }
        }
    }
}

Field Name	Description	Type	Path	Required	Enumerations	Note
OtherIncome	Captures information about income earned by the applicants that is not captured under the Employment element for Person Applicants or Income elements for Company and Trust Applicants	array	Package.Content.Application.OtherIncome
@Amount	The gross amount of income received in the period specified for the income item	number	Package.Content.Application.OtherIncome.Amount	Yes		Mandatory, if other income exists in request
@Frequency	The frequency at which the applicant is receiving other income gross amount	string	Package.Content.Application.OtherIncome.Frequency	Yes	Fortnightly,Monthly,Weekly,Yearly	Mandatory, if other income exists in request
@GovernmentBenefitsType	Where the applicant has indicated government benefits as an income source, the type of benefits should be captured. Such as family, unemployed or widow's allowance	string	Package.Content.Application.OtherIncome.GovernmentBenefitsType		Accident Compensation,Child Support,Family Allowance,Invalid Benefits,Other,Parenting Payment,Sickness Benefits,Sole Parent Support,Widows Allowance,Working for Families
@Type	The type of income described by the income item	string	Package.Content.Application.OtherIncome.Type	Yes	Annuities,Board,Child Maintenance,Dividends,Foreign Sourced,Government Benefits,Interest Income,Other Income,Private Pension,Superannuation,Untaxed Allowable Income	Mandatory, if other income exists in request
@UniqueID	System assigned unique identifier	string	Package.Content.Application.OtherIncome.UniqueID	Yes		Mandatory, if other income exists in request
PercentOwned	An income item may be owned by one or more parties, typically the applicants, so there may be more than one owner referenced. An income item may also be partially owned by a non-applicant, such as an applicant's spouse, in which case the third party owner may be referenced, or less than 100% ownership of the income may be assigned	object	Package.Content.Application.OtherIncome.PercentOwned	Yes		Mandatory, if other income exists in request
@Proportions	Flag to indicate whether the ownership proportions are equal across all owners, specified individually for each one, or not specified	string	Package.Content.Application.OtherIncome.PercentOwned.Proportions	Yes	Equal,Specified,Not Specified	Mandatory, if other income exists in request
Owner	Container that associates a reference to an owner or other responsible party with the percentage of the item that they own or are responsible for	object	Package.Content.Application.OtherIncome.PercentOwned.Owner	Yes		Mandatory, if other income exists in request
@Percent	Captures the percentage of the item that referenced party owns or is responsible for	number	Package.Content.Application.OtherIncome.PercentOwned.Owner.Percent	Yes		Mandatory, if other income exists in request
@x_Party	Contains a reference to a party that is an owner of the item, or has a similar relationship such as a borrower or beneficiary	string	Package.Content.Application.OtherIncome.PercentOwned.Owner.x_Party	Yes		Mandatory, if other income exists in request

OtherIncome

Sample Request

Reviews