公司总览列表 - spooter-supplier

请求参数

Header 参数

x-tag-header

string

可选

默认值:

x-app

string

可选

默认值:

x-group-header

string

可选

默认值:

Authentication-Token

string

可选

默认值:

1777952904371318786_60fa3124b6c34deeb9d76315bfbf2499

Body 参数application/json

销售管理公司总览请求

currentPage

integer <int64>

当前页数

必需

>= 1

pageSize

integer <int64>

展示条数

必需

>= 1

year

integer <int32>

年份

必需

saleLineId

integer <int64>

业务线id

可选

ids

array[integer <int64>]

公司ids

可选

id

integer <int64>

公司id

可选

userId

string

负责人id

可选

extraYears

array[integer <int32>]

下发额外年份的数据

可选

saleTargetOverViewSortReq

object (ReportSaleSaleTargetOverViewSortReq)

可选

销售管理目标总览排序请求

currentPage

integer <int64>

当前页数

必需

>= 1

pageSize

integer <int64>

展示条数

必需

>= 1

sortQuery

object (SortQuery)

排序

可选

year

integer <int32>

年份

必需

lineCode

string

业务线code

可选

companyId

integer <int64>

公司Id

可选

accountManagerId

string

公司负责人Id

可选

示例

{
    "currentPage": 1,
    "pageSize": 1,
    "year": 0,
    "saleLineId": 0,
    "ids": [
        0
    ],
    "id": 0,
    "userId": "string",
    "extraYears": [
        0
    ],
    "saleTargetOverViewSortReq": {
        "currentPage": 1,
        "pageSize": 1,
        "sortQuery": {
            "column": "string",
            "sortType": "string"
        },
        "year": 0,
        "lineCode": "string",
        "companyId": 0,
        "accountManagerId": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://api.dev.spotterio.com/spotter-supplier-web/sale/management/company/overview' \
--header 'x-tag-header: fee_oa' \
--header 'x-app: gmesh' \
--header 'x-group-header: local' \
--header 'Authentication-Token: 1777952904371318786_60fa3124b6c34deeb9d76315bfbf2499' \
--header 'Content-Type: application/json' \
--data-raw '{
    "currentPage": 1,
    "pageSize": 1,
    "year": 0,
    "saleLineId": 0,
    "ids": [
        0
    ],
    "id": 0,
    "userId": "string",
    "extraYears": [
        0
    ],
    "saleTargetOverViewSortReq": {
        "currentPage": 1,
        "pageSize": 1,
        "sortQuery": {
            "column": "string",
            "sortType": "string"
        },
        "year": 0,
        "lineCode": "string",
        "companyId": 0,
        "accountManagerId": "string"
    }
}'

返回响应

🟢200default response

application/json

Body

code

integer <int32>

请求结果码

必需

示例值:

200

data

object (PageVOListReportSaleCompanySaleCompanyContainMonthOverViewVO)

请求结果数据

可选

currentPage

integer <int64>

当前页

必需

示例值:

1

pageSize

integer <int64>

每页显示的总条数

必需

示例值:

20

totalNum

integer <int64>

总条数

必需

示例值:

50

isMore

boolean

必需

是否有下一页,true=有，false=没有

示例值:

true

totalPage

integer <int64>

总页数

必需

示例值:

20

startIndex

integer <int64>

开始索引

必需

示例值:

1

data

array [array]

结果列表

可选

tracerId

string

必需

链路tracerId

示例值:

cfff6f8391cf467f9d262e4ec48c15c7

msg

object (I18nText)

国际化文案模型

必需

示例值:

{"defaultValue":"你的名字是：{name}","params":{"name":"key"},"i18nKey":"spotter.i18n.com.spotter.i18n.web.impl.business.failure.cause.system.busy.2"}

i18nKey

string

翻译文案key

可选

params

object

文案动态参数

可选

defaultValue

string

可选

默认展示文案，国际化引擎失效时的兜底方案

示例

{
    "code": 200,
    "data": {
        "currentPage": 1,
        "pageSize": 20,
        "totalNum": 50,
        "isMore": true,
        "totalPage": 20,
        "startIndex": 1,
        "data": [
            [
                {
                    "overViewVO": {
                        "id": 0,
                        "saleTargetId": 0,
                        "year": 0,
                        "saleLineId": 0,
                        "saleLineVO": {
                            "id": 0,
                            "saleTargetId": 0,
                            "year": 0,
                            "lineId": 0,
                            "name": "string",
                            "code": "string",
                            "userId": "string",
                            "userName": "string",
                            "createdUserId": "string",
                            "createdUserName": "string",
                            "targetSales": 0,
                            "sales": 0,
                            "companyTargetSales": 0,
                            "brandTargetSales": 0,
                            "targetPoOrderNum": 0,
                            "poOrderNum": 0,
                            "status": "string",
                            "type": "string",
                            "salesAchievementRate": 0,
                            "companySalesAchievementRate": 0,
                            "brandSalesAchievementRate": 0,
                            "poOrderNumAchievementRate": 0,
                            "salesGrowthRate": 0,
                            "poOrderNumGrowthRate": 0,
                            "createdTimeMs": 0,
                            "updatedTimeMs": 0
                        },
                        "companyId": 0,
                        "name": "string",
                        "code": "string",
                        "userId": "string",
                        "userName": "string",
                        "createdUserId": "string",
                        "createdUserName": "string",
                        "targetSalesDismantleRate": 0,
                        "status": "string",
                        "type": "string",
                        "createdTimeMs": 0,
                        "updatedTimeMs": 0,
                        "commonVO": {
                            "targetPrice": 0,
                            "price": 0,
                            "targetSales": 0,
                            "sales": 0,
                            "targetPoOrderNum": 0,
                            "poOrderNum": 0,
                            "salesAchievementRate": 0,
                            "poOrderNumAchievementRate": 0,
                            "salesGrowthRate": 0,
                            "poOrderNumGrowthRate": 0,
                            "targetPriceAchievementRate": 0
                        }
                    },
                    "monthVOList": [
                        {
                            "id": 0,
                            "saleTargetId": 0,
                            "saleLineId": 0,
                            "saleCompanyId": 0,
                            "month": 0,
                            "createdTimeMs": 0,
                            "updatedTimeMs": 0,
                            "commonVO": {
                                "targetPrice": 0,
                                "price": 0,
                                "targetSales": 0,
                                "sales": 0,
                                "targetPoOrderNum": 0,
                                "poOrderNum": 0,
                                "salesAchievementRate": 0,
                                "poOrderNumAchievementRate": 0,
                                "salesGrowthRate": 0,
                                "poOrderNumGrowthRate": 0,
                                "targetPriceAchievementRate": 0
                            }
                        }
                    ]
                }
            ]
        ]
    },
    "tracerId": "cfff6f8391cf467f9d262e4ec48c15c7",
    "msg": {
        "defaultValue": "你的名字是：{name}",
        "params": {
            "name": "key"
        },
        "i18nKey": "spotter.i18n.com.spotter.i18n.web.impl.business.failure.cause.system.busy.2"
    }
}