Calc module
Access all of the API endpoints under the 'calc' path. Each module is loaded via {@link \APAPI\APLoader} and passed a reference to a {@link \APAPI\APAPI} instance to use. In practice, usage of SDK modules is as simple as:
$api->calc->initialize();
| see |
|---|
__construct($pxAPIOb)
When a module is requested via the API base class, it is automatically passed a reference to a {@link \APAPI\APAPI} instance to use.
initialize(array $pxOptions = array()) : mixed
Setup the calculator and calculate the payment amount & APR
arrayAll calculator setup options
mixedAP calculator session ID
update(string $pxSessionId, array $pxOptions = array()) : mixed
Update the calc setup for an existing session. It will also recalc payment & APR and return results
stringThe session ID to use. {@see initialize()}
arrayCalculator setup options
mixed
transactions(string $pxSessionId) : mixed
Return amortization schedule & loan transactions
stringThe session ID to use. {@see initialize()}
mixed
paymentSummary(string $pxSessionId) : mixed
Returns an array of the calculated payment summary
stringThe session ID to use. {@see initialize()}
mixed
getPayoff(string $pxSessionId, string $date = "") : mixed
Get the calculated payoff within a specified date.
stringThe calculator session to use
stringThe start date (defaults to first day of current month)
mixed
getRollPayment($pxSessionId, $amount)
getRollPaymentFixedTerm($pxSessionId)
api