Direct Integration API icon

Direct Integration API

(0 reviews)

Other Assets

Sample Request

{
    "Package": {
        "Content": {
            "Application": {
                "NonRealEstateAsset": [
                   {
                       "EstimatedValue": {
                            "@EstimateBasis": "test",
                            "@Value": "test"
                        },
                        "FinancialAsset": {
                            "@AccountNumber": 1234,
                            "@OtherFIName": "asdf",
                            "@Type": "test",
                            "@BSB": "qwer",
                            "AccountNumber": {
                                "@FinancialInstitution": "test"
                            }
                        },
                        "PercentOwned": {
                            "Owner": [{
                                "@Percent": "test",
                                "@x_Party": "d12e51f22c3f"
                            }],
                            "@Proportions": "test"
                        },
                        "@SequenceNumber": "5",
                        "@Transaction": "Owns",
                        "@ToBeUsedAsSecurity": "test",
                        "@ToBeSold" : "test",
                        "@Type": "test",
                        "@UniqueID": "b39eebef8581"
                    }
              ]
            }
        }
    }
}

Detailed description of each field:
Field NameDescriptionTypePathRequiredEnumerationsNote
NonRealEstateAssetContains details about an asset item that is not real estate, such as a term deposit accountobjectPackage.Content.Application.NonRealEstateAsset
OtherAssetContainer element for other assetsobjectPackage.Content.Application.NonRealEstateAsset.OtherAsset
@DescriptionDescription of the asset, especially if Other Asset type is "Other"stringPackage.Content.Application.NonRealEstateAsset.OtherAsset.Description
FinancialAssetCaptures the details of a financial account asset or security - e.g. Cash, cash equivalents, and accounts at financial institutionsobjectPackage.Content.Application.NonRealEstateAsset.FinancialAsset
@DescriptionA description of the accountstringPackage.Content.Application.NonRealEstateAsset.FinancialAsset.Description
@TypeThe type of financial assetstringPackage.Content.Application.NonRealEstateAsset.FinancialAsset.TypeYesCash, Investment, KiwiSaver, Managed Funds, Pension Account, Receivables, Savings Account, Shares and Debentures, Superannuation, Term Deposit, Transition Account, Other
SharesContainer element for financial assets that are sharesobjectPackage.Content.Application.NonRealEstateAsset.FinancialAsset.Shares
@TypeWhen the Financial Asset Type = "Shares and Debentures", indicates the type of sharesstringPackage.Content.Application.NonRealEstateAsset.FinancialAsset.Shares.TypeBearer Securities, Debentures, Inscribed Stock Cth, Listed Shares, Options, Unlisted Shares
AccountNumberAccount details for the financial account assetobjectPackage.Content.Application.NonRealEstateAsset.FinancialAsset.AccountNumber
@AccountNumberThe unique number assigned to this account. (typically by the financial institution)stringPackage.Application.NonRealEstateAsset.FinancialAsset.AccountNumber.AccountNumber
@FinancialInstitutionThe financial institution where the account is heldstringPackage.Content.Application.NonRealEstateAsset.FinancialAsset.AccountNumber.FinancialInstitutionAfterpay, ANZ Bank, ASB Bank, Bank of Baroda, Bank of China, Bank of India, Bank of New Zealand, Bank of Tokyo-Mitsubishi, Brighten Home Loans, China Construction Bank, Citibank, Citiwide Home Loans, Commonwealth Bank, Deutsche Bank, Genoapay, Heartland Bank, Humm, International Commercial Bank of China, JPMorgan Chase, Kiwibank, Klarna, Kookmin Bank, Laybuy, Link Financial Group Limited, Openpay, Other, Oxipay, PartPay, Pepper New Zealand, Rabobank Nederland, Rabobank New Zealand, Southland Building Society, The Co-operative Bank, The Hongkong and Shanghai Banking Corporation, TSB Bank, Westpac Bank, Zip Co
@OtherFINameFor a financial institution not listed, the text name of the FIstringPackage.Content.Application.NonRealEstateAsset.FinancialAsset.AccountNumber.OtherFIName
@TypeIndicates what the type of non real estate asset being describedstringPackage.Content.Application.NonRealEstateAsset.TypeYes If Asset ExistsAgricultural, Aircraft, Business, Cleaning, Earth Moving, Mining and Construction, Financial Asset, Hospitality and Leisure, IT and AV Equipment, Licence, Materials Handling and Lifting, Medical, Mobile Computing, Motor Vehicle and Transport, Office Equipment, Other, "Plant, Equipment and Industrial", "Tools of Trade", "Water Rights", "Watercraft"
@BSBThe BSB number identifying where this account is heldstringPackage.Content.Application.NonRealEstateAsset.FinancialAsset.AccountNumber.BSB
BusinessContainer element for capturing Business detailsobjectPackage.Content.Application.NonRealEstateAsset.Business
@BusinessNameThe name of the businessstringPackage.Content.Application.NonRealEstateAsset.Business.BusinessName
@MainBusinessActivityDescription of the businesses main activitystringPackage.Content.Application.NonRealEstateAsset.Business.MainBusinessActivity
EstimatedValuesThe estimated value of the assetobjectPackage.Content.Application.NonRealEstateAsset.EstimatedValue
@EstimateBasisIndicates whether the estimate was based on the valuation of the applicant or a certified valuerstringPackage.Content.Application.NonRealEstateAsset.EstimatedValues.EstimateBasisYes if Asset ExistsApplicant Estimate, Certified Valuation, Price Guide
@ValueThe estimated current market value of the non real estate assetstringPackage.Content.Application.NonRealEstateAsset.EstimatedValues.ValueYes, if Asset Exists
@UniqueIDUnique identification assigned to the AssetstringPackage.Content.Application.NonRealEstateAsset.UniqueIDYes if Asset Exists
MotorVehicleContains information about an asset that is a motor vehicleobjectPackage.Content.Application.NonRealEstateAsset.MotorVehicle
@TypeThe type of vehicle. Types include bicycle, car, caravan, truck etc.stringPackage.Content.Application.NonRealEstateAsset.MotorVehicle.TypeYesCar, Light Commercial, Truck, Motorcycle, Watercraft, Bicycle, Bus Coach or Special Purpose, Caravan, Trailer, Bodies, Locomotive, Rail Cars, Other
@DescriptionA description of the motor vehiclestringPackage.Content.Application.NonRealEstateAsset.MotorVehicle.Description
@MakeCaptures the make of the vehicle, such as HoldenstringPackage.Content.Application.NonRealEstateAsset.MotorVehicle.Make
@ModelCaptures the model of the vehiclestringPackage.Content.Application.NonRealEstateAsset.MotorVehicle.Model
@RegistrationNumberDate of expiry of registrationstringPackage.Content.Application.NonRealEstateAsset.MotorVehicle.RegistrationNumber
@YearCaptures the year in which the vehicle was first registered or the model yearstringPackage.Content.Application.NonRealEstateAsset.MotorVehicle.Year
OtherAssetContainer element for other assetsobjectPackage.Content.Application.NonRealEstateAsset.OtherAsset
@TypeContainer element for other non real estate assetsstringPackage.Content.Application.NonRealEstateAsset.OtherAsset.TypeYesArt Works, Good Will of Business, Home Contents, Intellectual Property, Stock and Inventory, Other
PercentOwnedAn asset may be owned by one or more parties, typically the applicants, so there may be more than one owner referenced. An asset 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 asset may be assigned. If the asset is to be purchased, then this indicates the expected ownership arrangement post-settlementobjectPackage.Content.Application.NonRealEstateAsset.PercentOwned
@ProportionsFlag to indicate whether the ownership proportions are equal across all owners, specified individually for each one, or not specifiedstringPackage.Content.Application.NonRealEstateAsset.PercentOwned.ProportionsYes if Asset ExistsEqual, Not Specified, Specified
OwnerContainer that associates a reference to an owner or other responsible party with the percentage of the item that they own or are responsible forobjectPackage.Content.Application.NonRealEstateAsset.PercentOwned.Owner
@PercentCaptures the percentage of the item that referenced party owns or is responsible forstringPackage.Content.Application.NonRealEstateAsset.PercentOwned.Owner.PercentYes if Asset Exists
@x_PartyContains a reference to a party that is an owner of the item, or has a similar relationship such as a borrower or beneficiarystringPackage.Content.Application.NonRealEstateAsset.PercentOwned.Owner.x_PartyYes if Asset Exists
@ToBeUsedAsSecurityIndicates whether the asset is to be used as security for the new or refinanced loan(s)stringPackage.Content.Application.NonRealEstateAsset.ToBeUsedAsSecurityYes, No
@ToBeSoldIndicates whether the asset will be sold prior to or at settlementstringPackage.Content.Application.NonRealEstateAsset.ToBeSoldYes, No
@TransactionIndicates the current status of the applicants' ownership of the property, or the transaction that is proposed by them in relation to the propertystringPackage.Content.Application.NonRealEstateAsset.TransactionOwns, Owns Existing Mortgage, Purchasing, Sold, Transfer

Reviews