APModuleCompany

Company module

Access all of the API endpoints under the 'company' 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

Methods

Constructor

__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.

Arguments

$pxAPIOb

postBorrower - POST company/borrower

postBorrower(array $data) : mixed

Create a new user and assign it to the current company. If the user already exists (if the email and/or SSN already exists) it will not be created. The user is not associated to any loan.

Arguments

$data

array

Borrower data

Response

mixed

putBorrower - PUT company/borrower

putBorrower(array $data) : mixed

Edit a borrower's information

Arguments

$data

array

Borrower data

Response

mixed

deleteBorrower - DELETE company/borrower

deleteBorrower(string $borrowerId) : mixed

Delete a borrower from the current company

Arguments

$borrowerId

string

ID of the borrower to delete

Response

mixed

putBorrowerSettings - PUT company/user/settings

putBorrowerSettings(array $data) : mixed

Update user settings for the specified loan. These are loan access and enrollment options that can be controlled at the loan and user level.

Arguments

$data

array

New user settings

Response

mixed

postUser - POST company/user

postUser(array $data) : mixed

Create a new user and assign it to the current company. If the user already exists (if the email and/or SSN already exists) it will not be created. The user will be associated to the specified loan.

Arguments

$data

array

User data

Response

mixed

getCompanyDetails - GET company/companydetails

getCompanyDetails(string $expand) : mixed

Get company details. The expand property is used to get a particular company section.

Arguments

$expand

string

The company section to retrieve

Response

mixed

getPaymentMethods - GET company/paymentmethods

getPaymentMethods() : mixed

Get the payment methods available to the current company, including custom payment methods.

Response

mixed

getFlooringCustomers - GET company/flooringcustomers

getFlooringCustomers() : mixed

Get the available flooring customers for the current company.

Response

mixed

getChecklist - GET company/checklist

getChecklist() : mixed

Get the current company checklist items.

Response

mixed

getRollScheduleTemplates - GET company/calc/rollschedule/templates

getRollScheduleTemplates() : mixed

Get the roll schedule templates available for the current company.

Response

mixed

postRollScheduleTemplate - POST company/calc/rollschedule/templates

postRollScheduleTemplate(array $data) : mixed

Create a new roll schedule template in the current company.

Arguments

$data

array

Roll schedule template data

Response

mixed

putRollScheduleTemplate - PUT company/calc/rollschedule/templates

putRollScheduleTemplate(array $data) : mixed

Edit an existing roll schedule template. Only the title may be edited. To add a new template {@link postRollScheduleTemplateLine()}

Arguments

$data

array

Roll schedule template data

Response

mixed

deleteRollScheduleTemplate - DELETE company/calc/rollschedule/templates

deleteRollScheduleTemplate(string $templateId) : mixed

Delete an existing roll schedule template.

Arguments

$templateId

string

The template to delete

Response

mixed

postRollScheduleTemplateLine - POST company/calc/rollschedule/templates/line

postRollScheduleTemplateLine(array $data) : mixed

Add a new template line to an existing roll schedule template.

Arguments

$data

array

Template line data

Response

mixed

putRollScheduleTemplateLine - PUT company/calc/rollschedule/templates/line

putRollScheduleTemplateLine(array $data) : mixed

Edit an existing template line.

Arguments

$data

array

Template line data

Response

mixed

deleteRollScheduleTemplateLine - DELETE company/calc/rollschedule/templates/line

deleteRollScheduleTemplateLine(string $templateId, string $templateLineId) : mixed

Delete an existing template line from a roll schedule template.

Arguments

$templateId

string

ID of the template containing the line to delete

$templateLineId

string

ID of the line to delete

Response

mixed

Properties

api

api