凭证附件批量追加接口V2 - 电子档案开放接口文档

请求参数

Header 参数

Authorization

string

可选

默认值:

Content-Type

string

可选

默认值:

application/json

Body 参数application/json

array of:

voucherId

string | null

可选

凭证Id
用户系统凭证唯一编码。启用凭证ID情况下必传
不传则数据以业务实体名、凭证类型、凭证期间、凭证号四要素确定唯一

businessEntityName

string | null

可选

业务实体名称
V2接口为四要素之一
当不传业务实体名时，需要传业务实体编码

businessEntityCode

string | null

可选

业务实体编码
支持版本：3.5之后
当不传业务实体编码时，需要传业务实体名

voucherPeriod

string | null

必需

凭证期间
四要素之一
凭证期间必须为[yyyy-mm]格式且在系统中维护，例如：2022-02

voucherType

string | null

必需

凭证类型
四要素之一

voucherNo

string | null

凭证号四要素之一

必需

accountSetNo

string | null

可选

账套编号
支持版本：4.0之后
V3接口为四要素之一
V2接口不支持该参数

attchements

array[object (VoucherAttachmentDto) {3}] | null

附件列表

可选

type

enum<string> | enum<null>

可选

附件类型
RECEIPT 回单；
INVOICE 发票；
OTHER 其他普通附件；
METADATA 版式文件；
非RECEIPT和INVOICE即为其他

枚举值:

INVOICERECEIPTOTHERBILLVOUCHERPURCHASESTATEMENTPAYABLEMETADATAXML_FILEXML_RECORDACCEPTANCE_BILL

files

array[object (Object)] | null

可选

附件文件列表
附件文件列表，有2种形式:

根据文件信息拼接的字符串数组：
如：文件类型+;base64,+文件base64数据+;md5,+文件md5校验码
或：url@+文件网络路径+;md5,+文件md5校验码
或：文件base64数据+;md5,+文件md5校验码
base64常用数据格式:
data:,<文本数据>;md5,<md5校验码>
data:image/png;base64,base64编码的png图片数据;md5,<md5校验码>
data:image/jpeg;base64,base64编码的jpeg图片数据;md5,<md5校验码>
data:application/pdf;base64,base64编码的pdf数据;md5,<md5校验码>
data:ofd;base64,base64编码的ofd数据;md5,<md5校验码>
附件文件对象信息列表
name：文件名
type：文件类型
file：文件信息
md5Code：md5校验码，需要md5校验时，传入

cover

boolean | null

可选

是否覆盖附件
默认值为false追加附件；
true：覆盖
false：追加

示例

[
    {
        "voucherId": "string",
        "businessEntityName": "string",
        "businessEntityCode": "string",
        "voucherPeriod": "string",
        "voucherType": "string",
        "voucherNo": "string",
        "accountSetNo": "string",
        "attchements": [
            {
                "type": "INVOICE",
                "files": [
                    {}
                ],
                "cover": true
            }
        ]
    }
]

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer | null

结果代码

可选

message

string | null

结果信息

可选

errMsg

string | null

错误信息

可选

data

array[object (VoucherImportResultDTO) {9}] | null

结果数据

可选

index

integer | null

数据在列表中索引

必需

voucherId

string | null

可选

凭证Id
有传入则原始返回，未传入则为空，可根据四要素组合定位排查错误记录

businessEntityName

string | null

业务实体名

可选

accountSetNo

string | null

可选

账套编号
V2接口不支持该参数，V3接口支持

voucherPeriod

string | null

凭证期间

可选

voucherType

string | null

凭证类型

可选

voucherNo

string | null

凭证号

可选

code

integer | null

结果代码

可选

errorMsg

string | null

错误信息

可选

timestamp

string | null

时间戳

可选

示例

{
  "code": 0,
  "message": "",
  "errMsg": "",
  "data": [
    {
      "index": 0,
      "voucherId": "",
      "businessEntityName": "",
      "accountSetNo": "",
      "voucherPeriod": "",
      "voucherType": "",
      "voucherNo": "",
      "code": 0,
      "errorMsg": ""
    }
  ],
  "timestamp": ""
}