API Documentation
\
billythekid
v12finance
models
exceptions
requests
responses

\billythekid\v12finance\modelsFinanceProduct

Class FinanceProduct

Summary

Methods
Properties
Constants
setApr()
setCalculationFactor()
setDeferredPeriod()
setDescription()
setDocumentFee()
setDocumentFeeCollectionMonth()
setDocumentFeeMaximum()
setDocumentFeeMinimum()
setMaxLoan()
setMinLoan()
setMonthlyRate()
setMonths()
setName()
setOptionPeriod()
setProductGuid()
setProductId()
setServiceFee()
setTag()
getApr()
getCalculationFactor()
getDeferredPeriod()
getDescription()
getDocumentFee()
getDocumentFeeCollectionMonth()
getDocumentFeeMaximum()
getDocumentFeeMinimum()
getMaxLoan()
getMinLoan()
getMonthlyRate()
getMonths()
getName()
getOptionPeriod()
getProductGuid()
getProductId()
getServiceFee()
getTag()
jsonSerialize()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$apr
$calculationFactor
$deferredPeriod
$description
$documentFee
$documentFeeCollectionMonth
$documentFeeMaximum
$documentFeeMinimum
$maxLoan
$minLoan
$monthlyRate
$months
$name
$optionPeriod
$productGuid
$productId
$serviceFee
$tag
N/A

Properties

$apr

$apr : float

APR rate

Type

float

$calculationFactor

$calculationFactor : float

Calculation factor

Type

float

$deferredPeriod

$deferredPeriod : integer

Deferred period (months)

Type

integer

$description

$description : string

Product description

Type

string

$documentFee

$documentFee : float

Document fee

Type

float

$documentFeeCollectionMonth

$documentFeeCollectionMonth : integer

Document fee collection month

Type

integer

$documentFeeMaximum

$documentFeeMaximum : float

Maximum document fee

Type

float

$documentFeeMinimum

$documentFeeMinimum : float

Minimum document fee

Type

float

$maxLoan

$maxLoan : float

Maximum loan amount that this product is valid for

Type

float

$minLoan

$minLoan : float

Minimum loan amount that this product is valid for

Type

float

$monthlyRate

$monthlyRate : float

Monthly rate

Type

float

$months

$months : integer

Months

Type

integer

$name

$name : string

Product name

Type

string

$optionPeriod

$optionPeriod : integer

Option period

Type

integer

$productGuid

$productGuid : string

Product GUID

Type

string

$productId

$productId : float

Product ID

Type

float

$serviceFee

$serviceFee : float

Service fee

Type

float

$tag

$tag : string

Tag

Type

string

Methods

setCalculationFactor()

setCalculationFactor(float  $calculationFactor) : \billythekid\v12finance\models\FinanceProduct

Set the calculation factor

Parameters

float $calculationFactor

Returns

\billythekid\v12finance\models\FinanceProduct

setDeferredPeriod()

setDeferredPeriod(integer  $deferredPeriod) : \billythekid\v12finance\models\FinanceProduct

Set the deferred period

Parameters

integer $deferredPeriod

Returns

\billythekid\v12finance\models\FinanceProduct

setDocumentFeeCollectionMonth()

setDocumentFeeCollectionMonth(integer  $documentFeeCollectionMonth) : \billythekid\v12finance\models\FinanceProduct

Set the document fee collection month

Parameters

integer $documentFeeCollectionMonth

Returns

\billythekid\v12finance\models\FinanceProduct

setDocumentFeeMaximum()

setDocumentFeeMaximum(float  $documentFeeMaximum) : \billythekid\v12finance\models\FinanceProduct

Set the maximum document fee

Parameters

float $documentFeeMaximum

Returns

\billythekid\v12finance\models\FinanceProduct

setDocumentFeeMinimum()

setDocumentFeeMinimum(float  $documentFeeMinimum) : \billythekid\v12finance\models\FinanceProduct

Set the minimum document fee

Parameters

float $documentFeeMinimum

Returns

\billythekid\v12finance\models\FinanceProduct

getApr()

getApr() : float

Get the APR

Returns

float

getCalculationFactor()

getCalculationFactor() : float

Get the calculation factor

Returns

float

getDeferredPeriod()

getDeferredPeriod() : integer

Get the deferred period

Returns

integer

getDescription()

getDescription() : string

Get the description

Returns

string

getDocumentFee()

getDocumentFee() : float

Get the document fee

Returns

float

getDocumentFeeCollectionMonth()

getDocumentFeeCollectionMonth() : integer

Get the document fee collection month

Returns

integer

getDocumentFeeMaximum()

getDocumentFeeMaximum() : integer

Get the maximum document fee

Returns

integer

getDocumentFeeMinimum()

getDocumentFeeMinimum() : integer

Get the minimum document fee

Returns

integer

getMaxLoan()

getMaxLoan() : float

Get the maximum loan amount

Returns

float

getMinLoan()

getMinLoan() : float

Get the minimum loan amount

Returns

float

getMonthlyRate()

getMonthlyRate() : float

Get the monthly rate

Returns

float

getMonths()

getMonths() : integer

Get the months

Returns

integer

getName()

getName() : string

Get the name

Returns

string

getOptionPeriod()

getOptionPeriod() : integer

Get the option period

Returns

integer

getProductGuid()

getProductGuid() : string

Get the GUID

Returns

string

getProductId()

getProductId() : integer

Get the ID

Returns

integer

getServiceFee()

getServiceFee() : integer

Get the service fee

Returns

integer

getTag()

getTag() : string

Get the tag

Returns

string

jsonSerialize()

jsonSerialize() : mixed

Specify data which should be serialized to JSON

Returns

mixed —

data which can be serialized by json_encode, which is a value of any type other than a resource.