应收应付业务对接报销单字段查询接口
业务场景
根据云票企业编码和报销单小类业务编码,查询付款产品化对接时可映射的单据级共享字段及收款明细支付场景。
注意事项
- 仅支持已启用且开启“应收应付业务对接”的报销单小类。
documentFields仅返回自定义、共享、已配置业务编码且类型受支持的单据级字段。OptionInput表示自定义档案选项字段。后续提单时应传所选自定义档案明细的业务编码,不应传选项名称、选项组编码或系统内部编码。- 返回字段按照表单中的字段顺序排列。
接口限制
10次/秒/企业
调用说明
调用前需通过平台级接口调用说明获取访问令牌,并在请求 Header 中传入 tokenId。
接口地址
/api/platform/receivable-payable/form-sub-types/fields
请求类型
GET
请求参数
Query 参数
| 参数名称 | 类型 | 是否必填 | 参数说明 |
|---|---|---|---|
| entCode | String | 是 | 云票企业编码 |
| formSubTypeBizCode | String | 是 | 报销单小类业务编码,与单据小类查询接口返回的 bizCode 一致 |
请求示例
GET /api/platform/receivable-payable/form-sub-types/fields?entCode=YUNPIAO_ENT_CODE&formSubTypeBizCode=EXP_TRAVEL_001
tokenId: ACCESS_TOKEN
响应参数
公共响应结构
| 字段名称 | 字段类型 | 字段说明 |
|---|---|---|
| response_code | Integer | 响应码,0 表示成功 |
| response_message | String | 响应信息 |
| data | FormSubTypeFieldsResult | 可映射字段信息 |
FormSubTypeFieldsResult
| 字段名称 | 字段类型 | 字段说明 |
|---|---|---|
| documentFields | List<FormFieldInfo> | 单据级可映射共享字段 |
| receivableDetailFields | List<PaymentSceneFormInfo> | 收款明细对应的支付场景 |
FormFieldInfo
| 字段名称 | 字段类型 | 字段说明 |
|---|---|---|
| displayName | String | 字段显示名称 |
| bizCode | String | 字段业务编码,后续提单时作为 customObject 的 key |
| fieldType | String | 字段类型 |
支持的 fieldType:
| fieldType | 说明 |
|---|---|
| SingleTextInput | 单行文本 |
| MultiTextInput | 多行文本 |
| TextInput | 文本 |
| NumberInput | 数字 |
| AmountInput | 金额 |
| AmountRatioInput | 金额及比例 |
| DateTimeInput | 日期时间 |
| OptionInput | 自定义档案选项,DB-61517 新增支持 |
PaymentSceneFormInfo
| 字段名称 | 字段类型 | 字段说明 |
|---|---|---|
| bizCode | String | 支付场景业务编码 |
| name | String | 支付场景名称 |
正常响应示例
{
"response_code": 0,
"response_message": null,
"data": {
"documentFields": [
{
"displayName": "付款周期",
"bizCode": "paymentCycle",
"fieldType": "OptionInput"
},
{
"displayName": "合同编号",
"bizCode": "contractNo",
"fieldType": "SingleTextInput"
}
],
"receivableDetailFields": [
{
"bizCode": "supplierPayment",
"name": "对公付款"
}
]
}
}
OptionInput 提单传值说明
查询结果中的 bizCode 作为 customObject 的 key,value 传所选自定义档案明细的业务编码(ReferenceDataDetail.bizCode)。
例如字段业务编码为 paymentCycle,所选档案明细业务编码为 MONTHLY:
{
"entCode": "YUNPIAO_ENT_CODE",
"reimburseTemp": {
"customObject": {
"paymentCycle": "MONTHLY"
}
}
}
系统会根据 MONTHLY 查询自定义档案明细,校验其所属选项组与字段配置一致,并转换为每刻内部选项对象后保存。
异常响应
| 场景 | response_code | response_message |
|---|---|---|
| 未找到云票企业对应的每刻企业 | 100001 | 未找到云票企业对应的每刻企业 |
| formSubTypeBizCode 为空 | 1008 | formSubTypeBizCode不能为空 |
| 单据小类不存在或已停用 | 1008 | 单据小类不存在 |
| 单据小类未开启应收应付业务对接 | 1008 | 该单据小类未开启应收应付业务对接 |
完整响应码请参考平台级接口响应码说明。
修改记录
2026-04-27 新增接口文档
2026-08-27 DB-61517 新增选项类共享字段查询及提单传值说明