经营概览-首页
<p>[TOC]</p>
<h5>简要描述</h5>
<ul>
<li>报表接口</li>
</ul>
<h5>请求URL</h5>
<ul>
<li>` <a href="http://api-test.boka.vc/analytic/business/overview/report">http://api-test.boka.vc/analytic/business/overview/report</a></li>
</ul>
<h5>请求方式</h5>
<ul>
<li>POST </li>
</ul>
<h5>参数</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">compIds</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">List</td>
<td>门店id集合</td>
</tr>
<tr>
<td style="text-align: left;">startDate</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>账务日期-开始日期 <strong>yyyy-MM-dd</strong></td>
</tr>
<tr>
<td style="text-align: left;">endDate</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>账务日期-结束日期 <strong>yyyy-MM-dd</strong></td>
</tr>
<tr>
<td style="text-align: left;">queryType</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>查询范围： 0：全部 1：营收 2：销售 3：消耗 4：产品</td>
</tr>
<tr>
<td style="text-align: left;">type</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>查询方式： 0：月报 1：年报</td>
</tr>
</tbody>
</table>
<h5>参数示例</h5>
<pre><code>{
&quot;compIds&quot;: [
&quot;5d6494c5033f9f3274eb991a&quot;
],
&quot;startDate&quot;: &quot;2024-12-01&quot;,
&quot;endDate&quot;: &quot;2024-12-23&quot;,
&quot;queryType&quot;: 0,
&quot;type&quot;: 0
}</code></pre>
<h5>返回参数说明</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">business</td>
<td style="text-align: left;">object</td>
<td>营收</td>
</tr>
<tr>
<td style="text-align: left;">customer</td>
<td style="text-align: left;">Object</td>
<td>到店</td>
</tr>
<tr>
<td style="text-align: left;">baseRightsAmount</td>
<td style="text-align: left;">float</td>
<td>销售总额-基础项目-销售总额</td>
</tr>
<tr>
<td style="text-align: left;">baseRightsCategory</td>
<td style="text-align: left;">list</td>
<td>销售总额-基础项目-权益类型扇形图</td>
</tr>
<tr>
<td style="text-align: left;">baseRightsList</td>
<td style="text-align: left;">list</td>
<td>销售总额-基础项目-top10</td>
</tr>
<tr>
<td style="text-align: left;">bigRightsAmount</td>
<td style="text-align: left;">float</td>
<td>销售总额-大项目-销售总额</td>
</tr>
<tr>
<td style="text-align: left;">bigRightsCategory</td>
<td style="text-align: left;">list</td>
<td>销售总额-大项目-权益类型扇形图</td>
</tr>
<tr>
<td style="text-align: left;">bigRightsList</td>
<td style="text-align: left;">list</td>
<td>销售总额-大项目-top10</td>
</tr>
<tr>
<td style="text-align: left;">baseProjectAmount</td>
<td style="text-align: left;">float</td>
<td>消耗总额-基础项目-消耗总额</td>
</tr>
<tr>
<td style="text-align: left;">baseProjectCategory</td>
<td style="text-align: left;">list</td>
<td>消耗总额-基础项目-项目统计类别扇形图</td>
</tr>
<tr>
<td style="text-align: left;">baseProjectList</td>
<td style="text-align: left;">list</td>
<td>消耗总额-基础项目-top10</td>
</tr>
<tr>
<td style="text-align: left;">bigProjectAmount</td>
<td style="text-align: left;">float</td>
<td>消耗总额-大项目-消耗总额</td>
</tr>
<tr>
<td style="text-align: left;">bigProjectCategory</td>
<td style="text-align: left;">list</td>
<td>消耗总额-大项目-项目统计类别扇形图</td>
</tr>
<tr>
<td style="text-align: left;">bigProjectList</td>
<td style="text-align: left;">list</td>
<td>消耗总额-大项目-top10</td>
</tr>
<tr>
<td style="text-align: left;">productAmount</td>
<td style="text-align: left;">float</td>
<td>产品消耗-消耗总额</td>
</tr>
<tr>
<td style="text-align: left;">productCategory</td>
<td style="text-align: left;">list</td>
<td>产品消耗-产品统计类别扇形图</td>
</tr>
<tr>
<td style="text-align: left;">productList</td>
<td style="text-align: left;">list</td>
<td>产品消耗-top10</td>
</tr>
</tbody>
</table>
<p>business说明</p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">businessAmt</td>
<td style="text-align: left;">float</td>
<td>实际总现金</td>
</tr>
<tr>
<td style="text-align: left;">businessAmtRate</td>
<td style="text-align: left;">float</td>
<td>实际总现金-环比</td>
</tr>
<tr>
<td style="text-align: left;">businessAmtRatio</td>
<td style="text-align: left;">float</td>
<td>实际总现金-同比</td>
</tr>
<tr>
<td style="text-align: left;">cashBillAmt</td>
<td style="text-align: left;">float</td>
<td>消耗总额</td>
</tr>
<tr>
<td style="text-align: left;">cashBillAmtRate</td>
<td style="text-align: left;">float</td>
<td>消耗总额-环比</td>
</tr>
<tr>
<td style="text-align: left;">cashBillAmtRatio</td>
<td style="text-align: left;">float</td>
<td>消耗总额-同比</td>
</tr>
<tr>
<td style="text-align: left;">rate</td>
<td style="text-align: left;">float</td>
<td>收现消耗比</td>
</tr>
<tr>
<td style="text-align: left;">sameRate</td>
<td style="text-align: left;">float</td>
<td>收现消耗比-环比</td>
</tr>
<tr>
<td style="text-align: left;">sameRatio</td>
<td style="text-align: left;">float</td>
<td>收现消耗比-同比</td>
</tr>
</tbody>
</table>
<p>customer说明</p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">customerNum</td>
<td style="text-align: left;">float</td>
<td>实操客数</td>
</tr>
<tr>
<td style="text-align: left;">customerNumRate</td>
<td style="text-align: left;">float</td>
<td>实操客数-环比</td>
</tr>
<tr>
<td style="text-align: left;">customerNumRatio</td>
<td style="text-align: left;">float</td>
<td>实操客数-同比</td>
</tr>
<tr>
<td style="text-align: left;">customerTimes</td>
<td style="text-align: left;">float</td>
<td>实操客次</td>
</tr>
<tr>
<td style="text-align: left;">customerTimesRate</td>
<td style="text-align: left;">float</td>
<td>实操客次-环比</td>
</tr>
<tr>
<td style="text-align: left;">customerTimesRatio</td>
<td style="text-align: left;">float</td>
<td>实操客次-同比</td>
</tr>
<tr>
<td style="text-align: left;">goodsNum</td>
<td style="text-align: left;">float</td>
<td>消耗项目数</td>
</tr>
<tr>
<td style="text-align: left;">goodsNumRate</td>
<td style="text-align: left;">float</td>
<td>消耗项目数-环比</td>
</tr>
<tr>
<td style="text-align: left;">goodsNumRatio</td>
<td style="text-align: left;">float</td>
<td>消耗项目数-同比</td>
</tr>
<tr>
<td style="text-align: left;">goodsNum</td>
<td style="text-align: left;">float</td>
<td>消耗项目数</td>
</tr>
<tr>
<td style="text-align: left;">goodsNumRate</td>
<td style="text-align: left;">float</td>
<td>消耗项目数-环比</td>
</tr>
<tr>
<td style="text-align: left;">goodsNumRatio</td>
<td style="text-align: left;">float</td>
<td>消耗项目数-同比</td>
</tr>
<tr>
<td style="text-align: left;">rate</td>
<td style="text-align: left;">float</td>
<td>消耗项目比</td>
</tr>
<tr>
<td style="text-align: left;">sameRate</td>
<td style="text-align: left;">float</td>
<td>消耗项目比-环比</td>
</tr>
<tr>
<td style="text-align: left;">sameRatio</td>
<td style="text-align: left;">float</td>
<td>消耗项目比-同比</td>
</tr>
</tbody>
</table>
<p>baseRightsCategory、bigRightsCategory、baseProjectCategory、bigProjectCategory、productCategory说明</p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">categoryCode</td>
<td style="text-align: left;">String</td>
<td>类别编号</td>
</tr>
<tr>
<td style="text-align: left;">categoryName</td>
<td style="text-align: left;">String</td>
<td>类别名称</td>
</tr>
<tr>
<td style="text-align: left;">businessAmt</td>
<td style="text-align: left;">float</td>
<td>金额</td>
</tr>
</tbody>
</table>
<p>baseRightsList、bigRightsList、baseProjectList、bigProjectList、productList说明</p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">goodsCode</td>
<td style="text-align: left;">String</td>
<td>商品编号</td>
</tr>
<tr>
<td style="text-align: left;">goodsName</td>
<td style="text-align: left;">String</td>
<td>商品名称</td>
</tr>
<tr>
<td style="text-align: left;">businessAmt</td>
<td style="text-align: left;">float</td>
<td>金额</td>
</tr>
<tr>
<td style="text-align: left;">cashPayAmt</td>
<td style="text-align: left;">float</td>
<td>现金</td>
</tr>
<tr>
<td style="text-align: left;">rightsPayAmt</td>
<td style="text-align: left;">float</td>
<td>耗卡</td>
</tr>
</tbody>
</table>
<h5>汇总-返回示例</h5>
<pre><code>{
&quot;code&quot;: 200,
&quot;result&quot;: {
&quot;baseProjectAmount&quot;: 740.00000,
&quot;business&quot;: {
&quot;businessAmt&quot;: 154917.52000,
&quot;businessAmtRate&quot;: 0,
&quot;businessAmtRatio&quot;: 0,
&quot;cashBillAmt&quot;: 39765.87000,
&quot;cashBillAmtRate&quot;: 0,
&quot;cashBillAmtRatio&quot;: 0,
&quot;rate&quot;: 0.2567,
&quot;sameRate&quot;: 0,
&quot;sameRatio&quot;: 0
},
&quot;bigProjectAmount&quot;: 0,
&quot;bigProjectList&quot;: [],
&quot;baseProjectCategory&quot;: [
{
&quot;businessAmt&quot;: 740.00000,
&quot;categoryCode&quot;: &quot;2024081316331100703798&quot;,
&quot;categoryName&quot;: &quot;头皮&quot;
}
],
&quot;baseRightsAmount&quot;: 7200.00000,
&quot;productCategory&quot;: [
{
&quot;businessAmt&quot;: 200.00000,
&quot;categoryCode&quot;: &quot;2024081614392924596341&quot;,
&quot;categoryName&quot;: &quot;洗护&quot;
}
],
&quot;productAmount&quot;: 200.00000,
&quot;bigRightsList&quot;: [],
&quot;bigRightsCategory&quot;: [],
&quot;baseProjectList&quot;: [
{
&quot;businessAmt&quot;: 400.00000,
&quot;cashPayAmt&quot;: 400.00000,
&quot;categoryCode&quot;: &quot;2024081316331100703798&quot;,
&quot;categoryName&quot;: &quot;头皮&quot;,
&quot;flag&quot;: 0,
&quot;goodsCode&quot;: &quot;003&quot;,
&quot;goodsName&quot;: &quot;净化丰盈护理&quot;,
&quot;goodsType&quot;: 1,
&quot;rightsPayAmt&quot;: 0.00000
}
],
&quot;baseRightsList&quot;: [
{
&quot;businessAmt&quot;: 5000.00000,
&quot;cashPayAmt&quot;: 4000.00000,
&quot;categoryCode&quot;: &quot;4&quot;,
&quot;categoryName&quot;: &quot;品项&quot;,
&quot;flag&quot;: 0,
&quot;goodsCode&quot;: &quot;2024101216022402293062&quot;,
&quot;goodsName&quot;: &quot;小蛮腰&quot;,
&quot;goodsType&quot;: 4,
&quot;rightsPayAmt&quot;: 1000.00000
}
],
&quot;productList&quot;: [
{
&quot;businessAmt&quot;: 100.00000,
&quot;cashPayAmt&quot;: 100.00000,
&quot;categoryCode&quot;: &quot;2024081614392924596341&quot;,
&quot;categoryName&quot;: &quot;洗护&quot;,
&quot;flag&quot;: 0,
&quot;goodsCode&quot;: &quot;2024071217295574645771&quot;,
&quot;goodsName&quot;: &quot;美容V2寄存领取产品专用&quot;,
&quot;goodsType&quot;: 3,
&quot;rightsPayAmt&quot;: 0.00000
}
],
&quot;customer&quot;: {
&quot;customerNum&quot;: 84,
&quot;customerNumRate&quot;: 0,
&quot;customerNumRatio&quot;: 0,
&quot;customerTimes&quot;: 54,
&quot;customerTimesRate&quot;: 0,
&quot;customerTimesRatio&quot;: 0,
&quot;goodsNum&quot;: 94.00000,
&quot;goodsNumRate&quot;: 0,
&quot;goodsNumRatio&quot;: 0,
&quot;rate&quot;: 2.0435,
&quot;sameRate&quot;: 0,
&quot;sameRatio&quot;: 0
},
&quot;baseRightsCategory&quot;: [
{
&quot;businessAmt&quot;: 5000.00000,
&quot;categoryCode&quot;: &quot;4&quot;,
&quot;categoryName&quot;: &quot;品项&quot;
}
],
&quot;bigRightsAmount&quot;: 0,
&quot;bigProjectCategory&quot;: []
},
&quot;success&quot;: true
}</code></pre>
<h5>备注</h5>
<ul>
<li>无</li>
</ul>