GET 商务函件详情

GET 查询。query 参数：id（函件ID，必填）。

接口编码	所需范围	后端接口
`sales.business-letter.detail`	`sales:read`	`GET /v1/business-letter/detail`（comap-sales）

请求参数（query）

字段	类型	必填	说明
`id`	integer(int64)	是	函件 ID

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验，标「—」不等于可以不传；租户在主站配置的字段必填不约束本接口。详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
  -H "Authorization: Bearer <访问令牌>" \
  -H "Content-Type: application/json" \
  -d '{
    "apiCode": "sales.business-letter.detail",
    "query": {
      "id": "1961000000000000001"
    }
  }'

响应 data 字段

字段	类型	必填	说明
`id`	integer(int64)	—	函件 ID
`orderId`	integer(int64)	—	关联订单 ID
`letterNo`	string	—	函件编号
`letterType`	string	—	函件类型：DUNNING / RECONCILIATION
`letterTypeName`	string	—	函件类型名称
`subject`	string	—	函件主题
`toneVersion`	string	—	语气版本
`toneVersionName`	string	—	语气版本名称
`status`	integer(int32)	—	状态：0=草稿, 1=待审批, 2=审批通过, 3=已驳回, 4=已导出, 5=已发送
`statusName`	string	—	状态名称
`dunningAmount`	number	—	催款金额
`createdByName`	string	—	创建人姓名
`createTime`	string(date-time)	—	创建时间
`flowInstanceCode`	string	—	流程实例编号
`content`	string	—	函件正文内容
`deadlineDays`	integer(int32)	—	回复/付款期限天数
`bankAccountId`	integer(int64)	—	关联收款银行账户 ID
`dunningScope`	string	—	催款范围：CURRENT / ALL / CUSTOM
`selectedInstallmentIds`	string	—	已选择的回款期次 ID 列表 JSON
`reconciliationStartDate`	string(date-time)	—	对账起始日期
`reconciliationEndDate`	string(date-time)	—	对账截止日期
`extraSettings`	string	—	附加设置 JSON
`updateTime`	string(date-time)	—	更新时间

错误处理

响应统一信封 { code, message, data }，code == 200 为成功。以下是本接口可能返回的开放平台层错误：

错误码	说明	可重试
92101	访问凭证无效	否
92201	接口未登记或已停用	否
92202	超出凭证授权范围——本接口需 `sales:read`	否
92204	绑定员工无此接口的功能权限	否
92203	上游服务调用失败	是
92301	请求过于频繁	是

除此之外，comap-sales 自身的业务校验失败会原样透传其业务码与提示（如字段校验、状态不允许、数据不存在），这类码不在开放平台的号段内，以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回business-letter

错误处理​

错误处理