SWAPI – Sales Summary

New sales summary commands have been added allowing you to query and update information from the SuccessWare Sales Summary form.

Note that previously, Sales Summaries only existed on Sales Jobs.  With this update, Both regular service jobs and sales jobs may have a sales summary.  The regular service job now has both a Job Summary and a Sales Summary.  These new Sales Summary SWAPI commands can be used on both sales jobs and regular service jobs.

If you are currently using Job Summary for sales jobs, note that there have been some changes to the Job Summary for sales jobs.  But these changes should not affect you.  The command remains backward compatible. The job summary query commands have been modified so that when querying a “sales” job the follow up data from the Sales Summary form is returned. The job summary update commands have been modified so that when updating a “sales” job, only those fields that actually pertain to “sales” jobs will be affected.

Sales Summary Query. 1

Sales Summary By ID Query. 2

Sales Summary Update. 2

Sales Summary By ID Update. 3

Job Summary Query. 4

Job Summary By ID Query. 5

Job Summary Update. 5

Job Summary By ID Update. 5

Sales Summary Query

This command is used to return Sales Summary data for a job. A valid job number must be supplied.

<SessionRequest Version="string" SessionID="{9EFADFB5-58C4-4BE1-BBDB-9A95FE607AE9}" RequestID="string">

  <SalesSummaryQuery Filter="string" Max="string" OrderBy="string" StyleNo="string" StyleOptions="string">

    <JobNo>string</JobNo>

  </SalesSummaryQuery>

</SessionRequest>

Sample Response XML

<SalesSummaryQueryResponse Successful="true" ResultCode="000" ResultText="Successful" Version="1.9.300.6" RequestID="string">

<SalesSummaryQueryData ReturnedRows="1" FilteredRows="1" TotalRows="1" QueryOptions="JobNo=218553">

<SalesSummaryQueryRecord>

<JobID>218553</JobID>

<JobNo>218553</JobNo>

<IsContinuedLead>FALSE</IsContinuedLead>

<CountLead>TRUE</CountLead>

<ReportingSaleSource>RepairOpps</ReportingSaleSource>

<SaleEstDate>20170131</SaleEstDate>

<EstimateBy>MADGRI</EstimateBy>

<SaleStatus>QUOTE</SaleStatus>

<SaleResult>SOLD</SaleResult>

<SaleReason></SaleReason>

<SaleUnit>CHL</SaleUnit>

<SaleUnitType>PRE</SaleUnitType>

<SaleIsSoldSales>TRUE</SaleIsSoldSales>

<SaleDate>20170131</SaleDate>

<SaleActual>1500</SaleActual>

<SaleCR>FALSE</SaleCR>

<IsDoneSales>TRUE</IsDoneSales>

<OpportunityCodeSales>EFUR</OpportunityCodeSales>

<FollowupDateSales>20170203</FollowupDateSales>

<LeadGenBySales>CONFLY</LeadGenBySales>

<FollowUpNoteSales>Customer may be interested in a furnace replacement</FollowUpNoteSales>

</SalesSummaryQueryRecord>

</SalesSummaryQueryData>

</SalesSummaryQueryResponse>

Sales Summary By ID Query

This command is used to return Sales Summary data for a job. A valid job ID must be supplied.

<SessionRequest Version="string" SessionID="{9EFADFB5-58C4-4BE1-BBDB-9A95FE607AE9}" RequestID="string">

  <SalesSummaryByIDQuery Filter="string" Max="string" OrderBy="string" StyleNo="string" StyleOptions="string">

    <JobID>int</JobID>

  </SalesSummaryByIDQuery>

</SessionRequest>

Sample Response XML

<SalesSummaryByIDQueryResponse Successful="true" ResultCode="000" ResultText="Successful" Version="1.9.300.6" RequestID="string">

<SalesSummaryByIDQueryData ReturnedRows="1" FilteredRows="1" TotalRows="1" QueryOptions="JobID=218553">

<SalesSummaryByIDQueryRecord>

<JobID>218553</JobID>

<JobNo>218553</JobNo>

<IsContinuedLead>FALSE</IsContinuedLead>

<CountLead>TRUE</CountLead>

<ReportingSaleSource>RepairOpps</ReportingSaleSource>

<SaleEstDate>20170131</SaleEstDate>

<EstimateBy>MADGRI</EstimateBy>

<SaleStatus>QUOTE</SaleStatus>

<SaleResult>SOLD</SaleResult>

<SaleReason></SaleReason>

<SaleUnit>CHL</SaleUnit>

<SaleUnitType>PRE</SaleUnitType>

<SaleIsSoldSales>TRUE</SaleIsSoldSales>

<SaleDateSales>20170131</SaleDateSales>

<SaleActual>1500</SaleActual>

<SaleCR>FALSE</SaleCR>

<IsDoneSales>TRUE</IsDoneSales>

<OpportunityCodeSales>EFUR</OpportunityCodeSales>

<FollowupDateSales>20170203</FollowupDateSales>

<LeadGenBySales>CONFLY</LeadGenBySales>

<FollowUpNoteSales>Customer may be interested in a furnace replacement</FollowUpNoteSales>

</SalesSummaryByIDQueryRecord>

</SalesSummaryByIDQueryData>

</SalesSummaryByIDQueryResponse>

Sales Summary Update

This command is used to update sales summary data for a specific job number. The job number must exist in order to update the data. If Sale Is Sold Sales is true then you must submit a Sale Date Sales and a sale amount (Sale Actual). The following fields must contain a valid code per their respective reference library book:

· Reporting Sales Source

· Sale Status

· Sale Result

· Sale Reason

· Sale Unit

· Sale Unit Type

· Opportunity Code Sales

The following fields must contain a valid employee code:

· Estimate By

· Lead Gen By Sales

<SessionRequest Version="string" SessionID="{9EFADFB5-58C4-4BE1-BBDB-9A95FE607AE9}" RequestID="string">

  <SalesSummaryUpdate>

    <SalesSummaryUpdateData>

      <SalesSummaryUpdateRecord>

        <JobID>integer</JobID>

        <JobNo>string(10)</JobNo>

        <IsContinuedLead>boolean</IsContinuedLead>

        <CountLead>boolean</CountLead>

        <ReportingSaleSource>string(15)</ReportingSaleSource>

        <SaleEstDate>dateTime</SaleEstDate>

        <EstimateBy>string(6)</EstimateBy>

        <SaleStatus>string(6)</SaleStatus>

        <SaleResult>string(6)</SaleResult>

        <SaleReason>string(6)</SaleReason>

        <SaleUnit>string(50)</SaleUnit>

        <SaleUnitType>string(6)</SaleUnitType>

        <SaleIsSoldSales>boolean</SaleIsSoldSales>

        <SaleDateSales>dateTime</SaleDateSales>

        <SaleActual>float</SaleActual>

        <SaleCR>boolean</SaleCR>

        <IsDoneSales>boolean</IsDoneSales>

        <OpportunityCodeSales>string(10)</OpportunityCodeSales>

        <FollowupDateSales>dateTime</FollowupDateSales>

        <LeadGenBySales>string(6)</LeadGenBySales>

        <FollowUpNoteSales>string</FollowUpNoteSales>

      </SalesSummaryUpdateRecord>

    </SalesSummaryUpdateData>

  </SalesSummaryUpdate>

</SessionRequest>

Sample Response XML

<SalesSummaryUpdateResponse Successful="true" ResultCode="000" ResultText="Successful" Version="1.9.300.6" RequestID="string">

<SalesSummaryUpdateData>

<SalesSummaryUpdateRecord>

<JobID>218553</JobID>

<JobNo>218553</JobNo>

<IsContinuedLead>FALSE</IsContinuedLead>

<CountLead>TRUE</CountLead>

<ReportingSaleSource>RepairOpps</ReportingSaleSource>

<SaleEstDate>20170131</SaleEstDate>

<EstimateBy>MADGRI</EstimateBy>

<SaleStatus>QUOTE</SaleStatus>

<SaleResult>SOLD</SaleResult>

<SaleReason></SaleReason>

<SaleUnit>CHL</SaleUnit>

<SaleUnitType>PRE</SaleUnitType>

<SaleIsSoldSales>TRUE</SaleIsSoldSales>

<SaleDateSales>20170131</SaleDateSales>

<SaleActual>1500</SaleActual>

<SaleCR>FALSE</SaleCR>

<IsDoneSales>TRUE</IsDoneSales>

<OpportunityCodeSales>EFUR</OpportunityCodeSales>

<FollowupDateSales>20170203</FollowupDateSales>

<LeadGenBySales>CONFLY</LeadGenBySales>

<FollowUpNoteSales>Customer may be interested in a furnace replacement</FollowUpNoteSales>

</SalesSummaryUpdateRecord>

</SalesSummaryUpdateData>

</SalesSummaryUpdateResponse>

Sales Summary By ID Update

This command is used to update sales summary data for a specific job ID. The job ID must exist in order to update the data. If Sale Is Sold Sales is true then you must submit a Sale Date Sales and a sale amount (Sale Actual). The following fields must contain a valid code per their respective reference library book:

· Reporting Sales Source

· Sale Status

· Sale Result

· Sale Reason

· Sale Unit

· Sale Unit Type

· Opportunity Code Sales

The following fields must contain a valid employee code:

· Estimate By

· Lead Gen By Sales

<SessionRequest Version="string" SessionID="{9EFADFB5-58C4-4BE1-BBDB-9A95FE607AE9}" RequestID="string">

  <SalesSummaryByIDUpdate>

    <SalesSummaryByIDUpdateData>

      <SalesSummaryByIDUpdateRecord>

        <JobID>integer</JobID>

        <JobNo>string(10)</JobNo>

        <IsContinuedLead>boolean</IsContinuedLead>

        <CountLead>boolean</CountLead>

        <ReportingSaleSource>string(15)</ReportingSaleSource>

        <SaleEstDate>dateTime</SaleEstDate>

        <EstimateBy>string(6)</EstimateBy>

        <SaleStatus>string(6)</SaleStatus>

        <SaleResult>string(6)</SaleResult>

        <SaleReason>string(6)</SaleReason>

        <SaleUnit>string(50)</SaleUnit>

        <SaleUnitType>string(6)</SaleUnitType>

        <SaleIsSoldSales>boolean</SaleIsSoldSales>

        <SaleDateSales>dateTime</SaleDateSales>

        <SaleActual>float</SaleActual>

        <SaleCR>boolean</SaleCR>

        <IsDoneSales>boolean</IsDoneSales>

        <OpportunityCodeSales>string(10)</OpportunityCodeSales>

        <FollowupDateSales>dateTime</FollowupDateSales>

        <LeadGenBySales>string(6)</LeadGenBySales>

        <FollowUpNoteSales>string</FollowUpNoteSales>

      </SalesSummaryByIDUpdateRecord>

    </SalesSummaryByIDUpdateData>

  </SalesSummaryByIDUpdate>

</SessionRequest>

Sample Response XML

<SalesSummaryByIDUpdateResponse Successful="true" ResultCode="000" ResultText="Successful" Version="1.9.300.6" RequestID="string">

<SalesSummaryByIDUpdateData>

<SalesSummaryByIDUpdateRecord>

<JobID>218553</JobID>

<JobNo>218553</JobNo>

<IsContinuedLead>FALSE</IsContinuedLead>

<CountLead>TRUE</CountLead>

<ReportingSaleSource>RepairOpps</ReportingSaleSource>

<SaleEstDate>20170131</SaleEstDate>

<EstimateBy>MADGRI</EstimateBy>

<SaleStatus>QUOTE</SaleStatus>

<SaleResult>SOLD</SaleResult>

<SaleReason></SaleReason>

<SaleUnit>CHL</SaleUnit>

<SaleUnitType>PRE</SaleUnitType>

<SaleIsSoldSales>TRUE</SaleIsSoldSales>

<SaleDateSales>20170131</SaleDateSales>

<SaleActual>1500</SaleActual>

<SaleCR>FALSE</SaleCR>

<IsDoneSales>TRUE</IsDoneSales>

<OpportunityCodeSales>EFUR</OpportunityCodeSales>

<FollowupDateSales>20170203</FollowupDateSales>

<LeadGenBySales>CONFLY</LeadGenBySales>

<FollowUpNoteSales>Customer may be interested in a furnace replacement</FollowUpNoteSales>

</SalesSummaryByIDUpdateRecord>

</SalesSummaryByIDUpdateData>

</SalesSummaryByIDUpdateResponse>

Job Summary Query

There are no schema changes with this command, however; it has been modified such that when querying for a “sales” job it will return the follow up data from the Sales Summary Form in SuccessWare. The following fields are affected by this change:

· Lead Gen By

· Opportunity Code

· Follow Up Date

· Follow Up Note

· Is Notified

· Is Done

Job Summary By ID Query

There are no schema changes with this command, however; it has been modified such that when querying for a “sales” job it will return the follow up data from the Sales Summary Form in SuccessWare. The following fields are affected by this change:

· Lead Gen By

· Opportunity Code

· Follow Up Date

· Follow Up Note

· Is Notified

· Is Done

Job Summary Update

There are no schema changes with this command, however; it has been modified such that when updating a “sales” job only the following fields will be updated as none of the others pertain to a “sales” job in SuccessWare:

· Job Number

· Lead Gen By

· Opportunity Code

· Follow Up Date

· Follow Up Note

· Is Notified

· Is Done

· Reporting Sales Source

Job Summary By ID Update

There are no schema changes with this command, however; it has been modified such that when updating a “sales” job only the following fields will be updated as none of the others pertain to a “sales” job in SuccessWare:

· Job Number

· Lead Gen By

· Opportunity Code

· Follow Up Date

· Follow Up Note

· Is Notified

· Is Done

· Reporting Sales Source