纷享销客 API
  1. 合同对象对象接口
纷享销客 API
  • 企业内部应用开发
    • 开发流程介绍
    • 创建开放平台应用
    • 接口调用说明
    • 纷享免登
    • 全局返回码
    • 事件变更订阅
    • 身份验证
      • 获取用户级授权
        • 授权方式
        • 获取code
        • 通过code获取accessToken
        • 刷新 accessToken 有效期
      • 获取应用级授权
    • 应用免登
      • 企业内部应用免登
      • 获取code
      • 通过code获取用户信息
  • dubbo类接口
    • cgi/department/setStatus_post
    • cgi/user/setStatus_post
  • 通讯录接口
    • 人员接口
      • 查询员工信息
        • 根据Id查询员工信息
        • 根据手机号查询员工
        • 通过员工昵称查询
      • 根据手机号查询员工
      • 获取部门列表
      • 获取部门详情
      • 添加部门
      • 修改部门
      • 设置部门状态
      • 获取部门下成员信息(简略)
      • 获取部门下成员信息(详细)
      • 添加成员
      • 修改成员
      • 设置成员状态
      • 设置成员状态(批量)
      • 根据时间段分页查询修改的员工列表
    • 人员对象接口
      • 设置成员状态(批量)
      • 根据时间段分页查询修改的员工列表
      • 获取停用成员信息
      • 通过员工昵称查询
      • 根据手机号查询员工
      • 根据openUserId查询员工信息
      • 设置成员状态
      • 修改成员
      • 添加成员
      • 获取部门下成员信息
    • 部门接口
      • 设置部门状态
      • 修改部门
      • 添加部门
      • 获取部门详情
      • 获取部门列表
    • 用户组接口
      • 修改用户组用户(覆盖)
      • 获取用户组用户列表
      • 向用户组添加用户(增量)
      • 删除用户组
      • 添加用户组
      • 获取用户组列表
    • 人员角色接口
      • 批量设置用户的角色(覆盖)
      • 批量添加用户的角色(增量)
      • 删除指定角色的人员
      • 通过主角色获取对应的用户
      • 通过角色获取对应的用户
      • 获取用户对应的角色
      • 删除角色
      • 修改角色信息
      • 添加角色
      • 获取角色列表
  • CRM对象通用接口
    • 对象描述接口
      • 查询对象列表
      • 查询对象描述
    • 审批流程接口
      • 审批流当前任务驳回到前面的某个节点
      • 审批流查询当前实例可以驳回到哪个节点
      • 查询对象审批流实例
      • 审批流完成
      • 审批流程取消
      • 查询审批流实例列表
      • 查询审批流实例详情
      • 查询审批流任务数据
      • 查询审批流实例数据列表
      • 查询审批流实例数据列表
      • 获取审批流实例对象描述接口
      • 查询单个审批流任务对象详细信息
      • 获取审批流任务对象描述接口
    • 业务流程接口
      • 查询单个流程任务对象详细信息
      • 查询单个流程实例对象详细信息
      • 根据条件查询流程实例对象的列表
      • 获取流程实例对象描述接口
      • 获取业务流程实例下的任务
      • 完成带表单的业务流程任务
      • 获取业务流程任务详情
      • 完成审批类型的业务流程任务
      • 完成普通的业务流程任务
      • 审批流任务完成
    • 阶段推进器接口
      • 查询单个阶段的运行时信息对象
      • 根据条件查询阶段的运行时信息对象的列表
      • 获取阶段的运行时信息对象描述接口
      • 触发阶段推进器(非商机2.0)
      • 查询对象数据的上的流程实例信息
      • 通过阶段推进器实例修改阶段推进器阶段
    • 相关团队编辑
      • 相关团队编辑
      • 相关团队查询
      • 相关团队新增
      • 相关团队删除
    • 就锁锁定接口
      • 锁定对象
      • 解锁对象
    • 给数据打标签接口
    • 查询某个对象可用的标签接口
    • 查询数据修改记录接口
    • CRM日志查询
    • 获取国家省份地市选项代码
    • 调用自定义函数(仅支持控制器函数)
  • CRM对象接口
    • CRM对象接口调用说明
    • 自定义对象接口
      • 变更自定义对象负责人
      • 作废自定义对象
      • 删除自定义对象
      • 修改自定义对象
      • 创建自定义对象
      • 查询自定义对象列表
      • 查询自定义对象详情
    • 商品对象接口
      • 恢复已作废的商品对象信息
      • 创建商品对象
      • 修改商品对象信息修改商品对象信息
      • 删除已作废的商品对象信息
      • 作废商品对象信息
      • 获取商品对象描述接口
      • 根据条件查询商品对象的列表
      • 查询单个商品对象详细信息
      • 变更商品对象的负责人
    • 账户余额对象接口
      • 根据条件查询客户账户对象的列表
      • 查询单个客户账户对象详细信息
      • 获取客户账户对象描述接口
    • 活动方案项目
      • 修改预设对象
      • 查询预设对象列表
    • 活动方案
      • 修改预设对象
      • 查询预设对象列表
      • 作废预设对象
      • 创建预设对象
    • 活动举证
      • 查询预设对象列表
      • 创建预设对象
    • 活动协议
      • 创建预设对象
      • 修改预设对象
    • 活动项目管理
      • 修改预设对象
      • 查询预设对象列表
      • 作废预设对象
      • 创建预设对象
    • 活动协议项目
      • 修改预设对象
      • 查询预设对象列表
    • 活动举证项目
      • 修改预设对象
      • 查询预设对象列表
    • 流程任务对象接口
      • 根据条件查询流程任务对象的列表
      • 获取流程任务对象描述接口
    • 活动成员对象接口
      • 修改预设对象
      • 恢复预设对象
      • 查询预设对象列表
      • 作废预设对象
      • 查询预设对象详情
      • 变更预设对象负责人
      • 创建预设对象
      • 获取活动成员对象描述接口
    • 账户收支流水
      • 创建账户收支流水对象
      • 查询预设对象列表
      • 查询预设对象详情
    • 账户对象接口
      • 根据条件查询账户对象的列表
      • 查询单个账户对象
      • 获取账户对象描述接口
    • 客户对象接口
      • 根据条件查询公海对象的列表
      • 删除公海对象接口
      • 修改公海对象接口
      • 创建公海对象接口
      • 从公海移除客户
      • 退回客户到公海
      • 修改客户对象的成交状态
      • 修改客户对象信息
      • 恢复已作废的客户对象信息
      • 根据条件查询客户对象的列表
      • 作废客户对象信息
      • 查询单个客户对象详细信息
      • 删除已作废的客户对象信息
      • 变更客户对象的负责人
      • 创建客户对象
      • 获取客户对象描述接口
    • 联系人对象接口
      • 修改联系人对象信息
      • 恢复已作废的联系人对象信息
      • 作废联系人对象信息
      • 查询单个联系人对象详细信息
      • 删除已作废的联系人对象信息
      • 变更联系人对象的负责人
      • 创建联系人对象
      • 根据条件查询联系人对象的列表
      • 获取联系人对象描述接口
    • 产品对象接口
      • 获取产品分类树接口
      • 查询产品子分类
      • 编辑产品分类
      • 查询产品分类
      • 产品上下架
      • 恢复已作废的产品对象信息
      • 修改产品对象信息
      • 删除已作废的产品对象信息
      • 根据条件查询产品对象的列表
      • 作废产品对象信息
      • 查询单个产品对象详细信息
      • 创建产品对象
      • 变更产品对象的负责人
      • 获取产品对象描述接口
    • 产品单位对象接口
      • 修改产品单位对象信息
      • 恢复已作废的产品单位对象信息
      • 根据条件查询产品单位对象的列表
      • 作废产品单位对象信息
      • 查询单个产品单位对象详细信息
      • 删除已作废的产品单位对象信息
      • 变更产品单位对象的负责人
      • 创建产品单位对象
      • 获取产品单位对象描述接口
    • 产品分组对象接口
      • 根据条件查询产品分组对象的列表
      • 查询单个产品分组对象详细信息
      • 获取产品分组对象描述接口
    • 子产品明细对象接口
      • 修改子产品明细对象信息
      • 根据条件查询子产品明细对象的列表
      • 查询单个子产品明细对象详细信息
      • 创建子产品明细对象
      • 恢复已作废的子产品明细对象信息
      • 作废子产品明细对象信息
      • 删除已作废的子产品明细对象信息
      • 变更子产品明细对象的负责人
      • 获取子产品明细对象描述接口
    • 规则表对象接口
      • 恢复已作废的规格表对象信息
      • 修改规格表对象信息
      • 删除已作废的规格表对象信息
      • 根据条件查询规格表对象的列表
      • 作废规格表对象信息
      • 查询单个规格表对象详细信息
      • 创建规格表对象
      • 变更规格表对象的负责人
      • 获取规格表对象描述接口
    • 价格表对象接口
      • 查询价目表列表
      • 查询价目表列表
      • 设置价目表优先级
      • 修改价目表对象信息
      • 恢复已作废的价目表对象信息
      • 根据条件查询价目表对象的列表
      • 作废价目表对象信息
      • 查询单个价目表对象详细信息
      • 删除已作废的价目表对象信息
      • 变更价目表对象的负责人
      • PresentCreate
      • 获取价目表对象描述接口
    • 价目表格明细对象接口
      • 创建价目表明细对象
      • 修改价目表明细对象信息
      • 恢复已作废的价目表明细对象信息
      • 根据条件查询价目表明细对象的列表
      • 作废价目表明细对象信息
      • 查询单个价目表明细对象详细信息
      • 删除已作废的价目表明细对象信息
      • 变更价目表明细对象的负责人
      • 创建价目表明细对象
      • 获取价目表明细对象描述接口
    • 销售订单对象接口
      • 销售订单确认收货
      • 修改销售订单对象信息
      • 恢复已作废的销售订单对象信息
      • 作废销售订单对象信息
      • 查询单个销售订单对象详细信息
      • 删除已作废的销售订单对象信息
      • 变更销售订单对象的负责人
      • 创建销售订单对象
      • 根据条件查询销售订单对象的列表
      • 获取销售订单对象描述接口
    • 订单产品对象信息
      • 修改订单产品对象信息
      • 根据条件查询订单产品对象的列表
      • 查询单个订单产品对象详细信息
      • 获取订单产品对象描述接口
    • 客户地址对象接口
      • 设置客户地址设为默认客户地址
      • 设置客户地址设为主客户地址
      • 修改客户地址对象信息
      • 恢复已作废的客户地址对象信息
      • 根据条件查询客户地址对象的列表
      • 作废客户地址对象信息
      • 查询单个客户地址对象详细信息
      • 删除已作废的客户地址对象信息
      • 创建客户地址对象
      • 获取客户地址对象描述接口
    • 发货单产品对象接口
      • 修改发货单产品对象信息
      • 恢复已作废的发货单产品对象信息
      • 根据条件查询发货单产品对象的列表
      • 作废发货单产品对象信息
      • 查询单个发货单产品对象详细信息
      • 删除已作废的发货单产品对象信息
      • 变更发货单产品对象的负责人
      • 获取发货单产品对象描述接口
      • 创建发货单产品对象
    • 退款对象接口
      • 修改退款对象信息
      • 恢复已作废的退款对象信息
      • 根据条件查询退款对象的列表
      • 作废退款对象信息
      • 查询单个退款对象详细信息
      • 删除已作废的退款对象信息
      • 变更退款对象的负责人
      • 创建退款对象
      • 获取退款对象描述接口
    • 子产品分组对象接口
      • 修改子产品分组对象信息
      • 根据条件查询子产品分组对象的列表
      • 查询单个子产品分组对象详细信息
      • 创建子产品分组对象
      • 恢复已作废的子产品分组对象信息
      • 作废子产品分组对象信息
      • 删除已作废的子产品分组对象信息
      • 变更子产品分组对象的负责人
      • 获取子产品分组对象描述接口
    • 设备配件规格关系对象接口
      • 修改设备配件规格关系对象信息
      • 恢复已作废的设备配件规格关系对象信息
      • 根据条件查询设备配件规格关系对象的列表
      • 作废设备配件规格关系对象信息
      • 查询单个设备配件规格关系对象详细信息
      • 删除已作废的设备配件规格关系对象信息
      • 变更设备配件规格关系对象的负责人
      • 创建设备配件规格关系对象
      • 获取设备配件规格关系对象描述接口
    • 报价单明细对象接口
      • 修改报价单明细对象信息
      • 恢复已作废的报价单明细对象信息
      • 根据条件查询报价单明细对象的列表
      • 作废报价单明细对象信息
      • 查询单个报价单明细对象详细信息
      • 删除已作废的报价单明细对象信息
      • 变更报价单明细对象的负责人
      • 获取报价单明细对象描述接口
      • 创建报价单明细对象
    • 商机联系人对象接口
      • 变更商机联系人对象的负责人
      • 恢复已作废的商机联系人对象信息
      • 作废商机联系人对象信息
      • 删除已作废的商机联系人对象信息
      • 修改商机联系人对象信息
      • 创建商机联系人对象
      • 根据条件查询商机联系人对象的列表
      • 查询单个商机联系人对象详细信息
      • 获取商机联系人对象描述接口
    • 商机2.0对象接口
      • 修改商机2.0对象信息
      • 恢复已作废的商机2.0对象信息
      • 根据条件查询商机2.0对象的列表
      • 作废商机2.0对象信息
      • 查询单个商机2.0对象详细信息
      • 删除已作废的商机2.0对象信息
      • 变更商机2.0对象的负责人
      • 创建商机2.0对象
      • 获取商机2.0对象描述接口
      • 获取商机2.0对象描述接口
    • 商机2.0明细对象接口
      • 修改商机2.0明细对象信息
      • 恢复已作废的商机2.0明细对象信息
      • 根据条件查询商机2.0明细对象的列表
      • 作废商机2.0明细对象信息
      • 查询单个商机2.0明细对象详细信息
      • 删除已作废的商机2.0明细对象信息
      • 变更商机2.0明细对象的负责人
      • 创建商机2.0明细对象
      • 获取商机2.0明细对象描述接口
    • 回款计划对象接口
      • 修改回款计划对象信息
      • 恢复已作废的回款计划对象信息
      • 根据条件查询回款计划对象的列表
      • 作废回款计划对象信息
      • 查询单个回款计划对象详细信息
      • 删除已作废的回款计划对象信息
      • 变更回款计划对象的负责人
      • 创建回款计划对象
      • 获取回款计划对象描述接口
    • 通话记录对象接口
      • 创建通话记录
      • 根据条件查询通话记录对象的列表
      • 查询单个通话记录对象详细信息
      • 创建通话记录对象
      • 获取通话记录对象描述接口
    • 产品选配明细对象接口
      • 根据条件查询产品选配明细对象的列表
      • 查询单个产品选配明细对象详细信息
      • 获取产品选配明细对象描述接口
    • 退料单产品对象接口
      • 修改退料单产品对象信息
      • 根据条件查询退料单产品对象的列表
      • 查询单个退料单产品对象详细信息
      • 获取退料单产品对象描述接口
    • 信用对象接口
      • 恢复已作废的信用对象信息
      • 修改信用对象信息
      • 删除已作废的信用对象信息
      • 根据条件查询信用对象的列表
      • 作废信用对象信息
      • 查询单个信用对象详细信息
      • 创建信用对象
      • 变更信用对象的负责人
      • 获取信用对象描述接口
    • 库存对象接口
      • 恢复已作废的库存对象信息
      • 修改库存对象信息
      • 删除已作废的库存对象信息
      • 根据条件查询库存对象的列表
      • 作废库存对象信息
      • 查询单个库存对象详细信息
      • 创建库存对象
      • 变更库存对象的负责人
      • 获取库存对象描述接口
    • 出入库明细对象接口
      • 修改出入库明细对象信息
      • 根据条件查询出入库明细对象的列表
      • 查询单个出入库明细对象详细信息
      • 创建出入库明细对象
      • 恢复已作废的出入库明细对象信息
      • 作废出入库明细对象信息
      • 删除已作废的出入库明细对象信息
      • 变更出入库明细对象的负责人
      • 获取出入库明细对象描述接口
    • 出库单对象接口
      • 修改出库单对象信息
      • 根据条件查询出库单对象的列表
      • 查询单个出库单对象详细信息
      • 创建出库单对象
      • 恢复已作废的出库单对象信息
      • 作废出库单对象信息
      • 删除已作废的出库单对象信息
      • 变更出库单对象的负责人
      • 获取出库单对象描述接口
    • 出库单产品对象接口
      • 修改出库单产品对象信息
      • 根据条件查询出库单产品对象的列表
      • 查询单个出库单产品对象详细信息
      • 创建出库单产品对象
      • 恢复已作废的出库单产品对象信息
      • 作废出库单产品对象信息
      • 删除已作废的出库单产品对象信息
      • 变更出库单产品对象的负责人
      • 获取出库单产品对象描述接口
    • 入库单对象接口
      • 修改入库单对象信息
      • 根据条件查询入库单对象的列表
      • 查询单个入库单对象详细信息
      • 创建入库单对象
      • 恢复已作废的入库单对象信息
      • 删除已作废的入库单对象信息
      • 作废入库单对象信息
      • 变更入库单对象的负责人
      • 获取入库单对象描述接口
    • 供应商对象接口
      • 修改供应商对象信息
      • 根据条件查询供应商对象的列表
      • 查询单个供应商对象详细信息
      • 创建供应商对象
      • 恢复已作废的供应商对象信息
      • 作废供应商对象信息
      • 删除已作废的供应商对象信息
      • 变更供应商对象的负责人
      • 获取供应商对象描述接口
    • 入库单产品对象接口
      • 修改入库单产品对象信息
      • 根据条件查询入库单产品对象的列表
      • 查询单个入库单产品对象详细信息
      • 创建入库单产品对象
      • 恢复已作废的入库单产品对象信息
      • 作废入库单产品对象信息
      • 删除已作废的入库单产品对象信息
      • 变更入库单产品对象的负责人
      • 获取入库单产品对象描述接口
    • 仓库对象接口
      • 恢复已作废的仓库对象信息
      • 修改仓库对象信息
      • 删除已作废的仓库对象信息
      • 根据条件查询仓库对象的列表
      • 作废仓库对象信息
      • 查询单个仓库对象详细信息
      • 创建仓库对象
      • 变更仓库对象的负责人
      • 获取仓库对象描述接口
    • 盘点单产品对象接口
      • 修改盘点单产品对象信息
      • 根据条件查询盘点单产品对象的列表
      • 查询单个盘点单产品对象详细信息
      • 创建盘点单产品对象
      • 恢复已作废的盘点单产品对象信息
      • 作废盘点单产品对象信息
      • 删除已作废的盘点单产品对象信息
      • 变更盘点单产品对象的负责人
      • 获取盘点单产品对象描述接口
    • 会员等级对象接口
      • 根据条件查询会员等级对象的列表
      • 获取会员等级对象描述接口
    • 会员积分明细对象接口
      • 恢复已作废的会员积分明细对象信息
      • 根据条件查询会员积分明细对象的列表
      • 作废会员积分明细对象信息
      • 查询单个会员积分明细对象详细信息
      • 删除已作废的会员积分明细对象信息
      • 创建会员积分明细对象
      • 获取会员积分明细对象描述接口
    • 工作圈回复对象接口
      • 修改工作圈回复对象信息
      • 根据条件查询工作圈回复对象的列表
      • 查询单个工作圈回复对象详细信息
      • 创建工作圈回复对象
      • 获取工作圈回复对象描述接口
    • 目标子规则对象接口
      • 根据条件查询子规则对象的列表
      • 获取子规则对象描述接口
    • 退款单对象接口
      • 修改退款单对象信息
      • 恢复已作废的退款单对象信息
      • 根据条件查询退款单对象的列表
      • 作废退款单对象信息
      • 查询单个退款单对象详细信息
      • 删除已作废的退款单对象信息
      • 变更退款单对象的负责人
      • 创建退款单对象
      • 获取退款单对象描述接口
    • 设备对象接口
      • 修改设备对象信息
      • 恢复已作废的设备对象信息
      • 根据条件查询设备对象的列表
      • 作废设备对象信息
      • 查询单个设备对象详细信息
      • 删除已作废的设备对象信息
      • 变更设备对象的负责人
      • 创建设备对象
      • 获取设备对象描述接口
    • 回款明细对象
      • 根据条件查询回款明细对象的列表
      • 查询单个回款明细对象详细信息
      • 获取回款明细对象描述接口
    • 规格值表对象接口
      • 恢复已作废的规格值表对象信息
      • 修改规格值表对象信息
      • 删除已作废的规格值表对象信息
      • 根据条件查询规格值表对象的列表
      • 作废规格值表对象信息
      • 查询单个规格值表对象详细信息
      • 创建规格值表对象
      • 变更规格值表对象的负责人
      • 获取规格值表对象描述接口
    • 高级外勤对象对象接口
      • 获取高级外勤数据列表
      • 获取高级外勤数据详情
      • 修改高级外勤对象信息
      • 获取高级外勤对象描述接口
    • 会员成长值明细对象接口
      • 恢复已作废的会员成长值明细对象信息
      • 根据条件查询会员成长值明细对象的列表
      • 作废会员成长值明细对象信息
      • 查询单个会员成长值明细对象详细信息
      • 删除已作废的会员成长值明细对象信息
      • 创建会员成长值明细对象
      • 获取会员成长值明细对象描述接口
    • 返利对象接口
      • 修改返利对象信息
      • 恢复已作废的返利对象信息
      • 根据条件查询返利对象的列表
      • 作废返利对象信息
      • 查询单个返利对象详细信息
      • 删除已作废的返利对象信息
      • 变更返利对象的负责人
      • 创建返利对象
      • 获取返利对象描述接口
    • 市场活动对象接口
      • 修改市场活动对象信息
      • 根据条件查询市场活动对象的列表
      • 查询单个市场活动对象详细信息
      • 创建市场活动对象
      • 获取市场活动对象描述接口
    • 线索转换日志对象接口
      • 根据条件查询线索转换日志对象的列表
      • 获取线索转换日志对象描述接口
    • 批次库存对象接口
      • 恢复已作废的批次库存对象信息
      • 修改批次库存对象信息
      • 删除已作废的批次库存对象信息
      • 根据条件查询批次库存对象的列表
      • 作废批次库存对象信息
      • 查询单个批次库存对象详细信息
      • 创建批次库存对象
      • 变更批次库存对象的负责人
      • 获取批次库存对象描述接口
    • 工单设备对象接口
      • 修改工单设备对象信息
      • 根据条件查询工单设备对象的列表
      • 查询单个工单设备对象详细信息
      • 创建工单设备对象
      • 恢复已作废的工单设备对象信息
      • 作废工单设备对象信息
      • 删除已作废的工单设备对象信息
      • 变更工单设备对象的负责人
      • 获取工单设备对象描述接口
    • ERP仓库对象接口
      • 变更ERP仓库对象的负责人
      • 恢复已作废的ERP仓库对象信息
      • 作废ERP仓库对象信息
      • 根据条件查询ERP仓库对象的列表
      • 查询单个ERP仓库对象详细信息
      • 创建ERP仓库对象
      • 获取ERP仓库对象描述接口
    • 获取ERP仓库对选哪个描述接口
      • 恢复已作废的序列号对象信息
      • 修改序列号对象信息
      • 删除已作废的序列号对象信息
      • 根据条件查询序列号对象的列表
      • 作废序列号对象信息
      • 查询单个序列号对象详细信息
      • 创建序列号对象
      • 变更序列号对象的负责人
      • 获取序列号对象描述接口
    • 盘点单对象接口
      • 修改盘点单对象信息
      • 根据条件查询盘点单对象的列表
      • 查询单个盘点单对象详细信息
      • 创建盘点单对象
      • 恢复已作废的盘点单对象信息
      • 作废盘点单对象信息
      • 删除已作废的盘点单对象信息
      • 变更盘点单对象的负责人
      • 获取盘点单对象描述接口
    • 退换货单对象接口
      • 修改退换货单对象信息
      • 恢复已作废的退换货单对象信息
      • 根据条件查询退换货单对象的列表
      • 作废退换货单对象信息
      • 查询单个退换货单对象详细信息
      • 删除已作废的退换货单对象信息
      • 变更退换货单对象的负责人
      • 创建退换货单对象
      • 获取退换货单对象描述接口
    • 领料单产品对象接口
      • 修改领料单产品对象信息
      • 根据条件查询领料单产品对象的列表
      • 查询单个领料单产品对象详细信息
      • 获取领料单产品对象描述接口
    • 采购订单对象接口
      • 修改采购订单对象信息
      • 根据条件查询采购订单对象的列表
      • 查询单个采购订单对象详细信息
      • 创建采购订单对象
      • 恢复已作废的采购订单对象信息
      • 作废采购订单对象信息
      • 删除已作废的采购订单对象信息
      • 变更采购订单对象的负责人
      • 获取采购订单对象描述接口
    • 退货单关联的产品对象接口
      • 根据条件查询退货单关联的产品对象的列表
      • 查询单个退货单关联的产品对象详细信息
      • 获取退货单关联的产品对象描述接口
    • 报价单对象接口
      • 修改报价单对象信息
      • 恢复已作废的报价单对象信息
      • 根据条件查询报价单对象的列表
      • 作废报价单对象信息
      • 查询单个报价单对象详细信息
      • 删除已作废的报价单对象信息
      • 变更报价单对象的负责人
      • 创建报价单对象
      • 获取报价单对象描述接口
    • 目标规则适用部门对象接口
      • 根据条件查询规则适用部门对象的列表
      • 获取规则适用部门对象描述接口
    • 调拨单产品对象接口
      • 修改调拨单产品对象信息
      • 根据条件查询调拨单产品对象的列表
      • 查询单个调拨单产品对象详细信息
      • 创建调拨单产品对象
      • 恢复已作废的调拨单产品对象信息
      • 作废调拨单产品对象信息
      • 删除已作废的调拨单产品对象信息
      • 变更调拨单产品对象的负责人
      • 获取调拨单产品对象描述接口
    • 促销产品对象接口
      • 修改促销产品对象信息
      • 根据条件查询促销产品对象的列表
      • 作废促销产品对象信息
      • 查询单个促销产品对象详细信息
      • 删除已作废的促销产品对象信息
      • 创建促销产品对象
      • 获取促销产品对象描述接口
    • 采购订单产品对象接口
      • 修改采购订单产品对象信息
      • 根据条件查询采购订单产品对象的列表
      • 查询单个采购订单产品对象详细信息
      • 创建采购订单产品对象
      • 恢复已作废的采购订单产品对象信息
      • 作废采购订单产品对象信息
      • 删除已作废的采购订单产品对象信息
      • 变更采购订单产品对象的负责人
      • 获取采购订单产品对象描述接口
    • 电销记录对象接口
      • 修改电销记录对象信息
      • 根据条件查询电销记录对象的列表
      • 作废电销记录对象信息
      • 查询单个电销记录对象详细信息
      • 删除已作废的电销记录对象信息
      • 创建电销记录对象
      • 获取电销记录对象描述接口
    • 促销规则对象接口
      • 修改促销规则对象信息
      • 根据条件查询促销规则对象的列表
      • 作废促销规则对象信息
      • 查询单个促销规则对象详细信息
      • 删除已作废的促销规则对象信息
      • 创建促销规则对象
      • 获取促销规则对象描述接口
    • 批次对象接口
      • 恢复已作废的批次对象信息
      • 修改批次对象信息
      • 删除已作废的批次对象信息
      • 根据条件查询批次对象的列表
      • 作废批次对象信息
      • 查询单个批次对象详细信息
      • 创建批次对象
      • 变更批次对象的负责人
      • 获取批次对象描述接口
    • 退货单对象接口
      • 修改退货单对象信息
      • 恢复已作废的退货单对象信息
      • 根据条件查询退货单对象的列表
      • 作废退货单对象信息
      • 查询单个退货单对象详细信息
      • 删除已作废的退货单对象信息
      • 变更退货单对象的负责人
      • 创建退货单对象
      • 获取退货单对象描述接口
    • 销售记录对象接口
      • 获取销售记录类型
      • 恢复已作废的销售记录对象信息
      • 根据条件查询销售记录对象的列表
      • 作废销售记录对象信息
      • 查询单个销售记录对象详细信息
      • 删除已作废的销售记录对象信息
      • 变更销售记录对象的负责人
      • 创建销售记录对象
      • 获取销售记录对象描述接口
    • 微信分析对象接口
      • 根据条件查询微信粉丝对象的列表
      • 查询单个微信粉丝对象详细信息
      • 获取微信粉丝对象描述接口
    • 发货单对象接口
      • 发货单对象增量更新接口
      • 发货单确认发货
      • 恢复已作废的发货单对象信息
      • 修改发货单对象信息
      • 删除已作废的发货单对象信息
      • 根据条件查询发货单对象的列表
      • 作废发货单对象信息
      • 查询单个发货单对象详细信息
      • 创建发货单对象
      • 变更发货单对象的负责人
      • 获取发货单对象描述接口
    • 会员对象接口
      • 修改会员对象信息
      • 恢复已作废的会员对象信息
      • 根据条件查询会员对象的列表
      • 作废会员对象信息
      • 查询单个会员对象详细信息
      • 删除已作废的会员对象信息
      • 变更会员对象的负责人
      • 创建会员对象
      • 获取会员对象描述接口
    • 财务信息对象接口
      • 设置财务信息设为默认
      • 修改财务信息对象信息
      • 恢复已作废的财务信息对象信息
      • 根据条件查询财务信息对象的列表
      • 作废财务信息对象信息
      • 查询单个财务信息对象详细信息
      • 删除已作废的财务信息对象信息
      • 创建财务信息对象
      • 获取财务信息对象描述接口
    • 销售活动对象接口
      • 根据条件查询销售活动对象的列表
      • 查询单个销售活动对象详细信息
      • 获取销售活动对象描述接口
    • 促销对象接口
      • 修改促销对象信息
      • 根据条件查询促销对象的列表
      • 作废促销对象信息
      • 查询单个促销对象详细信息
      • 创建促销对象
      • 获取促销对象描述接口
    • 合同对象对象接口
      • 修改合同对象对象信息
        POST
      • 恢复已作废的合同对象对象信息
        POST
      • 根据条件查询合同对象对象的列表
        POST
      • 作废合同对象对象信息
        POST
      • 查询单个合同对象对象详细信息
        POST
      • 删除已作废的合同对象对象信息
        POST
      • 变更合同对象对象的负责人
        POST
      • 创建合同对象对象
        POST
      • 获取合同对象对象描述接口
        POST
    • 领料单对象接口
      • 修改领料单对象信息
      • 根据条件查询领料单对象的列表
      • 查询单个领料单对象详细信息
      • 创建领料单对象
      • 恢复已作废的领料单对象信息
      • 作废领料单对象信息
      • 删除已作废的领料单对象信息
      • 变更领料单对象的负责人
      • 获取领料单对象描述接口
    • 商机对象接口
      • 商机变更销售阶段
      • 商机切换销售流程
      • 修改商机对象信息
      • 恢复已作废的商机对象信息
      • 根据条件查询商机对象的列表
      • 作废商机对象信息
      • 查询单个商机对象详细信息
      • 删除已作废的商机对象信息
      • 变更商机对象的负责人
      • 创建商机对象
      • 获取商机对象描述接口
    • 回款对象接口
      • 恢复已作废的回款对象信息
      • 修改回款对象信息
      • 删除已作废的回款对象信息
      • 根据条件查询回款对象的列表
      • 作废回款对象信息
      • 查询单个回款对象详细信息
      • 创建回款对象
      • 变更回款对象的负责人
      • 获取回款对象描述接口
    • ERP库存对象接口
      • 变更ERP库存对象的负责人
      • 恢复已作废的ERP库存对象信息
      • 作废ERP库存对象信息
      • 根据条件查询ERP库存对象的列表
      • 查询单个ERP库存对象详细信息
      • 创建ERP库存对象
      • 获取ERP库存对象描述接口
    • 部门对象接口
      • 更新部门状态为停用接口
      • 更新部门状态为启用接口
      • 更新部门对象信息接口
      • 修改部门对象信息
      • 根据条件查询部门对象的列表
      • 查询单个部门对象详细信息
      • 删除已作废的部门对象信息
      • 创建部门对象
      • 获取部门对象描述接口
    • 退换货单产品对象接口
      • 修改退换货单产品对象信息
      • 恢复已作废的退换货单产品对象信息
      • 对返回码的文本描述内容
      • 作废退换货单产品对象信息
      • 查询单个退换货单产品对象详细信息
      • 删除已作废的退换货单产品对象信息
      • 变更退换货单产品对象的负责人
      • 创建退换货单产品对象
      • 获取退换货单产品对象描述接口
    • 可售范围对象接口
      • 修改可售范围对象信息
      • 查询单个可售范围对象详细信息
      • 创建可售范围对象
      • 根据条件查询可售范围对象的列表
      • 获取可售范围对象描述接口
    • 可售客户对象接口
      • 根据条件查询可售客户对象的列表
      • 查询单个可售客户对象详细信息
      • 创建可售客户对象
      • 获取可售客户对象描述接口
    • 可售价目表对象接口
      • 根据条件查询可售价目表对象的列表
      • 查询单个可售价目表对象详细信息
      • 创建可售价目表对象
      • 获取可售价目表对象描述接口
    • 可售产品表对象接口
      • 根据条件查询可售产品表对象的列表
      • 查询单个可售产品表对象详细信息
      • 创建可售产品表对象
      • 获取可售产品表对象描述接口
    • 开票申请对象接口
      • 修改开票申请对象信息
      • 恢复已作废的开票申请对象信息
      • 根据条件查询开票申请对象的列表
      • 作废开票申请对象信息
      • 查询单个开票申请对象详细信息
      • 删除已作废的开票申请对象信息
      • 变更开票申请对象的负责人
      • 创建开票申请对象
      • 获取开票申请对象描述接口
    • 预存对象接口
      • 修改预存款对象信息
      • 恢复已作废的预存款对象信息
      • 根据条件查询预存款对象的列表
      • 作废预存款对象信息
      • 查询单个预存款对象详细信息
      • 删除已作废的预存款对象信息
      • 变更预存款对象的负责人
      • 创建预存款对象
      • 获取预存款对象描述接口
    • 合作伙伴对象接口
      • 修改合作伙伴对象信息
      • 根据条件查询合作伙伴对象的列表
      • 查询单个合作伙伴对象详细信息
      • 创建合作伙伴对象
      • 恢复已作废的合作伙伴对象信息
      • 作废合作伙伴对象信息
      • 删除已作废的合作伙伴对象信息
      • 变更合作伙伴对象的负责人
      • 获取合作伙伴对象描述接口
    • 调拨单对象接口
      • 修改调拨单对象信息
      • 根据条件查询调拨单对象的列表
      • 查询单个调拨单对象详细信息
      • 创建调拨单对象
      • 恢复已作废的调拨单对象信息
      • 作废调拨单对象信息
      • 删除已作废的调拨单对象信息
      • 变更调拨单对象的负责人
      • 获取调拨单对象描述接口
    • 人员对象接口
      • 修改人员对象信息
      • 根据条件查询人员对象的列表
      • 查询单个人员对象详细信息
      • 变更人员对象的负责人
      • 创建人员对象
      • 获取人员对象描述接口
    • 返利支出对象接口
      • 根据条件查询返利支出对象的列表
      • 查询单个返利支出对象详细信息
      • 获取返利支出对象描述接口
    • 线索对象接口
      • 从线索池(公海)领取线索(客户)
      • 退回线索到线索池
      • 转移线索(客户)
      • 线索转换
      • 分配线索
      • 修改线索对象信息
      • 恢复已作废的线索对象信息
      • 根据条件查询线索对象的列表
      • 作废线索对象信息
      • 查询单个线索对象详细信息
      • 删除已作废的线索对象信息
      • 变更线索对象的负责人
      • 预设对象创建
      • 获取线索对象描述接口
    • 开票申请明细对象接口
      • 根据条件查询开票申请明细对象的列表
      • 查询单个开票申请明细对象详细信息
      • 获取开票申请明细对象描述接口
    • 目标值对象接口
      • 查询目标规则
      • 修改目标值对象信息
      • 恢复已作废的目标值对象信息
      • 根据条件查询目标值对象的列表
      • 作废目标值对象信息
      • 查询单个目标值对象详细信息
      • 删除已作废的目标值对象信息
      • 变更目标值对象的负责人
      • 创建目标值对象
      • 获取目标值对象描述接口
    • 工单对象接口
      • 修改工单对象信息
      • 恢复已作废的工单对象信息
      • 根据条件查询工单对象的列表
      • 作废工单对象信息
      • 查询单个工单对象详细信息
      • 删除已作废的工单对象信息
      • 变更工单对象的负责人
      • 创建工单对象
      • 获取工单对象描述接口
    • 退料单对象接口
      • 修改退料单对象信息
      • 根据条件查询退料单对象的列表
      • 查询单个退料单对象详细信息
      • 创建退料单对象
      • 恢复已作废的退料单对象信息
      • 作废退料单对象信息
      • 删除已作废的退料单对象信息
      • 变更退料单对象的负责人
      • 获取退料单对象描述接口
    • Bom对象对象接口
      • 查询Bom树
      • 创建Bom树
      • 创建Bom树
      • 查询Bom树
    • 日程对象接口
      • 作废日程对象信息
      • 修改日程对象信息
      • 恢复已作废的日程对象信息
      • 根据条件查询日程对象的列表
      • 查询单个日程对象
      • 变更日程对象的负责人
      • 创建日程对象
      • 获取日程对象描述接口
    • 客户账户余额对象接口
      • 根据条件查询客户账户余额对象的列表
      • 查询单个客户账户余额对象
      • 获取客户账户余额对象描述接口
    • 线索跟进记录对象接口
      • 根据条件查询线索跟进记录对象的列表
      • 查询单个线索跟进记录对象
      • 获取线索跟进记录对象描述接口
    • 行为记录对象接口
      • 根据条件查询行为记录对象的列表
      • 查询单个行为记录对象详细信息
      • 获取行为记录对象描述接口
    • 销售员合同对象接口
      • 修改销售合同对象信息
      • 根据条件查询销售合同对象的列表
      • 查询单个销售合同对象
      • 变更销售合同对象的负责人
      • 创建销售合同对象
      • 获取销售合同对象描述接口
    • 服务评价对象接口
      • 修改服务评价对象信息
      • 根据条件查询服务评价对象的列表
      • 作废服务评价对象信息
      • 查询单个服务评价对象
      • 删除已作废的服务评价对象
      • 变更服务评价对象的负责人
      • 创建服务评价对象
      • 获取服务评价对象描述接口
    • 通话记录对象接口
      • 修改通话记录对象信息
      • 删除已作废的通话记录对象
    • 路线对象接口
      • 修改路线对象信息
      • 根据条件查询路线对象的列表
      • 查询单个路线对象
      • 删除已作废的路线对象
      • 创建路线对象
      • 获取路线对象描述接口
    • 多单位计算接口
      POST
    • 获取促销活动对象描述接口
      POST
    • 变更行为记录对象的负责人
      POST
    • 恢复已作废的行为记录对象信息
      POST
    • 作废行为记录对象信息
      POST
    • 删除已作废的行为记录对象
      POST
  • 其他接口
    • 任务代办接口
      • 设置企信状态为请假
      • 设置企信状态为撤销请假
      • 获取个人的已办列表
      • 获取个人的待办信息
      • 获取待办各个业务漂点漂数
    • 考勤外勤接口
      • 考勤外勤
        • 获取考勤数据列表
        • 获取外勤数据列表
        • 获取高级外勤数据描述
        • 获取高级外勤数据列表
        • 获取高级外勤数据详情
        • 获取外勤类型
        • 创建外勤计划
      • 保存外勤路线接口
    • 协同审批
      • 获取审批类型列表
      • 获取审批列表
      • 获取审批详情
    • 企业互联接口
      • 互联身份验证
        • 互联身份验证
        • 获取下游企业信息
      • 获取下游企业绑定信息
    • 消息发送接口
      • 发送消息
        • 发送消息
        • 发送复合消息
        • 发送图文消息
      • 应用挂机服务号发消息
        • 发送文本消息
        • 发送复合消息
        • 发送图文消息
      • 素材管理接口
        • 素材管理
        • 上传素材文件
          • 上传CRM素材文件
          • 上传消息素材文件
        • 下载素材文件
        • 删除素材文件
      • ERP库存接口
        • 查询Erp对象列表
        • 查询Erp对象详情
        • 修改Erp对象
        • 创建Erp对象
        • 恢复Erp对象
        • 作废Erp对象
        • 变更Erp对象负责人
        • 删除Erp对象
      • ERP仓库接口
        • 查询Erp对象详情
        • 查询Erp对象列表
        • 修改Erp对象
        • 删除Erp对象
        • 创建Erp对象
        • 恢复Erp对象
        • 作废Erp对象
        • 变更Erp对象负责人
      • 网盘接口
        • 上传文件到网盘接口
        • 创建网盘目录接口
      • 老接口文档
        • CRM对象接口(预设对象)
          • CRM对象接口-预设对象
          • 更新对象数据
          • 查询对象数据列表
          • 根据Id查询数据详情
          • 根据Id作废对象数据
          • 根据Id恢复对象数据
          • 根据Id删除对象数据
          • 变更负责人
        • CRM对象接口(自定义对象)
          • 新增对象数据
          • 更新对象数据
          • 查询对象数据列表
          • 根据Id查询数据详情
          • 根据Id作废对象数据
          • 根据Id恢复对象数据
          • 根据Id删除对象数据
          • 变更负责人
      • 获取纷享服务器IP地址​
  • 客户端开发
    • 客户端接入指南
    • 概述
    • Getting Started
    • 调试工具
    • JavaScript API
      • 容器
      • 设备
      • 启动器
      • Webview
      • 弹层
      • 纷享服务
      • 媒体
      • 通用
    • UI组件
      • 基础类库
      • 表单
      • 弹层
    • 附录
      • 接口汇总
      • 错误码汇总
      • FAQ
    • 获取 JsapiTicket
  • 下线接口
    • 删除预设对象
    • 查询预设对象列表
    • 作废预设对象
  1. 合同对象对象接口

获取合同对象对象描述接口

POST
https://open.fxiaoke.com/cgi/crm/v2/object/describe
​ 接口说明:获取合同对象对象的表结构、数据类型等信息。关于此接口的详细介绍请参见description接口说明。接口说明。
此接口对应的返回值即为对象相关字段信息(非字段值),详情见description接口说明。 返回错误代码请参见。全局返回错误码
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open.fxiaoke.com/cgi/crm/v2/object/describe' \
--header 'Content-Type: application/json' \
--data-raw '{
  "corpAccessToken": "${corpAccessToken}",
  "corpId": "${corpId}",
  "currentOpenUserId": "${currentOpenUserId}",
  "includeDetail": true,
  "apiName": "ContractObj"
}'
响应示例响应示例
{
  "traceId": "E-O.fktest188.1453-8bd67dcc13c44e5d",
  "data": {
    "describe": {
      "api_name": "ContractObj",
      "display_name_r": "合同",
      "fields": {
        "contract_amount": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422868,
          "length": 14,
          "description": "合同金额(元)",
          "is_unique": false,
          "label": "合同金额(元)",
          "type": "currency",
          "currency_unit": "¥",
          "decimal_places": 2,
          "is_need_convert": false,
          "is_required": true,
          "api_name": "contract_amount",
          "define_type": "package",
          "is_single": false,
          "label_r": "合同金额",
          "is_index_field": false,
          "index_name": "d_1",
          "config": {
            "edit": 1,
            "attrs": {
              "wheres": 1,
              "is_required": 0,
              "default_value": 1,
              "label": 1,
              "help_text": 1,
              "max_length": 1,
              "decimal_places": 1
            }
          },
          "round_mode": 4,
          "max_length": 16
        },
        "lock_rule": {
          "describe_api_name": "ContractObj",
          "is_index": false,
          "is_active": true,
          "create_time": 1560615275557,
          "description": "锁定规则",
          "is_unique": false,
          "default_value": "default_lock_rule",
          "rules": [],
          "label": "锁定规则",
          "type": "lock_rule",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "lock_rule",
          "define_type": "package",
          "is_index_field": false,
          "is_single": false,
          "index_name": "s_4"
        },
        "expired_time": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422868,
          "description": "截止日期",
          "is_unique": false,
          "label": "截止日期",
          "time_zone": "GMT+8",
          "type": "date",
          "is_need_convert": false,
          "is_required": true,
          "api_name": "expired_time",
          "define_type": "package",
          "date_format": "yyyy-MM-dd",
          "is_index_field": false,
          "is_single": false,
          "label_r": "截止日期",
          "config": {
            "edit": 1,
            "enable": 1,
            "attrs": {
              "wheres": 1,
              "default_value": 1,
              "label": 1,
              "help_text": 1
            }
          },
          "index_name": "l_1"
        },
        "UDTel1__c": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422868,
          "pattern": "^[0-9+\\-;,]{0,100}$",
          "description": "自定义电话",
          "is_unique": false,
          "label": "自定义电话",
          "type": "phone_number",
          "field_num": 321,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDTel1__c",
          "define_type": "custom",
          "is_extend": true,
          "is_index_field": false,
          "is_single": false,
          "index_name": "p_1"
        },
        "lock_user": {
          "describe_api_name": "ContractObj",
          "is_index": false,
          "is_active": true,
          "create_time": 1560615275557,
          "description": "加锁人",
          "is_unique": false,
          "label": "加锁人",
          "type": "employee",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "lock_user",
          "define_type": "package",
          "is_index_field": false,
          "is_single": true,
          "index_name": "a_1"
        },
        "UDInt1__c": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422868,
          "length": 16,
          "description": "自定义整数",
          "is_unique": false,
          "label": "自定义整数",
          "type": "number",
          "decimal_places": 0,
          "field_num": 101,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDInt1__c",
          "define_type": "custom",
          "is_extend": true,
          "is_single": false,
          "is_index_field": false,
          "index_name": "d_3",
          "round_mode": 4,
          "max_length": 16
        },
        "UDAttach1__c": {
          "describe_api_name": "ContractObj",
          "file_amount_limit": 10,
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422868,
          "description": "自定义附件",
          "is_unique": false,
          "label": "自定义附件",
          "type": "file_attachment",
          "field_num": 356,
          "file_size_limit": 10485760,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDAttach1__c",
          "define_type": "custom",
          "is_extend": true,
          "is_index_field": false,
          "is_single": false,
          "index_name": "a_2",
          "support_file_types": []
        },
        "L1_UDCSSel1__c": {
          "describe_api_name": "ContractObj",
          "is_index": false,
          "is_active": true,
          "create_time": 1559314235637,
          "description": "自定义二级级联",
          "is_unique": false,
          "label": "自定义二级级联",
          "type": "select_one",
          "field_num": 397,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "L1_UDCSSel1__c",
          "options": [
            {
              "not_usable": false,
              "child_options": [
                {
                  "UDCSSel1__c": [
                    "2",
                    "3"
                  ]
                }
              ],
              "label": "一级选项",
              "value": "1",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            }
          ],
          "define_type": "custom",
          "is_extend": true,
          "is_index_field": false,
          "is_single": false,
          "index_name": "s_2",
          "config": {}
        },
        "UDSSel1__c": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422901,
          "description": "自定义单选",
          "is_unique": false,
          "label": "自定义单选",
          "type": "select_one",
          "field_num": 181,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDSSel1__c",
          "options": [
            {
              "label": "选项一",
              "value": "1",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            },
            {
              "label": "选项二",
              "value": "2",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            }
          ],
          "define_type": "custom",
          "is_extend": true,
          "is_index_field": false,
          "is_single": false,
          "index_name": "s_9",
          "config": {}
        },
        "extend_obj_data_id": {
          "describe_api_name": "ContractObj",
          "default_is_expression": false,
          "is_index": false,
          "is_active": true,
          "create_time": 1523348160460,
          "pattern": "",
          "description": "extend_obj_data_id",
          "is_unique": false,
          "default_value": "",
          "label": "extend_obj_data_id",
          "type": "text",
          "default_to_zero": false,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "extend_obj_data_id",
          "define_type": "system",
          "is_extend": false,
          "is_single": false,
          "is_index_field": false,
          "index_name": "t_2",
          "max_length": 200,
          "help_text": ""
        },
        "UDMoney1__c": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422902,
          "length": 14,
          "description": "自定义金额",
          "is_unique": false,
          "label": "自定义金额",
          "type": "currency",
          "currency_unit": "¥",
          "decimal_places": 2,
          "field_num": 141,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDMoney1__c",
          "define_type": "custom",
          "is_extend": true,
          "is_single": false,
          "is_index_field": false,
          "index_name": "d_4",
          "round_mode": 4,
          "max_length": 16
        },
        "is_deleted": {
          "describe_api_name": "ContractObj",
          "is_index": false,
          "create_time": 1523348160460,
          "is_unique": false,
          "description": "is_deleted",
          "default_value": false,
          "label": "is_deleted",
          "type": "true_or_false",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "is_deleted",
          "define_type": "system",
          "index_name": "is_del"
        },
        "UDImg1__c": {
          "describe_api_name": "ContractObj",
          "file_amount_limit": 20,
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422902,
          "description": "自定义图片",
          "is_unique": false,
          "label": "自定义图片",
          "type": "image",
          "is_watermark": false,
          "field_num": 281,
          "file_size_limit": 10485760,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDImg1__c",
          "define_type": "custom",
          "is_extend": true,
          "is_single": false,
          "is_index_field": false,
          "index_name": "a_3",
          "support_file_types": []
        },
        "life_status_before_invalid": {
          "describe_api_name": "ContractObj",
          "is_index": false,
          "is_active": true,
          "create_time": 1560615275576,
          "pattern": "",
          "description": "作废前生命状态",
          "is_unique": false,
          "label": "作废前生命状态",
          "type": "text",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "life_status_before_invalid",
          "define_type": "package",
          "is_index_field": false,
          "is_single": false,
          "index_name": "t_3",
          "max_length": 256
        },
        "owner_department": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422902,
          "pattern": "",
          "description": "负责人主属部门",
          "is_unique": false,
          "label": "负责人主属部门",
          "type": "text",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "owner_department",
          "define_type": "package",
          "is_index_field": false,
          "is_single": false,
          "label_r": "负责人主属部门",
          "index_name": "owner_dept",
          "max_length": 100
        },
        "out_owner": {
          "describe_api_name": "ContractObj",
          "is_index": false,
          "is_active": true,
          "create_time": 1523348160460,
          "is_unique": false,
          "label": "外部负责人",
          "type": "employee",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "out_owner",
          "define_type": "system",
          "is_single": true,
          "index_name": "o_owner",
          "config": {
            "display": 1
          }
        },
        "UDSText2__c": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422902,
          "prefix": "",
          "description": "自定义自增",
          "is_unique": false,
          "start_number": 1,
          "serial_number": 2,
          "label": "自定义自增",
          "type": "auto_number",
          "field_num": 2,
          "condition": "NONE",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDSText2__c",
          "define_type": "custom",
          "postfix": "",
          "is_extend": true,
          "is_single": false,
          "is_index_field": false,
          "index_name": "s_10"
        },
        "UDMSel1__c": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422922,
          "description": "自定义多选",
          "is_unique": false,
          "label": "自定义多选",
          "type": "select_many",
          "field_num": 231,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDMSel1__c",
          "options": [
            {
              "label": "选项一",
              "value": "1",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            },
            {
              "label": "选项二",
              "value": "2",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            }
          ],
          "define_type": "custom",
          "is_extend": true,
          "is_index_field": false,
          "is_single": false,
          "index_name": "a_4",
          "config": {}
        },
        "owner": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422922,
          "description": "负责人",
          "is_unique": false,
          "label": "负责人",
          "type": "employee",
          "is_need_convert": true,
          "is_required": true,
          "api_name": "owner",
          "define_type": "package",
          "is_index_field": false,
          "is_single": true,
          "label_r": "负责人",
          "index_name": "owner"
        },
        "UDMText1__c": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422957,
          "pattern": "",
          "description": "自定义多行",
          "is_unique": false,
          "label": "自定义多行",
          "type": "long_text",
          "field_num": 51,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDMText1__c",
          "define_type": "custom",
          "is_extend": true,
          "is_index_field": false,
          "is_single": false,
          "index_name": "t_4",
          "max_length": 2000
        },
        "lock_status": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422957,
          "description": "锁定状态",
          "is_unique": false,
          "default_value": "0",
          "label": "锁定状态",
          "type": "select_one",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "lock_status",
          "options": [
            {
              "label": "未锁定",
              "value": "0",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            },
            {
              "label": "锁定",
              "value": "1",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            }
          ],
          "define_type": "package",
          "is_index_field": false,
          "is_single": false,
          "label_r": "锁定状态",
          "index_name": "s_5",
          "config": {}
        },
        "last_modified_time": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "create_time": 1523348160460,
          "is_unique": false,
          "description": "last_modified_time",
          "label": "最后修改时间",
          "type": "date_time",
          "time_zone": "",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "last_modified_time",
          "define_type": "system",
          "date_format": "yyyy-MM-dd HH:mm:ss",
          "index_name": "md_time"
        },
        "create_time": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "create_time": 1523348160460,
          "is_unique": false,
          "description": "create_time",
          "label": "创建时间",
          "type": "date_time",
          "time_zone": "",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "create_time",
          "define_type": "system",
          "date_format": "yyyy-MM-dd HH:mm:ss",
          "index_name": "crt_time"
        },
        "started_time": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422957,
          "description": "开始日期",
          "is_unique": false,
          "label": "开始日期",
          "time_zone": "GMT+8",
          "type": "date",
          "is_need_convert": false,
          "is_required": true,
          "api_name": "started_time",
          "define_type": "package",
          "date_format": "yyyy-MM-dd",
          "is_index_field": false,
          "is_single": false,
          "label_r": "开始日期",
          "config": {
            "edit": 1,
            "enable": 1,
            "attrs": {
              "wheres": 1,
              "default_value": 1,
              "label": 1,
              "help_text": 1
            }
          },
          "index_name": "l_2"
        },
        "UDMail1__c": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422957,
          "description": "自定义邮件",
          "is_unique": false,
          "label": "自定义邮件",
          "type": "email",
          "field_num": 331,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDMail1__c",
          "define_type": "custom",
          "is_extend": true,
          "is_index_field": false,
          "is_single": false,
          "index_name": "w_1"
        },
        "life_status": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1560615275598,
          "description": "生命状态",
          "is_unique": false,
          "default_value": "normal",
          "label": "生命状态",
          "type": "select_one",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "life_status",
          "options": [
            {
              "label": "未生效",
              "value": "ineffective",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            },
            {
              "label": "审核中",
              "value": "under_review",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            },
            {
              "label": "正常",
              "value": "normal",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            },
            {
              "label": "变更中",
              "value": "in_change",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            },
            {
              "label": "作废",
              "value": "invalid",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            }
          ],
          "define_type": "package",
          "is_index_field": false,
          "is_single": false,
          "index_name": "s_3",
          "config": {}
        },
        "UDCal1__c": {
          "describe_api_name": "ContractObj",
          "expression_type": "js",
          "return_type": "date",
          "is_index": false,
          "expression": "TODAY()",
          "is_active": true,
          "create_time": 1559274422957,
          "description": "自定义计算日期",
          "is_unique": false,
          "label": "自定义计算日期",
          "type": "formula",
          "decimal_places": 2,
          "field_num": 396,
          "default_to_zero": false,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDCal1__c",
          "define_type": "custom",
          "is_extend": true,
          "is_single": false,
          "is_index_field": false,
          "index_name": "l_3"
        },
        "UDCSSel1__c": {
          "describe_api_name": "ContractObj",
          "is_index": false,
          "is_active": true,
          "create_time": 1559314235660,
          "description": "自定义二级级联",
          "is_unique": false,
          "label": "二级-自定义二级级联",
          "type": "select_one",
          "field_num": 301,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDCSSel1__c",
          "options": [
            {
              "not_usable": false,
              "label": "二级选项",
              "value": "2",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            },
            {
              "not_usable": false,
              "label": "二级选项1",
              "value": "3",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            }
          ],
          "define_type": "custom",
          "cascade_parent_api_name": "L1_UDCSSel1__c",
          "is_extend": true,
          "is_index_field": false,
          "is_single": false,
          "index_name": "s_8",
          "config": {}
        },
        "last_modified_by": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1523348160460,
          "is_unique": false,
          "label": "最后修改人",
          "type": "employee",
          "is_need_convert": true,
          "is_required": false,
          "api_name": "last_modified_by",
          "define_type": "system",
          "is_single": true,
          "index_name": "md_by"
        },
        "out_tenant_id": {
          "describe_api_name": "ContractObj",
          "is_index": false,
          "is_active": true,
          "create_time": 1523348160460,
          "pattern": "",
          "is_unique": false,
          "description": "out_tenant_id",
          "label": "外部企业",
          "type": "text",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "out_tenant_id",
          "define_type": "system",
          "index_name": "o_ei",
          "config": {
            "display": 0
          },
          "max_length": 200
        },
        "version": {
          "describe_api_name": "ContractObj",
          "is_index": false,
          "create_time": 1523348160460,
          "length": 8,
          "is_unique": false,
          "description": "version",
          "label": "version",
          "type": "number",
          "decimal_places": 0,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "version",
          "define_type": "system",
          "index_name": "version",
          "round_mode": 4
        },
        "created_by": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1523348160460,
          "is_unique": false,
          "label": "创建人",
          "type": "employee",
          "is_need_convert": true,
          "is_required": false,
          "api_name": "created_by",
          "define_type": "system",
          "is_single": true,
          "index_name": "crt_by"
        },
        "confirm_time": {
          "describe_api_name": "ContractObj",
          "default_is_expression": false,
          "description": "确认时间",
          "is_unique": false,
          "type": "date_time",
          "default_to_zero": false,
          "is_required": false,
          "define_type": "package",
          "is_single": false,
          "label_r": "确认时间",
          "index_name": "l_5",
          "is_index": true,
          "is_active": true,
          "create_time": 1570893324589,
          "default_value": "",
          "label": "确认时间",
          "time_zone": "GMT+8",
          "is_need_convert": false,
          "api_name": "confirm_time",
          "date_format": "yyyy-MM-dd HH:mm:ss",
          "is_index_field": false,
          "config": {
            "add": 0,
            "edit": 0,
            "enable": 0,
            "display": 0,
            "remove": 0,
            "attrs": {
              "is_required": 0,
              "api_name": 0,
              "is_unique": 0,
              "default_value": 0,
              "label": 0,
              "help_text": 0
            }
          },
          "help_text": ""
        },
        "relevant_team": {
          "describe_api_name": "ContractObj",
          "embedded_fields": {
            "teamMemberEmployee": {
              "is_index": true,
              "is_need_convert": true,
              "is_required": false,
              "api_name": "teamMemberEmployee",
              "is_unique": false,
              "define_type": "package",
              "description": "成员员工",
              "label": "成员员工",
              "type": "employee",
              "is_single": false,
              "index_name": "stringList_2",
              "help_text": "成员员工"
            },
            "teamMemberRole": {
              "is_index": true,
              "is_need_convert": false,
              "is_required": false,
              "api_name": "teamMemberRole",
              "options": [
                {
                  "label": "负责人",
                  "value": "1"
                },
                {
                  "label": "普通成员",
                  "value": "4"
                }
              ],
              "is_unique": false,
              "define_type": "package",
              "description": "成员角色",
              "label": "成员角色",
              "type": "select_one",
              "index_name": "string_4",
              "help_text": "成员角色"
            },
            "teamMemberPermissionType": {
              "is_index": true,
              "is_need_convert": false,
              "is_required": false,
              "api_name": "teamMemberPermissionType",
              "options": [
                {
                  "label": "只读",
                  "value": "1"
                },
                {
                  "label": "读写",
                  "value": "2"
                }
              ],
              "is_unique": false,
              "define_type": "package",
              "description": "成员权限类型",
              "label": "成员权限类型",
              "type": "select_one",
              "index_name": "string_5",
              "help_text": "成员权限类型"
            }
          },
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422981,
          "is_unique": false,
          "label": "相关团队",
          "type": "embedded_object_list",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "relevant_team",
          "define_type": "package",
          "is_index_field": false,
          "is_single": false,
          "label_r": "相关团队",
          "index_name": "a_team",
          "help_text": "相关团队"
        },
        "record_type": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1560615275607,
          "description": "record_type",
          "is_unique": false,
          "label": "业务类型",
          "type": "record_type",
          "is_need_convert": false,
          "is_required": true,
          "api_name": "record_type",
          "options": [
            {
              "is_active": true,
              "api_name": "default__c",
              "description": "预设业务类型",
              "label": "预设业务类型"
            }
          ],
          "define_type": "package",
          "is_index_field": false,
          "is_single": false,
          "index_name": "r_type",
          "config": {}
        },
        "contract_title": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422981,
          "pattern": "",
          "description": "合同标题",
          "is_unique": false,
          "label": "合同标题",
          "type": "text",
          "is_need_convert": false,
          "is_required": true,
          "api_name": "contract_title",
          "define_type": "package",
          "is_index_field": false,
          "is_single": false,
          "label_r": "合同标题",
          "config": {
            "edit": 1,
            "attrs": {
              "wheres": 1,
              "is_required": 0,
              "default_value": 1,
              "label": 1,
              "help_text": 1
            }
          },
          "index_name": "t_1",
          "max_length": 100
        },
        "UDDec1__c": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422981,
          "length": 14,
          "description": "自定义小数",
          "is_unique": false,
          "label": "自定义小数",
          "type": "number",
          "decimal_places": 2,
          "field_num": 121,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDDec1__c",
          "define_type": "custom",
          "is_extend": true,
          "is_single": false,
          "is_index_field": false,
          "index_name": "d_2",
          "round_mode": 4,
          "max_length": 16
        },
        "account_id": {
          "describe_api_name": "ContractObj",
          "default_is_expression": false,
          "description": "客户名称",
          "is_unique": false,
          "type": "object_reference",
          "is_required": true,
          "wheres": [],
          "define_type": "package",
          "is_single": false,
          "label_r": "客户名称",
          "index_name": "s_1",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422981,
          "label": "客户名称",
          "target_api_name": "AccountObj",
          "target_related_list_name": "account_contract_list",
          "lookup_roles": [
            "1"
          ],
          "target_related_list_label": "合同",
          "action_on_target_delete": "cascade_delete",
          "is_need_convert": false,
          "api_name": "account_id",
          "is_index_field": false,
          "config": {
            "edit": 1,
            "attrs": {
              "target_related_list_label": 1,
              "wheres": 1,
              "is_required": 0,
              "default_value": 0,
              "label": 1,
              "help_text": 1
            }
          }
        },
        "data_own_department": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1523348160460,
          "is_unique": false,
          "label": "归属部门",
          "type": "department",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "data_own_department",
          "define_type": "package",
          "is_single": true,
          "index_name": "data_owner_dept_id"
        },
        "name": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422981,
          "pattern": "",
          "description": "合同编号",
          "is_unique": false,
          "label": "合同编号",
          "type": "text",
          "is_need_convert": false,
          "is_required": true,
          "api_name": "name",
          "define_type": "package",
          "is_index_field": false,
          "is_single": false,
          "label_r": "合同编号",
          "config": {
            "edit": 1,
            "attrs": {
              "wheres": 1,
              "is_required": 0,
              "default_value": 1,
              "label": 1,
              "help_text": 1
            }
          },
          "index_name": "name",
          "max_length": 100
        },
        "order_by": {
          "describe_api_name": "ContractObj",
          "is_index": false,
          "create_time": 1523348160460,
          "length": 8,
          "is_unique": false,
          "description": "order_by",
          "label": "order_by",
          "type": "number",
          "decimal_places": 0,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "order_by",
          "define_type": "system",
          "index_name": "l_by",
          "round_mode": 4
        },
        "UDDate1__c": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422981,
          "description": "自定义日期",
          "is_unique": false,
          "label": "自定义日期",
          "time_zone": "GMT+8",
          "type": "date",
          "field_num": 161,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDDate1__c",
          "define_type": "custom",
          "date_format": "yyyy-MM-dd",
          "is_extend": true,
          "is_index_field": false,
          "is_single": false,
          "index_name": "l_4"
        },
        "UDSText1__c": {
          "describe_api_name": "ContractObj",
          "is_index": true,
          "is_active": true,
          "create_time": 1559274422981,
          "pattern": "",
          "description": "自定义单行",
          "is_unique": false,
          "label": "自定义单行",
          "type": "text",
          "field_num": 1,
          "is_need_convert": false,
          "is_required": false,
          "api_name": "UDSText1__c",
          "define_type": "custom",
          "is_extend": true,
          "is_index_field": false,
          "is_single": false,
          "index_name": "t_5",
          "max_length": 100
        },
        "_id": {
          "describe_api_name": "ContractObj",
          "is_index": false,
          "is_active": true,
          "create_time": 1523348160460,
          "pattern": "",
          "is_unique": false,
          "description": "_id",
          "label": "_id",
          "type": "text",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "_id",
          "define_type": "system",
          "index_name": "_id",
          "max_length": 200
        },
        "status": {
          "describe_api_name": "ContractObj",
          "is_use_value": true,
          "is_index": true,
          "expression": "CASE($life_status$, \u0003'invalid\u0003', \u0003'99\u0003', \u0003'ineffective\u0003',\u0003'2\u0003', \u0003'under_review\u0003',\u0003'2\u0003', \u0003'normal\u0003',\u0003'1\u0003', \u0003'in_change\u0003',\u0003'1\u0003',\u0003'1\u0003')",
          "is_active": true,
          "create_time": 1559274422996,
          "description": "状态(原)",
          "is_unique": false,
          "label": "状态(原)",
          "type": "select_one",
          "is_need_convert": false,
          "is_required": false,
          "is_need_calculate": true,
          "api_name": "status",
          "options": [
            {
              "label": "正常",
              "value": "1",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            },
            {
              "label": "未生效",
              "value": "2",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            },
            {
              "label": "已作废",
              "value": "99",
              "config": {
                "edit": 1,
                "enable": 1,
                "remove": 1
              }
            }
          ],
          "define_type": "package",
          "is_single": false,
          "label_r": "状态(原)",
          "is_index_field": false,
          "index_name": "s_7",
          "config": {}
        }
      }
    },
    "detailObjectDescribeList": []
  },
  "errorDescription": "success",
  "errorMessage": "success",
  "errorCode": 0
}

请求参数

Body 参数application/json
corpAccessToken
string 
必需
企业应用访问公司合法性凭证
corpId
string 
企业ID
必需
currentOpenUserId
string 
必需
当前操作人OpenUserID
includeDetail
boolean 
可选
是否包含从对象描述信息
apiName
string 
必需
对象的api_name
示例

返回响应

🟢200成功
application/json
Body
traceId
string 
必需
data
object 
接口返回数据
必需
describe
object 
必需
detailObjectDescribeList
array[string]
必需
errorDescription
string 
必需
对返回码的文本描述内容
errorMessage
string 
必需
对返回码的文本描述内容
errorCode
integer 
返回码
必需

【纷享销客】API开发者 微信交流群

用微信扫右侧二维码,加入【纷享销客】API开发者 交流群,互助沟通

扫码加入交流群
上一页
创建合同对象对象
下一页
修改领料单对象信息
Built with