Prepare to invest in new opportunity

  • APIs
  • Quick Quote with Margin Uplift

Quick Quote With Margin Uplift

The get indicative pricing partner method will return HPFS Finance options and indicative pricing based on HW/Printer/Services amounts including partner uplift capability.

Quick Start

URL


Authenication


HP Security Certificate is required and it is supplied on demand

See this API for yourself - select one of our examples below to prepopulate the values below.
Parameters
Name Type Description
Country
 String
CurrencyCode
 String
LeaseType
 String
LeaseTerm
 String
PaymentFrequency
 String
HardwareAmount
 Decimal
PrinterAmount
 Decimal
SoftwareAmount
 Decimal
ServiceAndOtherAmount
 Decimal
FmvMargin
 Decimal
FlMargin
 Decimal
LoanMargin
 Decimal
submit


Making API Request...
Output
Lease Type Lease Term Payment Frequency Amount AmountIncUplift
This is the raw view
This is the raw view
Parameters

This API accepts the following parameters:

Name Type Description
PricingHeaderDetails
 Object PricingDetails request header

Name Type Description
ClientAuthenticationKey String Unique Client Authentication key provided by HFS(not utilized at the moment)
ClientProgramID String Unique client calling to trace application name - provided by HPFS
LanguageCode String ISO 2 language code to identify language os the validation message send to calling client
PartnerID String Unique PartnerId provied by HPFS
TransmissionId String Unique transaction id supplied by the calling service client
PricingRequst
 Object Pricing request

Name Type Description
CountryCode String Pricing request country - ISO2
CurrencyCode String Pricing request currency - ISO3
HardwareAmount Decimal 12678967.543233.
PrinterAmount Decimal 12678967.543233.
ServiceAndOtherAmount Decimal 12678967.543233.
SoftwareAmount Decimal 12678967.543233.
LeaseTerm
 Integer For the Lease Term options choose from

LeaseTerm Lease Term Description
12 12 Months
24 24 Months
36 36 Months
48 48 Months
60 60 Months
All All Lease Term
LeaseType
 String For the Lease Type options choose from

LeaseType Lease Description
FL Finance Lease
FMV Fair Market Value
SUB Subscription
LN Loan
ALL All Lease Types
PaymentFrequency
 String For the Payment Frequency options choose from

PaymentFrequency Payment Frequency Description
MON Monthly
QUA Quarterly
ALL All Payment Frequencies
FlMargin
 Decimal Finance Lease uplift margin enter a percentage value as a decimal, for example: 1.5

FmvMargin Finance Lease Margin Description
0 No Finance Lease Margin Uplift
0.5 0.5% Finance Lease Margin Uplift
1 1% Finance Lease Margin Uplift
1.5 1.5% Finance Lease Margin Uplift
2 2% Finance Lease Margin Uplift
2.5 2.5% Finance Lease Margin Uplift
3 3% Finance Lease Margin Uplift
FmvMargin
 Decimal Fair Market Value uplift margin enter a percentage value as a decimal, for example: 1.5

FmvMargin Fmv Margin Description
0 No FMV Margin Uplift
0.5 0.5% FMV Margin Uplift
1 1% FMV Margin Uplift
1.5 1.5% FMV Margin Uplift
2 2% FMV Margin Uplift
2.5 2.5% FMV Margin Uplift
3 3% FMV Margin Uplift
3.5 3.5% FMV Margin Uplift
4 4% FMV Margin Uplift
4.5 4.5% FMV Margin Uplift
5 5% FMV Margin Uplift
LoanMargin
 Decimal Loan Margin uplift margin enter a percentage value as a decimal, for example: 1.5

LoanMargin Loan Margin Description
0 No Loan Margin Uplift
0.5 0.5% Loan Margin Uplift
1 1% Loan Margin Uplift
1.5 1.5% Loan Margin Uplift
2 2% Loan Margin Uplift
2.5 2.5% Loan Margin Uplift
3 3% Loan Margin Uplift
SourceEntryPerson
 Object SourceEntryPerson request

Name Type Description
FirstName String Source entry person first name
LastName String Source entry person last name
UserEmail String Source entry person e-mail
JSON Request Model Schema
This is a JSON schema that describes the syntax of the request. 

     {
	"PricingHeaderDetails":{
		"ClientAuthenticationKey":"String content",
		"ClientProgramID":"String content",
		"LanguageCode":"String content",
		"PartnerID":"String content",
		"TransmissionId":"String content"
	},
	"PricingRequst":{
		"CountryCode":"String content",
		"CurrencyCode":"String content",
		"HardwareAmount":Decimal,
                "PrinterAmount":Decimal,
		"ServiceAndOtherAmount":Decimal,
		"SoftwareAmount":Decimal,
		"LeaseTerm":"String content",
		"LeaseType":"String content",
                "PaymentFrequency":"String content",
                "FlMargin":Decimal,
		"FmvMargin":Decimal,
		"LnMargin":Decimal
	},
	"SourceEntryPerson":{
		"FirstName":"String content",
		"LastName":"String content",
		"UserEmail":"String content"
	}
}
XML Request Model Schema
This is a XML schema that describes the syntax of the request. 

<QuickQuoteInput >
  <PricingHeaderDetails>
    <ClientAuthenticationKey>String content</ClientAuthenticationKey>
    <ClientProgramID>String content</ClientProgramID>
    <LanguageCode>String content</LanguageCode>
    <PartnerID>String content</PartnerID>
    <TransmissionId>String content</TransmissionId>
  </PricingHeaderDetails>
 <PricingRequst>
    <CountryCode>String content</CountryCode>
    <CurrencyCode>String content</CurrencyCode>
    <HardwareAmount>Decimal</HardwareAmount>
    <PrinterAmount>Decimal</PrinterAmount>
    <ServiceAndOtherAmount>Decimal</ServiceAndOtherAmount>
    <SoftwareAmount>Decimal</SoftwareAmount>
    <LeaseTerm>String content</LeaseTerm>
    <LeaseType>String content</LeaseType>
    <PaymentFrequency>String content</PaymentFrequency>
    <FlMargin>Decimal</FlMargin>
    <FmvMargin>Decimal</FmvMargin>
    <LnMargin>Decimal</LnMargin>
  </PricingRequst>
  <SourceEntryPerson>
    <FirstName>String content</FirstName>
    <LastName>String content</LastName>
    <UserEmail>String content</UserEmail>
  </SourceEntryPerson>
</QuickQuoteInput>

This API returns XML or JSON response that is described by the model below.

Response Properties
This table describes each of the properties that will be returned.
Name Type Description
LeasePaymentOptions
 Object LeasePaymentOptions response

Name Type Description
Amount Decimal Repayment amount.
AmountIncUplift Decimal Repayment amount including uplift value.
LeaseTerm
 Integer Lease Term options

LeaseTerm Lease Term Description
12 12 Months
24 24 Months
36 36 Months
48 48 Months
60 60 Months
All All Lease Term
LeaseType
 String Lease Type options

LeaseType Lease Description
FL Finance Lease
FMV Fair Market Value
SUB Subscription
LN Loan
ALL All Lease Types
PaymentFrequency
 String Payment Frequency options

PaymentFrequency Payment Frequency Description
MON Monthly
QUA Quarterly
ALL All Payment Frequencies
PricingHeaderDetails
 Object PricingHeaderDetails response header

Name Type Description
TransmissionId String Unique transaction id supplied by the calling service client
Validation
 Object Validation response

Name Type Description
ValidationId String Validation id
ValidationText String message
JSON response Model Schema
This is a JSON schema that describes the syntax of the response . 

{
	"LeasePaymentOptions":[{
		"Amount":Decimal,
		"AmountIncUplift":Decimal,
		"LeaseTerm":"String content",
		"LeaseType":"String content",
		"PaymentFrequency":"String content"
	}],
	"PricingHeaderDetails":{
		"TransmissionId":"String content"
	},
	"Validation":[{
		"ValidationId":"String content",
		"ValidationText":"String content"
	}]
}
XML response Model Schema
This is a XML schema that describes the syntax of the response. 

<QuickQuoteOutput>
  <LeasePaymentOption>
    <Amount>Decimal</Amount>
    <AmountIncUplift>Decimal</AmountIncUplift>
    <LeaseTerm>String content</LeaseTerm>
    <LeaseType>String content</LeaseType>
    <PaymentFrequency>String content</PaymentFrequency>
  </LeasePaymentOption>
  <PricingHeaderDetails>
    <TransmissionId>String content</TransmissionId>
  </PricingHeaderDetails>
  <Validation>
    <ValidationMessage>
      <ValidationId>String content</ValidationId>
      <ValidationText>String content</ValidationText>
      </ValidationMessage>
      <ValidationMessage>
      <ValidationId>String content</ValidationId>
      <ValidationText>String content</ValidationText>
    </ValidationMessage>
  </Validation>
</QuickQuoteOutput>