Schema

Scalars

Enums

Objects

Input Objects

SourcingProduct (OBJECT)

A Sourcing Product

Schema Definition

type SourcingProduct {   # The categorized adverse tier level on this product if applicable.
adverseTierLevel: Int   # Indicates whether the product can be applied for online using APPLY
applyOnline: Boolean   # The product’s APRC value
aprLenders: Float   # The amount of the arrangement fee for the product
arrangementFee: Float   # The amount of the booking fee for the product
bookingFee: Float   # The amount of the Broker fee for the product
brokerFee: Float   # Total cashback amount available for the product
cashback: Float   # The amount of the CHAPS fee for the product
chapsFee: Int   # The amount of the Deeds Release fee
deedsReleaseFee: Float   # The Disbursement Fee amount
disbursementFee: Float   # When the early repayment charges applicable come to an end - June 2014, June 2019
earlyRepaymentChargeAppliesUntil: String   # Field used to sort ERC dates
earlyRepaymentChargePeriodSortField: String   # These are the total fees associated with obtaining the mortgage - Valuation fee, Booking fee and arrangement fee
feesTotal: Float   # The amount of the HLC for the product
higherLendingCharge: Float   # Inheritance Protection Option for the Equity Release Product
inheritance: Boolean   # The initial monthly mortgage payment based on loan amount and term at the mortgage product’s initial pay rate
initialMonthlyPayment: Float   # When sourcing Secured Loans/Further Advances/Porting, if the ExistingMortgage object for Applicant 1 is provided, then this field will provide the cost of the initial monthly payment, plus the cost of the applicant’s existing mortgage as defined by the CurrentMonthlyPayment amount.
initialMonthlyPaymentIncExistingMortgage: Float   # Mortgage Product’s initial charging rate
initialPayRate: Float   # The description of when the initial rate period ends – e.g. Jun-2016, 2 years, etc.
initialRatePeriod: String   # The length of time (in months) of the product’s initial rate period – e.g. 24 months, 60 months, etc.
initialRatePeriodMonths: Int   # Specifies the lender’s reference number or code for the product.
lenderProductReference: String   # The maximum calculated loan amount available for this product.
maxLoanAvailable: Float   # The maximum LTV available on this product
maxLtvAvailable: Int   # Product type - Fixed, Discount, Variable, Capped, Libor, Tracker, or Stepped.
mortgageClass: String   # The amount of the Mortgage Discharge fee
mortgageDischargeFee: Float   # The Net Proc Fee amount
netProcFee: Float   # Ability to make Optional Partial Repayments for the Equity Release Product
optionalPartialRepayment: Boolean   # The name of the packager if it is a packager product, otherwise empty
packagerName: String   # Total Gross Proc Fee amount
procFee: Float   # Who the product is available to - All, Direct Only Exclusive or intermediary
productAvailability: String   # A unique identifier for each product within the engine (may be 3 or 6 characters long)
productCode: String   # This specifies the type of match the sourcing engine has made. Possible values are “Available” and “Near Miss”. “Near Miss” values will appear when an “Include_Near_Misses” search type has been selected and a product has fallen within the buffer zones specified in the NearMissesDetails object.
productMatchStatus: String   # Name of the product - indicating what type of mortgage product it is
productName: String   # The type of product. The possible values are: Residential, Buy To Let, Secured Loan, Secured Loan BTL, Bridging Loan, Commercial, Let To Buy, Equity Release.
productType: String   # A delimited list (|) of the reasons why the product was marked as a “Near Miss”. Example value: “Maximum LTV Available|Maximum Term Available”
rejectReasons: String   # Lenders standard variable rate. Normally what the mortgage rate reverts to after the initial rate has come to an end
standardVariableRate: Float   # This is how much the mortgage will cost over the custom duration specified by the ‘CalculateOverNoOfMonths’ field in the TrueCostDetails object. Also referred to as Total Cost. In order to have the system calculate this value, there must be a value set in the CalculateOverNoOfMonths, and loan amount and term values must also be specified in the request.
trueCost: Float   # When sourcing Secured Loans/Further Advances/Porting, if the ExistingMortgage object for Applicant 1 is provided, then this field will provide the principal outstanding at the end of the True Cost period.
trueCostBalanceOutstanding: Float   # When sourcing Secured Loans/Further Advances/Porting, if the ExistingMortgage object for Applicant 1 is provided, then this field will provide the balance outstanding including all applicable fees plus the cost of the applicant’s esixting mortgage.
trueCostBalanceOutstandingIncExistingMortgage: Float   # This is the True Cost of the mortgage over the full term as specified by the Term and TermUnit fields in the request. In order to have the system calculate this value, the loan amount and term values must be specified in the request.
trueCostFullTerm: Float   # When sourcing Secured Loans/Further Advances/Porting, if the ExistingMortgage object for Applicant 1 is provided, then this field will provide the total cost of the loan over the full term as specified by the Term and TermUnit fields in the request, plus the cost of the applicant’s existing mortgage as defined by the CurrentMonthlyPayment and MonthsRemainingOnMortgage fields. If the MonthsRemainingOnMortgage field is not provided, then the existing mortgage’s CurrentMonthlyPayment value is considered to apply over the full term as specified by the request.
trueCostFullTermIncExistingMortgage: Float   # When sourcing Secured Loans/Further Advances/Porting, if the ExistingMortgage object for Applicant 1 is provided, then this field will provide the total cost of the loan over the specified custom duration in CalculateOverNoOfMonths in the TrueCostDetails object or over the full term if a custom duration is not provided, plus the cost of the applicant’s existing mortgage as defined by the CurrentMonthlyPayment and MonthsRemainingOnMortgage fields. If the MonthsRemainingOnMortgage field is not provided, then the existing mortgage’s CurrentMonthlyPayment value is considered to apply over the full term as specified by the request.
trueCostIncExistingMortgage: Float   # When sourcing Secured Loans/Further Advances/Porting, if the ExistingMortgage object for Applicant 1 is provided, then this field will provide the total cost of the loan over the full term as specified by the Term and TermUnit fields in the request, plus the cost of the applicant’s existing mortgage as defined by the CurrentMonthlyPayment and MonthsRemainingOnMortgage fields. If the MonthsRemainingOnMortgage field is not provided, then the existing mortgage’s CurrentMonthlyPayment value is considered to apply over the full term as specified by the request.
trueCostInitialPeriodIncExistingMortgage: Float   # This is how much the mortgage will cost over just the product’s initial rate period. In order to have the system calculate this value, the field CalculateOverInitialPeriod field must be set to true in the TrueCostDetails object, and there must also be loan amount and term values specified in the request.
trueCostOverInitialPeriod: Float   # The amount of the valuation fee for the product
valuationFee: Float }