Direct Integration API icon

Direct Integration API

(0 reviews)

RealEstateAsset

Sample Request

{
    "Package": {
        "Content": {
            "Application": {
                "RealEstateAsset": [
                    {
                        "ContractDetails": {
                            "@ContractPriceAmount": 1200,
                            "@ArmsLengthTransaction": "Test",
                            "@LicensedRealEstateAgentContract": "Yes",
                            "@ContractDate": "2020-02-05",
                            "@DepositAmount": 100,
                            "@DepositPaid": 8,
                            "@TransferOfLandAmount": 700
                        },
                        "EstimatedValue": {
                            "@EstimateBasis": "Bank Assessment",
                            "@Value": 1200
                        },
                        "PercentOwned": {
                            "Owner": [
                                {
                                    "@Percent": 100,
                                    "@x_Party": "a0030d9d2870"
                                }
                            ],
                            "@Proportions": ""
                        },
                        "PropertyFeatures": {
                            "@FloorArea": 4,
                            "@LandArea": 1,
                            "@LandAreaUnits": "Acres"
                        },
                        "Residential": {
                            "@Type": "Apartment Unit Flat"
                        },
                        "RentalIncome": {
                            "@EvidenceOfTenancy": "Yes",
                            "@Frequency": "Daily",
                            "@RentalAmount": 1000
                        },
                        "Title": {
                            "@TenureType": "None",
                            "@TitleSystem": "Company",
                            "@Folio": "Test",
                            "@Lot": "Test",
                            "@LotPlan": "Test",
                            "@Volume": "Test"
                        },
                        "VisitContact": {
                            "@Type": "Applicant",
                            "@x_ContactParty": "f857ae9f5f7e"
                        },
                        "@ApprovalInPrinciple": "Yes",
                        "@Holding": "Sole",
                        "@PrimaryPurpose": "Owner Occupied",
                        "@PrimarySecurity": "Yes",
                        "@PrimaryUsage": "Residential",
                        "@PropertyID": "sder45678",
                        "@Status": "Established",
                        "@ToBeUsedAsSecurity": "Yes",
                        "@Transaction": "Owns",
                        "@UniqueID": "f857ae9f5f78",
                        "@x_Address": "d177811716f4"
                    }
                ]
            }
        }
    }
}

Detailed description of each field:
Field NameDescriptionTypePathRequiredEnumerationsNote
RealEstateAssetContains information about an asset which is real propertyarrayPackage.Content.Application.RealEstateAsset
ContractDetailsContains information relating to the construction of a dwelling on a security propertyobjectPackage.Content.Application.RealEstateAsset.ConstructionDetails
@ContractPriceAmountCaptures the total purchase/sale price as specified in the Contract of SaleNumberPackage.Content.Application.RealEstateAsset.ContractDetails.ContractPriceAmount
@ArmsLengthTransactionFlag to indicate whether the transacting parties are arms length partiesstringPackage.Content.Application.RealEstateAsset.ContractDetails.ArmsLengthTransaction
@LicensedRealEstateAgentContractIndicates that the Contract of Sale uses a form that has been developed for use by real estate agents, as opposed to lawyers and conveyancers. Relevant in States where this practice has not been superseded by a standard form contract of salestringPackage.Content.Application.RealEstateAsset.ContractDetails.LicencedRealEstateAgentContract
@ContractDateThe date of the Contract of SalestringPackage.Content.Application.RealEstateAsset.ContractDetails.ContractDate
@DepositAmountCaptures the total amount that is or was payable as a deposit for the security property being purchasedNumberPackage.Content.Application.RealEstateAsset.ContractDetails.DepositAmount
@DepositPaidCaptures the amount of the purchase deposit that has been paid by the applicants as at the date the application is submittedNumberPackage.Content.Application.RealEstateAsset.ContractDetails.DepositPaid
@TransferOfLandAmountThe value of the property, as used for the calculation of stamp dutyNumberPackage.Content.Application.RealEstateAsset.ContractDetails.TransferOfLandAmount
EstimatedValueContains details about the estimated value of the propertyobjectPackage.Content.Application.RealEstateAsset.EstimatedValue
@EstimateBasisIndicates whether the estimate was based on the valuation of the applicant or a certified valuerstringPackage.Content.Application.RealEstateAsset.EstimatedValue.EstimateBasisApplicant Estimate, Certified Valuation
@ValueThe estimated value of the real estateNumberPackage.Content.Application.RealEstateAsset.EstimatedValue.Value
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-settlement. If the percentage ownership is not shown, then ownership is assumed to be in equal partsobjectPackage.Content.Application.RealEstateAsset.PercentOwned
OwnerContainer that associates a reference to an owner or other responsible party with the percentage of the item that they own or are responsible forarrayPackage.Content.Application.RealEstateAsset.PercentOwned.Owner
@PercentCaptures the percentage of the item that referenced party owns or is responsible forNumberPackage.Content.Application.RealEstateAsset.PercentOwned.Owner.PercentYes
@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.RealEstateAsset.PercentOwned.Owner.x_PartyYes
@ProportionsFlag to indicate whether the ownership proportions are equal across all owners, specified individually for each one, or not specifiedstringPackage.Content.Application.RealEstateAsset.PercentOwned.Proportions
PropertyFeaturesContainer for information about the property's featuresobjectPackage.Content.Application.RealEstateAsset.PropertyFeatures
@FloorAreaThe floor area of the building on the property, in sqm. Where is more than one dwelling or structure on the property, then the lender's policy will determine how the applicant is to calculate the floor area. For a residential property, generally speaking this is the living areaNumberPackage.Content.Application.RealEstateAsset.PropertyFeatures.FloorArea
@LandAreaThe land area of the property. The units of measurement must also be specified with this figureNumberPackage.Content.Application.RealEstateAsset.PropertyFeatures.LandArea
@LandAreaUnitsThe units of measurement for the stated land areastringsPackage.Content.Application.RealEstateAsset.PropertyFeatures.LandAreaUnits
ResidentialContains information about real estate that is residentialobjectPackage.Content.Application.RealEstateAsset.Residential
@TypeThe type of dwelling that exists or is to be located on the residential property. For an established or new dwelling, specifies the type of dwelling that is currently located on the residential property. For an off-the-plan purchase or construction loan, specifies the type of dwelling that will be constructed. If the vacant property is notionally residential but without an intention to build in the immediate future, then the type would remain Vacant LandstringPackage.Content.Application.RealEstateAsset.Residential.TypeYesAged Care Unit, Apartment Unit Flat, Converted Commercial Property, Converted Motel Units, Display House, Duplex, Fully Detached House, Holiday Home, Property Development, Relocatable Home, Resort Unit, Semi Detached House, Serviced Apartment, Terrace, Townhouse, Unit Student Accommodation, Vacant Land, Villa
RentalIncomeInformation about rental income earned from the propertyobjectPackage.Content.Application.RealEstateAsset.RentalIncome
@EvidenceOfTenancyIndicates whether the applicant can provide the lender with evidence that the property is tenanted, typically in the form of a leasestringPackage.Content.Application.RealEstateAsset.RentalIncome.EvidenceOfTenancy
@FrequencyThe frequency of rental payments gross amountstringPackage.Content.Application.RealEstateAsset.RentalIncome.FrequencyWeekly, Fortnightly, Monthly, Quarterly, Half Yearly, Yearly
@RentalAmountThe gross amount of rent that is paid under the lease. The frequency (weekly, monthly etc.) for the rental amount specified should also be explicitly specifiedNumberPackage.Content.Application.RealEstateAsset.RentalIncome.RentalAmount
TitleContains information relating to the title details for the real propertyPackage.Content.Application.RealEstateAsset.Title
@TenureTypeThe type of title scheme that the owners derive their tenure or estate fromstringPackage.Content.Application.RealEstateAsset.Title.TenureType
@TitleSystemThe type of title regime that the property is governed bystringPackage.Content.Application.RealEstateAsset.Title.TitleSystem
@FolioFolio of the land titlestringPackage.Content.Application.RealEstateAsset.Title.Folio
@LotLot identifier of the land titlestringPackage.Content.Application.RealEstateAsset.Title.Lot
@LotPlanContains the Lot Plan detailstringPackage.Content.Application.RealEstateAsset.Title.LotPlan
@VolumeShould be provided when Title Type = \"Torrens Title\"stringPackage.Content.Application.RealEstateAsset.Title.Volume
VisitContactContains details of the party who the lender's valuer should contact to arrange an inspection of the propertyobjectPackage.Content.Application.RealEstateAsset.VisitContact
@TypeThe relationship of the valuation contact to the property to be inspectedstringPackage.Content.Application.RealEstateAsset.VisitContact.Type
@x_ContactPartyThe party that should be contacted to arrange site visitstringPackage.Content.Application.RealEstateAsset.VisitContact.x_ContactParty
@ApprovalInPrincipleIndicates that the applicant has not yet identified a specific property for purchase but that this property represents a general description of the type of property they are looking to purchase, so an approval in principle is sought from the lenderstringPackage.Content.Application.RealEstateAsset.ApprovalInPrinciple
@HoldingSpecified the capacity in which the owners hold, or will hold in the case of a proposed purchase, their interest in the propertystringPackage.Content.Application.RealEstateAsset.HoldingYes
@PrimaryPurposeIndicates the primary or predominant purpose for which the owners hold the propertystringPackage.Content.Application.RealEstateAsset.PrimaryPurposeYesInvestment, Owner Occupied
@PrimarySecurityIndicates whether the property will be the primary security for the loan(s). Primary security is to be contrasted with collateral securities, which equally secure the borrowings but which are stamped collateral to the primary securitystringPackage.Content.Application.RealEstateAsset.PrimarySecurityYes
@PrimaryUsageThe primary usage of the propertystringPackage.Content.Application.RealEstateAsset.PrimaryUsageYesResidential
@PropertyIDThe property ID from the data providerstringPackage.Content.Application.RealEstateAsset.PropertyIDYes
@StatusIndicates the state of any current dwelling on the propertystringPackage.Content.Application.RealEstateAsset.StatusYes
@ToBeUsedAsSecurityIndicates whether the asset is to be used as security for the new or refinanced loan(s)stringPackage.Content.Application.RealEstateAsset.ToBeUsedAsSecurityYes
@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.RealEstateAsset.TransactionYesOwns, Purchasing
@UniqueIDSystem assigned unique identifierstringPackage.Content.Application.RealEstateAsset.UniqueIDYes
@x_AddressAddress should capture the location details of real estate assetstringPackage.Content.Application.RealEstateAsset.x_AddressYes, if To Be Used As Security = Yes

Reviews