3. How to Use BOSS Extension (Including Stage and Data Mapping)
Introduction
This article describes how to use the BOSS Extension in your BluMortgage CRM. This includes receiving data from BOSS, sending leads to BOSS, stage mapping and the data mapping.
Automatic Deal Pulling from BOSS
The integration will automatically pull data from BOSS only when certain triggers are met in the BOSS system. The list of triggers is as follows:
1. Deal Created
2. Deal Stage/Status Updated
When one of these triggers occur , the system will automatically update (or create) the file.
For example, if my BOSS deal just was submitted by the borrower, trigger 1 would be met, and data would be sent from my BOSS account to BluMortgage automatically.
How to Manually "Pull Deals" from BOSS
The "Pull from BOSS" button can be used to bring a mortgage record from BOSS into the CRM without waiting for one of the BOSS Events to occur. Below, we have provided the steps on how to pull deals from BOSS on demand:
- Open your BluMortgage CRM
- In your "Mortgages" module, click on "Pull from BOSS" button
- Fill in the BOSS Application Number, or hit the "Plus" button to add multiple deals
- Click in "Submit"
After the integration is complete, you will get a status report. The status report will tell you the success of the integration, and if any actions are needed to properly integrate the data.
Video
How to "Create BOSS Deal" from BluMortgage CRM
The "Create BOSS Deal" button can be used to create a new BOSS application in BOSS by using the leads information located in your BluMortgage CRM. Below, we have provided the steps on how to create deals in BOSS from BluMortgage on demand:
- Open your BluMortgage CRM > Click on the "Borrowers" Module > Open a Borrower record
- Click on the "Create BOSS Deal"
- Select the type of the application from the drop down menu > "Submit"
The borrower record will require the following fields to create a deal in BOSS: Borrower's First Name, Last Name, Mobile, and Email.
Deal Stages
By default, the mortgage stage in the CRM updates according to the data in BOSS. The default stage mapping and how to change it is shown below.You can update the data on a deal without updating the stage only when using the button in the Mortgage Detail View, and keeping the Update Mortgage Stage toggle disabled
Default Stage Mapping
The default stage mapping for the BOSS integration is as follows:
Cancelled/Declined/Rejected
Mortgage Lost
Cancelled/Declined/Rejected | Mortgage Lost |
How to Update Deal Stage Mapping
If you want to update this stage mapping based on your process, or if you have introduced custom stages in BluMortgage, you can do so by following the instructions in this video:
If you want to update this stage mapping based on your process, or if you have introduced custom stages in BluMortgage, you can do so by following the instructions in this video:
Data Mapping
When a mortgage is pulled from BOSS into your BluMortgage CRM, a mortgage record will be created with the associated borrower records. The following table outlines how specific field in BOSS is mapped to a corresponding Module and Field in your BluMortgage CRM.
The following table outlines how each field in BOSS is mapped to a corresponding Module and Field in your BluMortgage CRM.
| BM Module API Name | BM Field API Name | BOSS Field |
| Mortgage | Amortization | .mortgageRequests[].amortizationTerm |
| Mortgage | Amount | .mortgageInfo.downPaymentTotal |
| Mortgage | Amount | .mortgageInfo.firstMortgageAmount |
| Mortgage | Amount | .mortgageRequests[].netLoanAmount |
| Mortgage | Application Type | .mortgageInfo.dealTypeId |
| Mortgage | City | .subjectProperty.subjectPropertyAddress.city |
| Mortgage | Closing Date | .mortgageInfo.estimatedClosingDate |
| Mortgage | COF Date | .mortgageInfo.financingWaiverDate |
| Mortgage | Condo/Freehold | .subjectProperty.propertyTypeId |
| Mortgage | Condo_Fees/Annual_Taxes | .subjectProperty.subjectPropertyExpenses[].propertyExpenseAmount |
| Mortgage | Construction Type | .subjectProperty.newConstructionId |
| Mortgage | Filogix ID | .expertApplicationId |
| Mortgage | First Payment Date | .mortgageRequests[].firstPaymentDate |
| Mortgage | ID / Name | .bossDealId |
| Mortgage | Maturity Date | .mortgageRequests[].maturityDate |
| Mortgage | Mortgage Type | .mortgageRequests[].mortgageTypeId |
| Mortgage | Occupancy | .subjectProperty.occupancyTypeId |
| Mortgage | Payment Amount | .mortgageRequests[].frequencyPaymentAmount |
| Mortgage | Payment Frequency | .mortgageRequests[].paymentFrequencyId |
| Mortgage | Postal Code | .subjectProperty.subjectPropertyAddress.postalCode |
| Mortgage | Province | .subjectProperty.subjectPropertyAddress.provinceId |
| Mortgage | Purchase Price/Value | .subjectProperty.actualAppraisalValue |
| Mortgage | Purchase Price/Value | .subjectProperty.purchasePrice |
| Mortgage | Rate | .mortgageRequests[].rate.netRate |
| Mortgage | Rate Type | .mortgageRequests[].interestTypeId |
| Mortgage | Stage | .bossDealStatus |
| Mortgage | Street | .subjectProperty.subjectPropertyAddress.addressLine1 |
| Mortgage | Total Loan Amount | .mortgageRequests[].totalLoanAmount |
| Mortgage | Transaction Type | .applicationPurpose |
| Mortgage | Transaction Type | .mortgageInfo.dealPurposeId |
| Mortgage | Unit | .subjectProperty.subjectPropertyAddress.unitNumber |
| Mortgage | Variable Mortgage Rate | .mortgageRequests[].rate.discount |
| Lenders | Lender Name | .lenderName |
| Borrower | Mailing City | .applicantGroups[].applicants[].applicantAddresses[].city |
| Borrower | Mailing Country | .applicantGroups[].applicants[].applicantAddresses[].countryTypeId |
| Borrower | Mailing Postal Code | .applicantGroups[].applicants[].applicantAddresses[].postalCode |
| Borrower | Mailing Province | .applicantGroups[].applicants[].applicantAddresses[].provinceId |
| Borrower | Mailing Street | .applicantGroups[].applicants[].applicantAddresses[].addressLine1 |
| Borrower | Mobile/Phone | .applicantGroups[].applicants[].applicantPhones[].phoneNumber |
| Borrower | Date of Birth | .applicantGroups[].applicants[].birthDate |
| Borrower | Boss Contact ID | .applicantGroups[].applicants[].contactId |
| Borrower | .applicantGroups[].applicants[].emailAddress | |
| Borrower | Income | .applicantGroups[].applicants[].employments[].incomeEmployment.incomeAmount |
| Borrower | Income Type | .applicantGroups[].applicants[].employments[].incomeEmployment.incomeEmploymentTypeId |
| Borrower | Income Frequency | .applicantGroups[].applicants[].employments[].incomeEmployment.incomePeriodId |
| Borrower | Industry Sector | .applicantGroups[].applicants[].employments[].industrySectorid |
| Borrower | Occupation | .applicantGroups[].applicants[].employments[].jobTitle |
| Borrower | FTHB? | .applicantGroups[].applicants[].isFirstTimeBuyer |
| Borrower | First Name | .applicantGroups[].applicants[].name.firstName |
| Borrower | Last Name | .applicantGroups[].applicants[].name.lastName |
| Additional Properties | City | .applicantGroups[].applicants[].otherProperties[].address.city |
| Additional Properties | Postal Code | .applicantGroups[].applicants[].otherProperties[].address.postalCode |
| Additional Properties | Province | .applicantGroups[].applicants[].otherProperties[].address.provinceId |
| Additional Properties | Street | .applicantGroups[].applicants[].otherProperties[].address.addressLine1 |
| Additional Properties | Unit | .applicantGroups[].applicants[].otherProperties[].address.unitNumber |
| Additional Properties | Amount | .applicantGroups[].applicants[].otherProperties[].existingMortgages[].balanceRemaining |
| Additional Properties | Rate | .applicantGroups[].applicants[].otherProperties[].existingMortgages[].interestRate |
| Additional Properties | Rate Type | .applicantGroups[].applicants[].otherProperties[].existingMortgages[].interestTypeId |
| Additional Properties | Maturity Date | .applicantGroups[].applicants[].otherProperties[].existingMortgages[].maturityDate |
| Additional Properties | Mortgage Type | .applicantGroups[].applicants[].otherProperties[].existingMortgages[].mortgageTypeId |
| Additional Properties | Payment Amount | .applicantGroups[].applicants[].otherProperties[].existingMortgages[].pAndIPaymentAmount |
| Additional Properties | Payment Frequency | .applicantGroups[].applicants[].otherProperties[].existingMortgages[].paymentFrequencyId |
| Additional Properties | Occupancy | .applicantGroups[].applicants[].otherProperties[].occupancyTypeId |
| Additional Properties | Purchase Price/Value | .applicantGroups[].applicants[].otherProperties[].originalPurchasePrice |
| Additional Properties | Condo Fees / Taxes | .applicantGroups[].applicants[].otherProperties[].propertyExpenses |