| 日期 | 变更描述 | 变更人 | 版本 |
|---|---|---|---|
| 2021/06/06 | 接口规范初版 | 曹云 | V1.6.0 |
| 2021/08/18 | 添加签名方式 | 雷权春 | V1.8.0 |
| 2021/12/13 | 接口补充 | 曹云 | V2.0.0 |

| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /archivebase/scan/login/token |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| clientId | String | 是 | 企业授权,税号维度 |
| sign | String | 是 | 签名(由client_id + client_secret + timestamp的值MD5加密生成) |
| timestamp | Long | 是 | 私有部署可为空,云服务必须传企业授权, 时间戳 |
| fphoneNumber | String | 是 | 用户手机号码 |
| fuserName | String | 是 | 用户名称 |
| fuserEmail | String | 否 | 用户邮箱 |
| ftaxNo | String | 否 | 用户所在组织企业 |
| feasUid | String | 否 | 该用户在对接系统的用户唯一ID |
| fsource | Integer | 是 | 操作系统来源:1-发票云 2-eas 3-星空 4-苍穹 5-OA 6国信 7道克维斯 8单多啦 9优易迅 10 金茂 15 汉德 99其他 |
| language | String | 否 | 语言版本默认中国, zh-CN:中国、en-US:美国、es-ES :西班牙、fr-FR:法国、de-DE :德国 |
| 字段名称 | 字段类型 | 说明 |
|---|---|---|
| accessToken | string | 授权token |
| expiresTime | Long | 有效时间(秒) |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/file/upload?access_token={ access_token } |
| 请求参数格式 | Content-Type: multipart/form-data; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| file | MultipartFile | 是 | 文件 |
| hashType | int | 是 | 加密方式:0-无 1-MD5 2-SHA-256 |
| 字段名称 | 字段类型 | 说明 |
|---|---|---|
| fileId | String | 文件存储fileId |
| hashCode | String | 文件加密后的值 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/file/uploadByUrl?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| url | String | 是 | 文件 |
| hashType | int | 是 | 加密方式:0-无 1-MD5 2-SHA-256 |
| fileName | String | 否 | 文件名 |
| 字段名称 | 字段类型 | 说明 |
|---|---|---|
| fileId | String | 文件存储fileId |
| hashCode | String | 文件加密后的值 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/scanbill/add?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fscanBillNo | String | 是 | 影像编号 |
| scanOutsideFileVoList | List | 是 | 影像集合 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| coverFlag | Int | 是 | 是否是封面:0-发票 1-封面 2-附件(同一影像编号下只能有一个封面) |
| fileId | String | 是 | 文件fileId |
| fcategoryName | String | 否 | 影像类型 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/attachment/upload?access_token={ access_token } |
| 请求参数格式 | Content-Type: multipart/form-data; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| file | MultipartFile | 是 | 文件 |
| fscanBillNo | String | 是 | 影像编号 |
| fcategoryName | String | 否 | 影像类型 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/scanbill/delete?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fscanBillNo | String | 是 | 影像编号 |
| fileIds | List<String> | 否 | 需要删除的影像fileId集合(为空则根据影像编号删除整单) |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/delete?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| scanBillNo | String | 是 | 影像编号 |
| deleteReason | String | 是 | 删除单据原因 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/scanbill/updateStatus?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fscanBillNo | String | 是 | 影像编号 |
| fscanStatus | Int | 是 | 影像状态:2-影像已提交完毕(影像提交EAS后) 3-影像审核完成(ERP返回审核通过) 4-影像有误待重扫(影像被打回) |
| rejectReason | string | 否 | 退扫原因fscanStatus=4时可传 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/reject?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| scanBillNo | String | 是 | 影像编号 |
| rejectReason | string | 否 | 驳回原因 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/reject/cancel?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| scanBillNo | String | 是 | 影像编号 |
| cancelRejectReason | string | 是 | 驳回撤销原因 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/review?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| scanBillNo | String | 是 | 影像编号 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/scanbill/getInfo?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fscanBillNo | String | 是 | 影像编号 |
| 字段名称 | 字段类型 | 说明 |
|---|---|---|
| fscanBillNo | String | 影像编号 |
| scanOutsideFileVoList | 集合 | 影像文件明细 |
| 字段名称 | 字段类型 | 说明 |
|---|---|---|
| fileId | String | 文件存储fileId |
| hashType | Int | 加密方式:0-无 1-MD5 2-SHA-256 |
| hashCode | String | 文件加密后的值 |
| fscanType | Int | 扫描影像类型:0为封面、1为发票、2为附件 |
| ffileType | Int | 文件类型: 1-pdf 2-图片 3-其他 4-Excel 5-word 6-ppt |
| fscanOrderNo | Int | 上传序号 |
| fileName | String | 文件名 |
| uploadMode | Int | 影像采集渠道 0.扫描页面-导入附件 1.扫描页面-导入发票 2.扫描页面-启动扫描 3.扫描页面-新增封面-本地上传 4.扫描页面-新增封面-扫描仪上传 5.扫描页面-补扫影像-本地上传-发票 18.扫描页面-补扫影像-本地上传-附件 6.扫描页面-补扫影像-扫描仪导入 7.扫描页面-替扫影像-本地导入 8.扫描页面-替扫影像-扫描仪导入 9.补改页面-启动扫描 10.补改页面-本地导入 11.补改页面-替换封面-本地导入 12.补改页面-替换封面-扫描仪导入 13.收票同步 14.收单机 15.外部接口 16.附件助手 17.其他 18.扫描页面-补扫影像-本地上传-附件 19.扫描页面-导入影像 20.扫描页面-扫码获取 21.扫描页面-插入影像-本地上传 22.扫描页面-插入影像-扫描仪上传 23.补改页面-插入影像-本地上传 24.补改页面-插入影像-扫描仪上传 |
| fscanFileAngle | String | 文件旋转角度 |
| labelList | 集合 | 文件标签集合 |
| 字段名称 | 字段类型 | 说明 |
|---|---|---|
| labelCode | String | 标签编号 |
| labelName | String | 标签名称 |
| 类型 | Get |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/scanbill/getFile?access_token={ access_token }&fileId=b56f8d7e67c945d7b9a263b69abb9e870 |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fileId | String | 是 | 文件fileId |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/getScanUrl?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| scanBillNo | String | 是 | 影像编号,多个用逗号隔开 |
| fetchSource | Integer | 否 | 仅当匹配模式下生效:1、展示报销岗的数据 2、展示扫描岗的数据,默认展示扫描岗的数据 |
| isAllowRemark | Boolean | 否 | 是否允许批注,不填的情况下默认以用户角色权限来控制 |
| isAllowEdit | Boolean | 否 | 是否允许补改,不填的情况下默认以用户角色权限来控制 |
| isAllowRescan | Boolean | 否 | 是否允许打回重扫,不填的情况下默认以用户角色权限来控制 |
| 字段名称 | 字段类型 | 说明 |
|---|---|---|
| url | String | 调阅页面地址 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/scanbill/getFileHashCode?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fileId | String | 是 | 文件fileId |
| hashType | Int | 是 | 加密方式: 1-MD5 2-SHA-256 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/outside/match/fpzs/inform?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fclientId | String | 是 | 授权ID |
| sign | String | 是 | 授权签名,详情见对接约定中的签名规则部分 |
| timestamp | String | 是 | 时间戳 |
| fexpenseId | String | 是 | 单据ID |
| fexpenseNum | String | 是 | 单据编号 |
| fscanBillNo | String | 是 | 影像编号 |
| fsource | int | 是 | 来源类型操作系统来源 1-发票云 2-eas 3-星空 4-苍穹 5-OA 6国信 7道克维斯 8单多啦 9优易迅 10 金茂 15 汉德 99其他 |
| fcreatorId | String | 否 | 制单人ID |
| fcreatorName | String | 是 | 制单人姓名 |
| fcreatorPhone | String | 是 | 制单人电话号码 |
| fcreatorEmail | String | 否 | 制单人邮箱 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/h5/getH5ViewPageUrl?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| scanBillNo | Integer | 是 | 影像编号 |
| fetchSource | Integer | 否 | 仅当匹配模式下生效:1、展示报销岗的数据 2、展示扫描岗的数据,默认展示扫描岗的数据 |
| ~~ | isRemark | Boolean | 是 |
| ~~ | isRescan | Boolean | 是 |
| ~~ | isEdit | Boolean | 是 |
| language | String | 是 | 语言 |
| 字段名称 | 字段类型 | 说明 |
|---|---|---|
| h5ViewPageUrl | String | 移动调阅页面地址 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/ocr/bankOcr?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fileName | String | 是 | 文件名 |
| fileBase64 | String | 是 | 文件转化的base64字符串 |
| 字段名称 | 字段类型 | 说明 |
|---|---|---|
| ftradeId | String | 交易流水号 |
| fpayeeBank | String | 收款银行 |
| fpaymentBank | String | 付款银行 |
| fpayeeAccount | String | 收款账户 |
| fpayeeName | String | 收款人 |
| fpaymentAccount | String | 付款账号 |
| fpaymentName | String | 付款人 |
| famount | String | 金额 |
| ftradeDate | String | 交易日期 |
| fcurrency | String | 币种 |
| floanSign | String | 借贷标记 |
| fbusinessNum | String | 业务编号 |
| fabstract | String | 摘要 |
| fused | String | 用途 |
| ffileName | String | 文件名 |
| fticketType | String | 回单类型 |
| 类型 | Get |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/erp/bankReceipt/bankReceiptPageUrl?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 说明 |
|---|---|---|
| bankReceiptPageUrl | String | 银行回单采集页面地址 |
| 类型 | POST |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/erp/bankReceipt/bankReceiptPageUrl/v2?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| accountNames | String | 否 | 银行回单文件录入方的账户名称号码,最多可以同时传入30个,以英文逗号隔开 |
| bankAccounts | String | 否 | 银行回单文件录入方的银行账户号码,最多可以同时传入30个,以英文逗号隔开 |
| 字段名称 | 字段类型 | 说明 |
|---|---|---|
| bankReceiptPageUrl | String | 银行回单采集页面地址 |
| 类型 | POST |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/erp/bankReceipt/detail?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 说明 |
|---|---|---|
| fcode | String | 实例对象唯一编号 |
| ticketType | String | 回单类 型中文描述 |
| ftradeId | String | 银行交易流水号 |
| fpayeeAccount | String | 收款人账号 |
| fpayeeBank | String | 收款方开户行名称 |
| fpayeeName | String | 收款人户名 |
| fpaymentAccount | String | 付款人账号 |
| fpaymentBank | String | 付款方开户行名称 |
| fpaymentName | String | 付款人户名 |
| famount | Decimal | 交易金额 |
| fcurrency | String | 币种 |
| ftradeDate | String | 交易日期 |
| ftradeType | String | 借贷标记 |
| ftradeNumber | String | 业务参考号 |
| fuse | String | 用途 |
| ffileName | String | 回单文件名 |
| fabstract | String | 摘要 |
| fileId | String | 扫描件原件存储服务器的文件id |
| 类型 | Get |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/erp/bankReceipt/view?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fileId | String | 是 | 银行回单fileId |
| 类型 | POST |
|---|---|
| IP:端口 | baseUrl |
| 路径 | |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 参数名 | 类型 | 说明 |
|---|---|---|
| fileId | String | 原件存储服务器的文件id |
| ticketType | String | 回单类型中文描述 |
| ftradeId | String | 银行交易流水号 |
| fpayeeAccount | String | 收款人账号 |
| fpayeeBank | String | 收款方开户行名称 |
| fpayeeName | String | 收款人户名 |
| fpaymentAccount | String | 付款人账号 |
| fpaymentBank | String | 付款方开户行名称 |
| fpaymentName | String | 付款人户名 |
| famount | String | 交易金额 |
| fcurrency | String | 币种 |
| ftradeDate | String | 交易日期 |
| ftradeType | String | 借贷标记---借或者贷 |
| ftradeNumber | String | 业务参考号 |
| fuse | String | 用途 |
| ffileName | String | 回单文件名 |
| fabstract | String | 摘要 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/getHomeUrl?access_token={access_token} |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fscanBillNo | String | 否 | 影像编号(正规流程可以不传此body参数。主要用于兼容扫描时,已经明确影像编号且只采集该影像单据的场景。) |
| 字段名称 | 字段类型 | 说明 |
|---|---|---|
| url | String | 扫描页面地址 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/largeFile/getUploadId?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fileMd5 | String | 是 | 文件MD5值 |
| fileName | String | 是 | 文件名 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/largeFile/uploadChunk?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| chunkMd5 | String | 是 | 分片MD5值 |
| chunkSize | String | 是 | 分片大小 |
| current | int | 是 | 当前上传分片序号 |
| fileMd5 | String | 是 | 大文件MD5值 |
| total | Int | 是 | 总分片数 |
| uploadId | String | 是 | 单文件上传id |
| bytes | 比特数组(byte[]) | 是 | 分片比特数组 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/outside/largeFile/mergeFile?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fileMd5 | String | 是 | 大文件MD5 值 |
| fileName | String | 是 | 文件名 |
| finitStatus | Int | 是 | 0-继续上传 1-(清除原有影像)重新上传 |
| fscanBillNo | String | 是 | 影像编号 |
| fscanSerialNo | String | 是 | 同一单据下的文件上传序号(如影像0、影像1等) |

| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/signPost/erpBillPush?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fscanBillNo | String | 是 | 影像编号 |
| fbillId | String | 是 | ERP单据唯一值(单据整个生命周期都不可变) |
| fbillTypeCode | String | 是 | 单据类型编码 |
| fbillTypeDes | String | 是 | 单据类型名称 |
| fapplyUserName | String | 是 | 提单人姓名 |
| fapplyUserPhone | String | 是 | 提单人电话号码 |
| fapplyErpUserName | String | 是 | 提单人ERP用户名(非姓名) |
| fapplyOrganizationCode | String | 是 | 提单组织编码 |
| fapplyOrganizationName | String | 是 | 提单组织名称 |
| fuploadFlag | int | 是 | 是否允许当前单据走上传流程,0则表示允许上传,1则不允许上传 |
| ferpDataId | String | 是 | 操作系统的数据中心 |
| fsource | int | 是 | 操作系统来源:1-发票云 2-eas 3-星空 4-苍穹 5-OA 6国信 7道克维斯 8单多啦 9优易迅 10 金茂 15 汉德 99其他 |
| fadditionalElectricDocs | int | 否 | 当系统配置允许纯电自动提交的情况下,是否允许当前单据自动提交流程,0则表示允许,1则不允许 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /imgsys/bill/signPost/erpBillEnablePost?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fscanBillNo | String | 是 | 影像编号 |
| 类型 | Post |
|---|---|
| IP:端口 | baseUrl |
| 路径 | /archivebase/bill/portal/user/operator?access_token={ access_token } |
| 请求参数格式 | Content-Type: application/json; charset=utf-8 |
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| fphoneNumber | String | 否 | 电话(电话、用户名、邮箱三个字段必填其一) |
| fuserName | String | 否 | 用户名(电话、用户名、邮箱三个字段必填其一) |
| fuserEmail | String | 否 | 邮箱(电话、用户名、邮箱三个字段必填其一) |
| fuserStatus | Int | 是 | 1-启用 2-禁用 |
| reason | String | 是 | 启用/禁用原因 |