外部收款账户
业务场景
将外部系统的收款账户通过接口的形式对接到每刻系统,员工提单的时候可以直接使用外部系统的收款账户,无需在每刻系统进行维护。
接口说明
请求方式
POST
请求参数说明
{
"keyWord":"", // 搜索关键字,由用户在界面上输入
"start":10, // 开始条数
"length":10, // 当前页显示条数
"formType":"xxxxxx", // 每刻单据标示 REIMBURSE表示报销单, PRECONSUME表示申请单,LITE为轻表单
"formData":{xxxxx}, //具体参数可以查看末尾的每刻推送的formData字段格式
"verification":false, // 是否用于校验
"detailBusinessCode": "collectionSchedule", // 标记哪个明细组件的数据互联触发请求(collectionSchedule:收款明细组件,payeeAccount:收款账户组件,这个是用于在formData中根据这个key获取对应的明细数据)
"selectionIndex": "0", // 标记该明细的哪一行数据触发请求,从0开始(这个是在上个字段的基础上,获取触发行的数据)
"employeeId":"U001" // 当前操作员工工号
}
每刻推送的formData字段格式
详细文档地址:每刻推送的表单数据格式
响应参数说明
数据格式请参考 数据互联组件。系统定义字段见Account收款账户信息参数说明,自定义字段按数据互联格式添加。
{
"data": {
"recordsTotal": 100, // 总记录数
"definedList": [ // 列定义
{
"businessCode": "id", // 唯一值,可以通过id直接找到唯一的一行数据,definedList中有且只有一个
"display": false
},
{
"primary": "true", // 是否为主列 主列的意义在于关键字搜索是针对主列进行的
"label": "账户名", // 列头信息,可自定义
"type": "SingleTextInput", // 单行文本,目前仅支持这一类
"businessCode": "accountName", // 外部唯一code
"display": true // 是否显示该列头
},
{
"label": "账号",// 列头信息,可自定义
"type": "SingleTextInput", // 单行文本,目前仅支持这一类
"businessCode": "accountNumber",
"display": true
},
{
"label": "账户类型",
"type": "SingleTextInput", // 单行文本,目前仅支持这一类
"businessCode": "accountType",
"display": false
}
],
"dataList": [{
"id": "ID-01",
"accountName": "每刻科技",
"accountNumber": "CODE001",
"accountType": "BANK"
},{
"id": "ID-02",
"accountName": "每刻科技",
"accountNumber": "CODE002",
"accountType": "ALIPAY"
}],
"defaultValue": {
"id": "ID-01",
"accountName": "每刻科技",
"accountNumber": "CODE001",
"accountType": "BANK"
}
},
"errorMsg": null,
"success": true
}
definedList(表头)字段说明(该结构必须返回具体字段,不能为空)
字段 | 说明 |
---|---|
primary | 标记主字段,用于搜索和回显于表单,有且只能有一个(建议回显用echo参数,此参数仅用于搜索用主键) |
echo | 控制回显表单的字段,有且只能有一个(优先级高于primary) |
label | 标签 |
type | 字段类型,可选值: |
SingleTextInput: 单行文本输入 AmountInput:金额输入 NumberInput:数字输入 | | businessCode | 字段唯一code | | display | 标记该字段是否在选择页面展示给员工查看 |
dataList(表体)字段说明 key对应definedList中的businessCode,value需要区分不同的type,以下对各个type进行说明
字段类型 | 数据格式 | 说明 |
---|---|---|
SingleTextInput | string | 单行文本输入 |
AmountInput | number | 金额输入 |
NumberInput | number | 数字输入 |
defaultValue(默认选中项)字段说明 defaultValue和dataList的数据结构一致,它所表示的是当用户点击数据互联组件时默认选中的是哪一项
返回值参数说明
字段 | 说明 |
---|---|
recordsTotal | 记录总数,必填,会被用于前端计算总页数 |
isPage | isPage用于告知每刻是返回分页数据还是全量数据,isPage为true,则代表接口方返回的是分页数据,反之则是全量数据,返回全量数据的时候,会对页面加载速度由一定的影响 |
errorMsg | 错误信息 |
errorCode | 错误码 |
success | 是否成功,必填,用于标记本次调用是否成功 |
Account收款账户信息参数说明:
字段名 | 字段类型 | 字段说明 | 是否必填 | 校验级别 |
---|---|---|---|---|
accountType | String | 账户类型,包括银行卡、支付宝和现金单选,可选值为BANK、ALIPAY和CASH | 是 | |
accountName | String | 账户名 | 是 | |
accountNumber | String | 银行对应银行卡号,支付宝对应支付宝账号,现金类型非必填 | 否 | |
bankName | String | 银行名称 | 否 | |
bankLocation | String | 开户省市, | ||
市和省使用/分隔,如“石家庄市/河北省” | 否 | |||
bankBranchName | String | 分支行 | 否 | |
bankBranchNo | String | 联行号分支行不为空情况下,可填写任意字符, 不做校验.分支行为空情况下, 必须是正确的联行号, 系统会根据联行号设置分支行. | 否 | |
certificationType | String | 证件类型 | 否 | |
identification | String | 证件号 | 否 | |
description | String | 备注 | 否 |
accountType为BANK时每刻自动补全说明
- 银行名称bankName 值为空,每刻将尝试根据accountNumber匹配.匹配失败将显示未知银行
- 分支行与联行号bankBranchName、bankBranchNo
- 模式一:只传bankBranchNo,且该联行号必须在每刻存在,系统会自动匹配开户行、分支行、开户省市;
- 模式二:只传bankBranchName,以传入的开户行、开户省市、分支行为准;
- 模式三:两个参数同时传入,接口保存以传入的开户行、开户省市、分支行、联行号为准。