Reports module
Access all of the API endpoints under the 'reports' 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->reports->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.
getForecastRevenueCashFlow(string $expand = "{}") : mixed
Enter any future date range and see the forecast of cashflow. This chart pulls from the live amortization schedules viewable on the transactions tab inside each loan account.
stringSearch options (JSON formatted)
mixed
getForecastDueDateCalendar(string $expand = "{}", int $limit = 50, int $offset, string $sort = "date", int $reverse) : mixed
Provides a line item breakdown of forecast payments taken from the amortization schedules on individual accounts.
stringThe search parameters (JSON formatted)
intHow many results per page to get
intOffset from where to start the results
stringSort column
intWhether to sort ascending or descending
mixed
getHistoryPayments(string $expand = "{}", int $limit = 50, int $offset, string $sort = "date", int $reverse) : mixed
Shows the actual history of payments that have been logged on within the current company. Including the amortization breakdown of each payment. Additional search parameters may be used via the expand property to narrow the search results.
stringThe search parameters (JSON formatted)
intHow many results per page to get
intOffset from where to start the results
stringSort column
intWhether to sort ascending or descending
mixed
getHistoryCharges(string $expand = "{}", int $limit = 50, int $offset, string $sort = "date", int $reverse) : mixed
Show all charges that meet the search criteria. This does not show the paid charges, but the actual charges that are logged.
stringThe search parameters (JSON formatted)
intHow many results per page to get
intOffset from where to start the results
stringSort column
intWhether to sort ascending or descending
mixed
getHistoryHistory(string $expand = "{}") : mixed
This report provides the actual history of payments for the search results.
stringThe search parameters (JSON formatted)
mixed
getHistoryFunding(string $expand = "{}", int $limit = 50, int $offset, string $sort = "created", int $reverse) : mixed
Retrieve all loans with contract dates that fall within the specified date range. AutoPal does not track whether the user has given money to the borrower or dealership for the loan. This report simply looks at contract dates.
stringThe search parameters (JSON formatted)
intHow many results per page to get
intOffset from where to start the results
stringSort column
intWhether to sort ascending or descending
mixed
getHistoryDueDateChanges(string $expand = "{}", int $limit = 50, int $offset, string $sort = "created", int $reverse) : mixed
Search due date changes on all loans throughout the current company.
stringThe search parameters (JSON formatted)
intHow many results per page to get
intOffset from where to start the results
stringSort column
intWhether to sort ascending or descending
mixed
getServicingInsurance(string $expand = "{}", int $limit = 50, int $offset, string $sort = "created", int $reverse) : mixed
Search for expiring insurance on accounts. Typically on collateralized loans the lender tracks the insurance. This report allows for you to search for the expiration of that insurance. If you select Expired/No Insurance it will result all of the account that also do not have any insurance information entered.
stringThe search parameters (JSON formatted)
intHow many results per page to get
intOffset from where to start the results
stringSort column
intWhether to sort ascending or descending
mixed
getServicingPromises(string $expand = "{}", int $limit = 50, int $offset, string $sort = "created", int $reverse) : mixed
Searches the status of promises across the current company. Results can be narrowed as desired. In addition it can be searched by the date the promise was created, or by its due date.
stringThe search parameters (JSON formatted)
intHow many results per page to get
intOffset from where to start the results
stringSort column
intWhether to sort ascending or descending
mixed
getServicingNotes(string $expand = "{}", int $limit = 50, int $offset, string $sort = "created", int $reverse) : mixed
This report searches the notes created in a particular date range.
stringThe search parameters (JSON formatted)
intHow many results per page to get
intOffset from where to start the results
stringSort column
intWhether to sort ascending or descending
mixed
getServicingFlooring(string $expand = "{}", int $limit = 50, int $offset, string $sort = "created", int $reverse) : mixed
This report provides a company wide view of the flooring loans. Similar to a delinquency report, however it will show the specific summary per flooring customer specified in the search.
stringThe search parameters (JSON formatted)
intHow many results per page to get
intOffset from where to start the results
stringSort column
intWhether to sort ascending or descending
mixed
getAdminAdmin(string $expand = "{}") : mixed
Get stats for the current company as a whole.
stringThe search parameters (JSON formatted)
mixed
getAdminAdditionalCharts(string $expand = "{}") : mixed
Additional charts give a quick overview of how the current company is doing.
stringthe search parameters (JSON formatted)
mixed
getAdminGraphing(string $expand = "{}") : mixed
Graphing returns a dataset suitable for visual representation of the state of the loan accounts.
stringThe search parameters (JSON formatted)
mixed
getCustomQueries() : mixed
Get all saved custom queries in the current company.
mixed
getCustomQueue() : mixed
Get a list of queued custom queries. Ready to download reports have an additional 'link' field.
mixed
postCustomQueue(array $data) : mixed
Creates a new custom query and queues it for processing.
arrayCustom query data
mixed
postCustom(array $data) : mixed
Save a custom query. The custom query parameters are saved but not queued.
arrayCustom query data
mixed
deleteCustom(string $queryId) : mixed
Delete a saved custom query.
stringID of the custom query to delete
mixed
deleteQueuedCustomQuery(mixed $queryId) : mixed
Dequeue a queued custom query.
mixed
mixed
api