open-api
首页
首页
  1. 客户
  • 快速开始
  • 授权登录
    • 授权登录流程
    • 鉴权接口
      POST
    • 刷新令牌接口
      POST
  • 客户
    • 客户
    • 跟进动态查询接口
      GET
    • 提交跟进动态
      POST
    • 客户分组新增/编辑
      POST
    • 删除客户分组
      POST
    • 客户阶段新增/编辑
      POST
    • 删除客户阶段
      POST
    • 客户标签新增/编辑
      POST
    • 删除客户标签
      POST
    • 客户枚举:客户类型,客户标签,时区,规模,星级,采购意向,采购额度,职级
      GET
    • 移入公海
      POST
    • 客户数据字典
      GET
    • 客户(含联系人)新增/编辑
      POST
    • 删除客户(仅支持公海客户)
      POST
    • 客户详情
      GET
    • 查询客户的阶段、分组、状态、地区、主营产品、来源
      GET
  • 销售订单
    • 销售订单
    • 销售订单枚举:货币,付款方式,国家/地区,订单类型,订单状态,订单创建方式
      GET
    • 销售订单字段
      GET
    • 销售订单删除
      POST
    • 销售订单新建/编辑
      POST
    • 销售订单列表
      GET
    • 销售订单详情
      GET
  • 采购订单
    • 采购订单
    • 采购订单列表
    • 采购订单字段
    • 采购订单状态
    • 采购订单新增/编辑
    • 采购订单详情
  • 产品
    • 产品
    • 产品枚举:产品类型,离岸价设置类型,创建方式,产品计量单位
    • 产品分组删除
    • 查询产品库列表
    • 产品新建/编辑
    • 产品库的数据字典
    • 产品详情
    • 产品分组新增/编辑
    • 删除产品规格
    • 查询产品分组
    • 新增/编辑规格
    • 查询产品规格列表
    • 增量更新产品规格值
  • 回款登记
    • 回款登记
    • 回款登记详情
    • 回款登记字段
    • 回款登记新建/编辑
    • 回款登记列表
    • 回款登记核销
  • 回款单
    • 回款单
    • 回款方式枚举
    • 回款单列表
    • 回款单字段
    • 回款单新建/编辑
    • 回款单详情
  • 付款单
    • 付款单
    • 付款单详情
    • 付款单字段
    • 付款单列表
  • 费用单
    • 费用单
    • 费用单-详情
    • 费用单字段
    • 费用项目列表
    • 费用单列表
  • 报价单
    • 报价单
    • 报价单列表
    • 报价单状态、币种查询
    • 报价单删除
    • 报价单数据字典
    • 报价单新建/编辑
    • 查询报价单详情
  • 供应商
    • 供应商
    • 供应商列表
    • 供应商字段
    • 供应商删除
    • 供应商详情
    • 供应商新增/编辑
  • 商机
    • 商机
    • 查询商机的销售流程 商机阶段 输单原因
    • 商机删除接口
    • 商机列表
    • 商机数据查询
    • 商机数据字典
    • 商机新建/编辑接口
  • 用户
    • 用户
    • 用户部门列表
    • 用户部门详情
    • 用户列表
    • 用户详情
  • 销售出库单
    • 销售出库单
    • 销售出库单列表
    • 销售出库单详情
    • 销售出库单字段
    • 销售出库单删除
    • 新增/编辑销售出库单
  • 库存
    • 库存
    • 库存写入
    • 仓库查询
  • 线索
    • 线索
    • 线索|联系人的数据字典
    • 线索列表
    • 线索数据查询
    • 线索(含联系人)创建/编辑接口
  • 资金
    • 资金
    • 资金账户列表
  • 采购入库单
    • 采购入库单
    • 采购入库单-列表
    • 采购入库单-详情
    • 采购入库单字段
    • 采购入库单-删除
    • 采购入库单-新建/编辑
  • 采购退货单
    • 采购退货单
    • 采购退货单-列表
    • 采购退货单-详情
    • 采购退货单字段
    • 采购退货单-新建/编辑
    • 采购退货单-删除
  • 统计分析
    • 统计报告-统计详细
  • 示例接口(勿用)
    • 示例说明
    • 例子列表
    • 例子枚举值查询
  • devops相关
    • 钉钉回调
    • tapd回调接口
    • 获取智齿token
    • 智齿刷新接口
    • app版本发布
    • 钉钉管理-删除账号
  • 动态
  • 阿里账号信息
    GET
  • 阿里资金账户信息
    GET
  • ACP网关接口
    POST
  1. 客户

客户数据字典

GET
/v1/company/fields

字段类型有哪些#

field_type
1单行文本
2多行文本
3单选,在该字段选项枚举值在返回值中的ext_info里面,可用于单据新建、编辑该字段传值
4日期,YYYY-MM-DD
5数字
6图片
7多选,在该字段选项枚举值在返回值中的ext_info里面,可用于单据新建、编辑该字段传值
8附件
9关联字段
10日期时间,YYYY-MM-DD HH:mm:ss
11公式
12汇总
13布尔
17状态
18阶段
21时间范围
22富文本
23引用
若发现没有的字段类型可以咨询对接群,或者提客户工单。

请求参数

Query 参数

Header 参数

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-sandbox.xiaoman.cn/v1/company/fields?type=company' \
--header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMWMxMzU5NmRlMGJjYzM1MzRlYTIxMWEyMTE0MTdjODcxZjMzZGVjNjVmMzE1MDcxM2EwMTE5N2I0NGJlODY2NDM0YWFmYjczZmI0ZWIwYiIsImp0aSI6IjdhMjA3NTY5MmViNTc1ZGFlNTAyNmNhMzUwNDljYTFiNTgzNmM4MGQ3OTFhMGQzNzk5NTliMGQxODk4ZjI3YjhmYmM3OWE1NDE2NTQyMzQ1IiwiaWF0IjoxNjc1ODI0MTA5LjQ3NzIyLCJuYmYiOjE2NzU4MjQxMDkuNDc3MjIxLCJleHAiOjE2NzU4NTI5MDkuNDUwNTMxLCJzdWIiOiIiLCJzY29wZXMiOlsicHJvZHVjdCIsImNvbXBhbnkiLCJpbnZvaWNlcyIsImxlYWQiLCJvcHBvcnR1bml0eSIsInVzZXIiXX0.PvaNNsQqk6yBl1dlaEQGCWpkn8EoFzuSdkyv8RpKyV_W91-LLDq4qNpBJPW7ieA_qKV44977GIQghGd9FDjvZucY1IfQwxfpeGIztEC5mcdSItSgsCXNWTP-Pw7FX28n6qIvIfKLmm7r4NrBrYbFsLOwFaJ9v13RNFF6NhvZognYlcveVIT2vwRL48HSZUjzRqPKo93rWbEojXaqGfsc9qLptyZ1IAhJqSh6ZrEVQBe6awa-R7G4AiFiqCMXQfsuON6xWu__F51FyEzk-vr40qvmBY82SuSAGuTkUsVKXDpoZHz8ZQoY9KG822t5WMeziaGq8CW8er6A7LF0IeWUDQ' \
--header 'Authorization;'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 200,
    "message": "success",
    "now": "2025-03-04 17:12:05",
    "data": [
        {
            "id": "",
            "name": "来源详情",
            "base": 1,
            "field_type": 7,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 1
        },
        {
            "id": "origin_list",
            "name": "客户来源",
            "base": 1,
            "field_type": 7,
            "ext_info": null,
            "require": 1,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "biz_type",
            "name": "客户类型",
            "base": 1,
            "field_type": 3,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "scale_id",
            "name": "规模",
            "base": 1,
            "field_type": 3,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "short_name",
            "name": "简称",
            "base": 1,
            "field_type": 1,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "cus_tag",
            "name": "客户标签",
            "base": 1,
            "field_type": 7,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "trail_status",
            "name": "客户阶段",
            "base": 1,
            "field_type": 3,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "homepage",
            "name": "公司网址",
            "base": 1,
            "field_type": 1,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "category_ids",
            "name": "主营产品",
            "base": 1,
            "field_type": 7,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "product_group_ids",
            "name": "产品分组",
            "base": 1,
            "field_type": 7,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "intention_level",
            "name": "采购意向",
            "base": 1,
            "field_type": 3,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 1,
            "is_list": 0
        },
        {
            "id": "annual_procurement",
            "name": "年采购额",
            "base": 1,
            "field_type": 3,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "address",
            "name": "详细地址",
            "base": 1,
            "field_type": 2,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "name",
            "name": "公司名称",
            "base": 1,
            "field_type": 1,
            "ext_info": null,
            "require": 1,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "province",
            "name": "省份",
            "base": 1,
            "field_type": 3,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "group_id",
            "name": "客户分组",
            "base": 1,
            "field_type": 3,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "serial_id",
            "name": "客户编号",
            "base": 1,
            "field_type": 1,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "fax",
            "name": "传真",
            "base": 1,
            "field_type": 1,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "tel",
            "name": "座机",
            "base": 1,
            "field_type": 1,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "country",
            "name": "国家地区",
            "base": 1,
            "field_type": 3,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "city",
            "name": "城市",
            "base": 1,
            "field_type": 3,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "timezone",
            "name": "时区",
            "base": 1,
            "field_type": 3,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "remark",
            "name": "公司备注",
            "base": 1,
            "field_type": 2,
            "ext_info": null,
            "require": 0,
            "default": "龙琴",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "image_list",
            "name": "公司logo",
            "base": 1,
            "field_type": 6,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "next_follow_up_time",
            "name": "下次日程时间",
            "base": 1,
            "field_type": 10,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": 5200812401,
            "name": "测试日期",
            "base": 0,
            "field_type": 4,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": 5200433878,
            "name": "兴趣爱好",
            "base": 0,
            "field_type": 7,
            "ext_info": [
                "游泳",
                "登山"
            ],
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": 5196023966,
            "name": "最新报价时间",
            "base": 0,
            "field_type": 4,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "5118904304",
            "name": "报价时间",
            "base": 0,
            "field_type": 10,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "3082106516",
            "name": "haodeya",
            "base": 0,
            "field_type": 5,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "3462856443",
            "name": "公司信息图片类型字段",
            "base": 0,
            "field_type": 6,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "3266094846",
            "name": "客户自定义多行文本",
            "base": 0,
            "field_type": 2,
            "ext_info": null,
            "require": 0,
            "default": "22",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "3215316242",
            "name": "导出日期字段测试",
            "base": 0,
            "field_type": 4,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 1,
            "is_list": 0
        },
        {
            "id": "3043781064",
            "name": "测试公司-tv-多行文本",
            "base": 0,
            "field_type": 2,
            "ext_info": null,
            "require": 0,
            "default": "123",
            "disable_flag": 1,
            "is_list": 0
        },
        {
            "id": "3113323380",
            "name": "Product group radio",
            "base": 0,
            "field_type": 3,
            "ext_info": [
                "单选1",
                "单选2",
                "add one new option"
            ],
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "1887817526",
            "name": "ccccc",
            "base": 0,
            "field_type": 1,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 1,
            "is_list": 0
        },
        {
            "id": "1118472446",
            "name": "OS Field",
            "base": 0,
            "field_type": 1,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": 3570150046,
            "name": "自定义字段0626下午",
            "base": 0,
            "field_type": 3,
            "ext_info": [
                "自定义字段0626下午1",
                "自定义字段0626下午2"
            ],
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": 3568031711,
            "name": "中文字段5",
            "base": 0,
            "field_type": 2,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "3043780965",
            "name": "下拉多选",
            "base": 0,
            "field_type": 7,
            "ext_info": [
                "test",
                "苹果",
                "雪梨",
                "kevinAdd",
                "yang",
                "huangzhengbang"
            ],
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "3082106510",
            "name": "测试公司-tv-文本",
            "base": 0,
            "field_type": 1,
            "ext_info": null,
            "require": 0,
            "default": "我是必填文本默认值",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": 3474261902,
            "name": "供应商数量",
            "base": 0,
            "field_type": 5,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": 3472848096,
            "name": "公司仓库数量",
            "base": 0,
            "field_type": 5,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "3307965519",
            "name": "test客户管理",
            "base": 0,
            "field_type": 7,
            "ext_info": [
                "2",
                "3",
                "1"
            ],
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "3082106514",
            "name": "测试公司-日期-tv",
            "base": 0,
            "field_type": 4,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 0,
            "is_list": 0
        },
        {
            "id": "3113338556",
            "name": "产品多行文本",
            "base": 0,
            "field_type": 2,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 1,
            "is_list": 0
        },
        {
            "id": "3137336748",
            "name": "新老客户类型",
            "base": 0,
            "field_type": 7,
            "ext_info": [
                "新客户",
                "老客户"
            ],
            "require": 0,
            "default": "",
            "disable_flag": 1,
            "is_list": 0
        },
        {
            "id": "1106335125",
            "name": "自定义字段-数值",
            "base": 0,
            "field_type": 5,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 1,
            "is_list": 0
        },
        {
            "id": "1118472445",
            "name": "字段名称 - os001",
            "base": 0,
            "field_type": 3,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 1,
            "is_list": 0
        },
        {
            "id": "3117881352",
            "name": "询盘产品-测试工单",
            "base": 0,
            "field_type": 7,
            "ext_info": [
                "洗衣片",
                "吸色片",
                "留香珠"
            ],
            "require": 0,
            "default": "",
            "disable_flag": 1,
            "is_list": 0
        },
        {
            "id": "3082106517",
            "name": "测试公司的下拉多选",
            "base": 0,
            "field_type": 7,
            "ext_info": [
                "Go",
                "I...",
                "Uh...",
                "People",
                "He"
            ],
            "require": 0,
            "default": "",
            "disable_flag": 1,
            "is_list": 0
        },
        {
            "id": "3025700946",
            "name": "客户老编号",
            "base": 0,
            "field_type": 1,
            "ext_info": null,
            "require": 0,
            "default": "我是默认值",
            "disable_flag": 1,
            "is_list": 0
        },
        {
            "id": "3082106518",
            "name": "测试公司-tv-日期时间",
            "base": 0,
            "field_type": 10,
            "ext_info": null,
            "require": 0,
            "default": "",
            "disable_flag": 1,
            "is_list": 0
        }
    ]
}
修改于 2025-07-16 05:56:05
上一页
移入公海
下一页
客户(含联系人)新增/编辑