BOSS Web Service

BOSS

Click here for a complete list of operations.

PushDeal

Create Deal in Boss Based on BOSS XML and returns a newly created BOSS Deal ID and optional fields requested by Lead Workflows

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /BOSS_API.asmx HTTP/1.1
Host: partnersuatapi.mortgageboss.ca
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.mortgageboss.ca/PushDeal"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <PushDeal xmlns="https://api.mortgageboss.ca/">
      <token>guid</token>
      <deal>
        <XmlDealVersion>string</XmlDealVersion>
        <LeadWorkflow>
          <LeadDealId>string</LeadDealId>
          <NetworkId>int</NetworkId>
          <Brand>string</Brand>
          <DealSourceId>int</DealSourceId>
          <CreditBureauConsent>0 or 1</CreditBureauConsent>
          <LeadType>0 or 1 or 2 or 3 or 4 or 5 or 6 or 7 or 8 or 9 or 10 or 11 or 12 or 13 or 14 or 15 or 16 or 17 or 18 or 19 or 20 or 21 or 22 or 23 or 24 or 26 or 27</LeadType>
          <Authentication>0 or 1 or 2 or 3 or 4 or 5 or 6 or 10 or 11 or 13 or 14 or 15 or 16 or 1010 or 1011 or 1013 or 1014 or 1015 or 1016 or 1110 or 1111 or 1113 or 1114 or 1115 or 1116 or 1310 or 1311 or 1313 or 1314 or 1315 or 1316 or 1410 or 1411 or 1413 or 1414 or 1415 or 1416 or 1510 or 1511 or 1513 or 1514 or 1515 or 1516 or 1610 or 1611 or 1613 or 1614 or 1615 or 1616</Authentication>
          <casl>boolean</casl>
          <LeadReferralSource>int</LeadReferralSource>
        </LeadWorkflow>
        <Broker>
          <BrokerId>int</BrokerId>
        </Broker>
        <DealInfo>
          <DealPurposeId>0 or 1 or 2 or 3 or 4 or 5 or 6 or 7</DealPurposeId>
          <DealTypeId>0 or 1 or 2</DealTypeId>
          <RefiPurpose>string</RefiPurpose>
          <IsCommercial>boolean</IsCommercial>
          <RefiImprovementsFlag>boolean</RefiImprovementsFlag>
          <RefiImprovementAmount>decimal</RefiImprovementAmount>
          <RefiImprovementDesc>string</RefiImprovementDesc>
          <EstimatedClosingDate>dateTime</EstimatedClosingDate>
          <DownPayments>
            <DownPayment xsi:nil="true" />
            <DownPayment xsi:nil="true" />
          </DownPayments>
          <Description>string</Description>
          <PurchaseDate>dateTime</PurchaseDate>
          <PurchaseDateCategory>string</PurchaseDateCategory>
        </DealInfo>
        <MortgageRequests>
          <MortgageRequest>
            <MortgageTypeId>1 or 2 or 3</MortgageTypeId>
            <NetLoanAmount>decimal</NetLoanAmount>
            <TotalLoanAmount>decimal</TotalLoanAmount>
            <LoanTypeId>0 or 1</LoanTypeId>
            <MaturityDate>dateTime</MaturityDate>
            <SingleProgressiveTypeFlag>boolean</SingleProgressiveTypeFlag>
            <Rate xsi:nil="true" />
            <InterestTypeId>0 or 1 or 2 or 3 or 4</InterestTypeId>
            <PaymentTermId>0 or 1 or 2</PaymentTermId>
            <PaymentFrequencyId>0 or 1 or 2 or 3 or 4 or 5</PaymentFrequencyId>
            <InterestCompoundId>-1 or 0 or 1</InterestCompoundId>
            <ActualPaymentTerm>int</ActualPaymentTerm>
            <AmortizationTerm>int</AmortizationTerm>
            <InterestOnlyFlag>boolean</InterestOnlyFlag>
            <RefiBlendedAmortization>boolean</RefiBlendedAmortization>
            <Insurer>0 or 1 or 2</Insurer>
            <MtgInsIncludeFlag>boolean</MtgInsIncludeFlag>
            <InsPrimeRateOverrideFlag>boolean</InsPrimeRateOverrideFlag>
            <InsPrimeRate>decimal</InsPrimeRate>
            <InsMortgagePremium>decimal</InsMortgagePremium>
            <LocRepaymentTypeId>1 or 2</LocRepaymentTypeId>
            <CashBackOverride>boolean</CashBackOverride>
            <CashBackPercentage>decimal</CashBackPercentage>
            <CashBackAmt>decimal</CashBackAmt>
            <FirstPaymentDate>dateTime</FirstPaymentDate>
          </MortgageRequest>
          <MortgageRequest>
            <MortgageTypeId>1 or 2 or 3</MortgageTypeId>
            <NetLoanAmount>decimal</NetLoanAmount>
            <TotalLoanAmount>decimal</TotalLoanAmount>
            <LoanTypeId>0 or 1</LoanTypeId>
            <MaturityDate>dateTime</MaturityDate>
            <SingleProgressiveTypeFlag>boolean</SingleProgressiveTypeFlag>
            <Rate xsi:nil="true" />
            <InterestTypeId>0 or 1 or 2 or 3 or 4</InterestTypeId>
            <PaymentTermId>0 or 1 or 2</PaymentTermId>
            <PaymentFrequencyId>0 or 1 or 2 or 3 or 4 or 5</PaymentFrequencyId>
            <InterestCompoundId>-1 or 0 or 1</InterestCompoundId>
            <ActualPaymentTerm>int</ActualPaymentTerm>
            <AmortizationTerm>int</AmortizationTerm>
            <InterestOnlyFlag>boolean</InterestOnlyFlag>
            <RefiBlendedAmortization>boolean</RefiBlendedAmortization>
            <Insurer>0 or 1 or 2</Insurer>
            <MtgInsIncludeFlag>boolean</MtgInsIncludeFlag>
            <InsPrimeRateOverrideFlag>boolean</InsPrimeRateOverrideFlag>
            <InsPrimeRate>decimal</InsPrimeRate>
            <InsMortgagePremium>decimal</InsMortgagePremium>
            <LocRepaymentTypeId>1 or 2</LocRepaymentTypeId>
            <CashBackOverride>boolean</CashBackOverride>
            <CashBackPercentage>decimal</CashBackPercentage>
            <CashBackAmt>decimal</CashBackAmt>
            <FirstPaymentDate>dateTime</FirstPaymentDate>
          </MortgageRequest>
        </MortgageRequests>
        <SubjectProperty>
          <SubjectPropertyAddress>
            <OccupancyTypeId>0 or 1 or 2 or 3</OccupancyTypeId>
            <MlsListingFlag>boolean</MlsListingFlag>
          </SubjectPropertyAddress>
          <NewConstructionId>0 or 2</NewConstructionId>
          <DwellingStyleId>0 or 1 or 2 or 3 or 4 or 5 or 6</DwellingStyleId>
          <NumberOfUnits>int</NumberOfUnits>
          <GarageSizeId>1 or 2 or 3 or 4</GarageSizeId>
          <PropertyTypeId>0 or 1 or 2</PropertyTypeId>
          <WaterTypeId>0 or 1</WaterTypeId>
          <LivingSpace>int</LivingSpace>
          <LivingSpaceUnitOfMeasureId>0 or 1 or 2 or 3</LivingSpaceUnitOfMeasureId>
          <DwellingTypeId>0 or 1 or 2 or 3 or 4 or 5 or 6 or 7 or 8 or 9 or 10 or 11 or 12 or 13 or 14</DwellingTypeId>
          <StructureAge>int</StructureAge>
          <GarageTypeId>1 or 2</GarageTypeId>
          <SewageTypeId>0 or 1 or 2</SewageTypeId>
          <HeatTypeId>1 or 2 or 3 or 4</HeatTypeId>
          <LotSize>int</LotSize>
          <LotSizeUnitOfMeasureId>0 or 1 or 2 or 3</LotSizeUnitOfMeasureId>
          <IsFeesIncludeHeat>boolean</IsFeesIncludeHeat>
          <IsInsulatedWithUffi>boolean</IsInsulatedWithUffi>
          <LegalLine1>string</LegalLine1>
          <LegalLine2>string</LegalLine2>
          <LegalLine3>string</LegalLine3>
          <TaxationYear>int</TaxationYear>
          <TayPayorId>0 or 1</TayPayorId>
          <SubjectPropertyExpenses>
            <PropertyExpense xsi:nil="true" />
            <PropertyExpense xsi:nil="true" />
          </SubjectPropertyExpenses>
          <SubjectPropertyRentalIncome>
            <IncomeAmount>double</IncomeAmount>
            <IncomePeriodId>0 or 1 or 2 or 3 or 4 or 5 or 6</IncomePeriodId>
            <RentalIncomeOption>0 or 1 or 2</RentalIncomeOption>
            <IncludeOffset>double</IncludeOffset>
          </SubjectPropertyRentalIncome>
          <PurchasePrice>decimal</PurchasePrice>
          <EstimatedAppraisalValue>decimal</EstimatedAppraisalValue>
          <ActualAppraisalValue>decimal</ActualAppraisalValue>
          <AppraisalDateAct>dateTime</AppraisalDateAct>
        </SubjectProperty>
        <ApplicantGroups>
          <ApplicantGroup>
            <ApplicantGroupTypeId>0</ApplicantGroupTypeId>
            <Applicants xsi:nil="true" />
          </ApplicantGroup>
          <ApplicantGroup>
            <ApplicantGroupTypeId>0</ApplicantGroupTypeId>
            <Applicants xsi:nil="true" />
          </ApplicantGroup>
        </ApplicantGroups>
      </deal>
    </PushDeal>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <PushDealResponse xmlns="https://api.mortgageboss.ca/">
      <PushDealResult>
        <LeadApiId>guid</LeadApiId>
        <Qualification>
          <CreditScore>string</CreditScore>
          <MaxAmount>decimal</MaxAmount>
          <InsuranceAmount>decimal</InsuranceAmount>
          <TotalDebt>decimal</TotalDebt>
          <Conditions>string</Conditions>
          <ConditionText>string</ConditionText>
          <ClientType>int</ClientType>
          <ApplicantResult>int</ApplicantResult>
        </Qualification>
        <NetworkId>int</NetworkId>
        <Brand>string</Brand>
      </PushDealResult>
    </PushDealResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /BOSS_API.asmx HTTP/1.1
Host: partnersuatapi.mortgageboss.ca
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <PushDeal xmlns="https://api.mortgageboss.ca/">
      <token>guid</token>
      <deal>
        <XmlDealVersion>string</XmlDealVersion>
        <LeadWorkflow>
          <LeadDealId>string</LeadDealId>
          <NetworkId>int</NetworkId>
          <Brand>string</Brand>
          <DealSourceId>int</DealSourceId>
          <CreditBureauConsent>0 or 1</CreditBureauConsent>
          <LeadType>0 or 1 or 2 or 3 or 4 or 5 or 6 or 7 or 8 or 9 or 10 or 11 or 12 or 13 or 14 or 15 or 16 or 17 or 18 or 19 or 20 or 21 or 22 or 23 or 24 or 26 or 27</LeadType>
          <Authentication>0 or 1 or 2 or 3 or 4 or 5 or 6 or 10 or 11 or 13 or 14 or 15 or 16 or 1010 or 1011 or 1013 or 1014 or 1015 or 1016 or 1110 or 1111 or 1113 or 1114 or 1115 or 1116 or 1310 or 1311 or 1313 or 1314 or 1315 or 1316 or 1410 or 1411 or 1413 or 1414 or 1415 or 1416 or 1510 or 1511 or 1513 or 1514 or 1515 or 1516 or 1610 or 1611 or 1613 or 1614 or 1615 or 1616</Authentication>
          <casl>boolean</casl>
          <LeadReferralSource>int</LeadReferralSource>
        </LeadWorkflow>
        <Broker>
          <BrokerId>int</BrokerId>
        </Broker>
        <DealInfo>
          <DealPurposeId>0 or 1 or 2 or 3 or 4 or 5 or 6 or 7</DealPurposeId>
          <DealTypeId>0 or 1 or 2</DealTypeId>
          <RefiPurpose>string</RefiPurpose>
          <IsCommercial>boolean</IsCommercial>
          <RefiImprovementsFlag>boolean</RefiImprovementsFlag>
          <RefiImprovementAmount>decimal</RefiImprovementAmount>
          <RefiImprovementDesc>string</RefiImprovementDesc>
          <EstimatedClosingDate>dateTime</EstimatedClosingDate>
          <DownPayments>
            <DownPayment xsi:nil="true" />
            <DownPayment xsi:nil="true" />
          </DownPayments>
          <Description>string</Description>
          <PurchaseDate>dateTime</PurchaseDate>
          <PurchaseDateCategory>string</PurchaseDateCategory>
        </DealInfo>
        <MortgageRequests>
          <MortgageRequest>
            <MortgageTypeId>1 or 2 or 3</MortgageTypeId>
            <NetLoanAmount>decimal</NetLoanAmount>
            <TotalLoanAmount>decimal</TotalLoanAmount>
            <LoanTypeId>0 or 1</LoanTypeId>
            <MaturityDate>dateTime</MaturityDate>
            <SingleProgressiveTypeFlag>boolean</SingleProgressiveTypeFlag>
            <Rate xsi:nil="true" />
            <InterestTypeId>0 or 1 or 2 or 3 or 4</InterestTypeId>
            <PaymentTermId>0 or 1 or 2</PaymentTermId>
            <PaymentFrequencyId>0 or 1 or 2 or 3 or 4 or 5</PaymentFrequencyId>
            <InterestCompoundId>-1 or 0 or 1</InterestCompoundId>
            <ActualPaymentTerm>int</ActualPaymentTerm>
            <AmortizationTerm>int</AmortizationTerm>
            <InterestOnlyFlag>boolean</InterestOnlyFlag>
            <RefiBlendedAmortization>boolean</RefiBlendedAmortization>
            <Insurer>0 or 1 or 2</Insurer>
            <MtgInsIncludeFlag>boolean</MtgInsIncludeFlag>
            <InsPrimeRateOverrideFlag>boolean</InsPrimeRateOverrideFlag>
            <InsPrimeRate>decimal</InsPrimeRate>
            <InsMortgagePremium>decimal</InsMortgagePremium>
            <LocRepaymentTypeId>1 or 2</LocRepaymentTypeId>
            <CashBackOverride>boolean</CashBackOverride>
            <CashBackPercentage>decimal</CashBackPercentage>
            <CashBackAmt>decimal</CashBackAmt>
            <FirstPaymentDate>dateTime</FirstPaymentDate>
          </MortgageRequest>
          <MortgageRequest>
            <MortgageTypeId>1 or 2 or 3</MortgageTypeId>
            <NetLoanAmount>decimal</NetLoanAmount>
            <TotalLoanAmount>decimal</TotalLoanAmount>
            <LoanTypeId>0 or 1</LoanTypeId>
            <MaturityDate>dateTime</MaturityDate>
            <SingleProgressiveTypeFlag>boolean</SingleProgressiveTypeFlag>
            <Rate xsi:nil="true" />
            <InterestTypeId>0 or 1 or 2 or 3 or 4</InterestTypeId>
            <PaymentTermId>0 or 1 or 2</PaymentTermId>
            <PaymentFrequencyId>0 or 1 or 2 or 3 or 4 or 5</PaymentFrequencyId>
            <InterestCompoundId>-1 or 0 or 1</InterestCompoundId>
            <ActualPaymentTerm>int</ActualPaymentTerm>
            <AmortizationTerm>int</AmortizationTerm>
            <InterestOnlyFlag>boolean</InterestOnlyFlag>
            <RefiBlendedAmortization>boolean</RefiBlendedAmortization>
            <Insurer>0 or 1 or 2</Insurer>
            <MtgInsIncludeFlag>boolean</MtgInsIncludeFlag>
            <InsPrimeRateOverrideFlag>boolean</InsPrimeRateOverrideFlag>
            <InsPrimeRate>decimal</InsPrimeRate>
            <InsMortgagePremium>decimal</InsMortgagePremium>
            <LocRepaymentTypeId>1 or 2</LocRepaymentTypeId>
            <CashBackOverride>boolean</CashBackOverride>
            <CashBackPercentage>decimal</CashBackPercentage>
            <CashBackAmt>decimal</CashBackAmt>
            <FirstPaymentDate>dateTime</FirstPaymentDate>
          </MortgageRequest>
        </MortgageRequests>
        <SubjectProperty>
          <SubjectPropertyAddress>
            <OccupancyTypeId>0 or 1 or 2 or 3</OccupancyTypeId>
            <MlsListingFlag>boolean</MlsListingFlag>
          </SubjectPropertyAddress>
          <NewConstructionId>0 or 2</NewConstructionId>
          <DwellingStyleId>0 or 1 or 2 or 3 or 4 or 5 or 6</DwellingStyleId>
          <NumberOfUnits>int</NumberOfUnits>
          <GarageSizeId>1 or 2 or 3 or 4</GarageSizeId>
          <PropertyTypeId>0 or 1 or 2</PropertyTypeId>
          <WaterTypeId>0 or 1</WaterTypeId>
          <LivingSpace>int</LivingSpace>
          <LivingSpaceUnitOfMeasureId>0 or 1 or 2 or 3</LivingSpaceUnitOfMeasureId>
          <DwellingTypeId>0 or 1 or 2 or 3 or 4 or 5 or 6 or 7 or 8 or 9 or 10 or 11 or 12 or 13 or 14</DwellingTypeId>
          <StructureAge>int</StructureAge>
          <GarageTypeId>1 or 2</GarageTypeId>
          <SewageTypeId>0 or 1 or 2</SewageTypeId>
          <HeatTypeId>1 or 2 or 3 or 4</HeatTypeId>
          <LotSize>int</LotSize>
          <LotSizeUnitOfMeasureId>0 or 1 or 2 or 3</LotSizeUnitOfMeasureId>
          <IsFeesIncludeHeat>boolean</IsFeesIncludeHeat>
          <IsInsulatedWithUffi>boolean</IsInsulatedWithUffi>
          <LegalLine1>string</LegalLine1>
          <LegalLine2>string</LegalLine2>
          <LegalLine3>string</LegalLine3>
          <TaxationYear>int</TaxationYear>
          <TayPayorId>0 or 1</TayPayorId>
          <SubjectPropertyExpenses>
            <PropertyExpense xsi:nil="true" />
            <PropertyExpense xsi:nil="true" />
          </SubjectPropertyExpenses>
          <SubjectPropertyRentalIncome>
            <IncomeAmount>double</IncomeAmount>
            <IncomePeriodId>0 or 1 or 2 or 3 or 4 or 5 or 6</IncomePeriodId>
            <RentalIncomeOption>0 or 1 or 2</RentalIncomeOption>
            <IncludeOffset>double</IncludeOffset>
          </SubjectPropertyRentalIncome>
          <PurchasePrice>decimal</PurchasePrice>
          <EstimatedAppraisalValue>decimal</EstimatedAppraisalValue>
          <ActualAppraisalValue>decimal</ActualAppraisalValue>
          <AppraisalDateAct>dateTime</AppraisalDateAct>
        </SubjectProperty>
        <ApplicantGroups>
          <ApplicantGroup>
            <ApplicantGroupTypeId>0</ApplicantGroupTypeId>
            <Applicants xsi:nil="true" />
          </ApplicantGroup>
          <ApplicantGroup>
            <ApplicantGroupTypeId>0</ApplicantGroupTypeId>
            <Applicants xsi:nil="true" />
          </ApplicantGroup>
        </ApplicantGroups>
      </deal>
    </PushDeal>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <PushDealResponse xmlns="https://api.mortgageboss.ca/">
      <PushDealResult>
        <LeadApiId>guid</LeadApiId>
        <Qualification>
          <CreditScore>string</CreditScore>
          <MaxAmount>decimal</MaxAmount>
          <InsuranceAmount>decimal</InsuranceAmount>
          <TotalDebt>decimal</TotalDebt>
          <Conditions>string</Conditions>
          <ConditionText>string</ConditionText>
          <ClientType>int</ClientType>
          <ApplicantResult>int</ApplicantResult>
        </Qualification>
        <NetworkId>int</NetworkId>
        <Brand>string</Brand>
      </PushDealResult>
    </PushDealResponse>
  </soap12:Body>
</soap12:Envelope>