凭证批量同步接口V3

POST

/open/voucher/v3/

请求参数

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接口不支持该参数

setNo

string | null

账套

可选

voucherDate

string | null

必需

凭证日期
最好是：yyyy-MM-dd格式，例如：2022-02-22

voucherWord

string | null

凭证字

可选

attachmentsNumber

integer | null

附件数

可选

preparedBy

string | null

可选

制单人
凭证完整性检查要素，如为空，传“-”

approvedBy

string | null

可选

核准人
凭证完整性检查要素，如为空，传“-”

operator

string | null

可选

经办人
凭证完整性检查要素，如为空，传“-”

reviewer

string | null

可选

审核人
凭证完整性检查要素，如为空，传“-”

postingMan

string | null

过账

可选

cashier

string | null

出纳

可选

lines

array[object (OpenVoucherLineUpsertDto) {32}] | null

可选

凭证行
更新时覆盖之前的分录行

voucherAbstract

string | null

摘要

可选

subjectCode

string | null

科目代码

可选

subjectName

string | null

科目名称

可选

originalAmount

number | null

原币金额

可选

debitAmount

number | null

借方金额

可选

creditAmount

number | null

贷方金额

可选

entrySequenceNo

string | null

分录顺序号

可选

quantity

number | null

数量

可选

unitPrice

number | null

单价

可选

currency

string | null

可选

原币币种
不校验，例如：人民币或CNY皆可传

exchangeRate

number | null

汇率

可选

deptCode

string | null

部门编码

可选

deptName

string | null

部门名称

可选

employeeCode

string | null

员工编码

可选

employeeName

string | null

员工名称

可选

projectCode

string | null

项目编码

可选

projectName

string | null

项目名称

可选

transactionUnitCode

string | null

往来单位编码

可选

transactionUnitName

string | null

往来单位名称

可选

supplierCode

string | null

供应商编码

可选

supplierName

string | null

供应商名称

可选

merchantCode

string | null

客商编码

可选

merchantName

string | null

客商名称

可选

inventoryCode

string | null

存货编码

可选

inventoryName

string | null

存货名称

可选

cashFlowCode

string | null

现金流量代码

可选

cashFlowName

string | null

现金流量

可选

auxiliaryAccountings

array[object (AuxiliaryAccounting) {4}] | null

可选

辅助核算列表
在系统界面不会显示

auxiliaryStr

string | null

可选

辅助核算字符串
可以在系统界面展示

explain

object (Map«String»)

说明

可选

custom

object (Map«Object»)

可选

自定义字段
凭证行(分录行)自定义字段放这里，字段要提前在系统配置，报文样例：
"custom":{
"key": "value"
}

businessRemark

string | null

业务备注

可选

total

number | null

合计

可选

standardCurrency

string | null

可选

本位币币种
只能传币种简称，例如：CNY
在系统里的位置：凭证头及视图里的合计

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：追加

buzIdentify

string | null

业务标识

可选

buzDeclare

string | null

业务说明

可选

shoudRelReceiptNum

integer | null

可选

应关联回单数
不能为负数
支持版本：3.8.0版本之后

shoudRelInvoiceNum

integer | null

可选

应关联发票数
不能为负数
支持版本：3.8.0版本之后

principalMail

string | null

责任人邮箱

可选

custom

object (Map«Object»)

自定义凭证头

可选

userPrepared

string | null

制单人(用户)

可选

originalType

enum<string> | enum<null>

载体形式

可选

枚举值:

PAPERELECTRONIC

refer

string | null

参考信息

可选

示例

[
    {
        "voucherId": "string",
        "businessEntityName": "string",
        "businessEntityCode": "string",
        "voucherPeriod": "string",
        "voucherType": "string",
        "voucherNo": "string",
        "accountSetNo": "string",
        "setNo": "string",
        "voucherDate": "string",
        "voucherWord": "string",
        "attachmentsNumber": 0,
        "preparedBy": "string",
        "approvedBy": "string",
        "operator": "string",
        "reviewer": "string",
        "postingMan": "string",
        "cashier": "string",
        "lines": [
            {
                "voucherAbstract": "string",
                "subjectCode": "string",
                "subjectName": "string",
                "originalAmount": 0,
                "debitAmount": 0,
                "creditAmount": 0,
                "entrySequenceNo": "string",
                "quantity": 0,
                "unitPrice": 0,
                "currency": "string",
                "exchangeRate": 0,
                "deptCode": "string",
                "deptName": "string",
                "employeeCode": "string",
                "employeeName": "string",
                "projectCode": "string",
                "projectName": "string",
                "transactionUnitCode": "string",
                "transactionUnitName": "string",
                "supplierCode": "string",
                "supplierName": "string",
                "merchantCode": "string",
                "merchantName": "string",
                "inventoryCode": "string",
                "inventoryName": "string",
                "cashFlowCode": "string",
                "cashFlowName": "string",
                "auxiliaryAccountings": [
                    {
                        "type": "string",
                        "code": "string",
                        "name": "string",
                        "value": "string"
                    }
                ],
                "auxiliaryStr": "string",
                "explain": {
                    "key": "string"
                },
                "custom": {
                    "key": {}
                },
                "businessRemark": "string"
            }
        ],
        "total": 0,
        "standardCurrency": "string",
        "attchements": [
            {
                "type": "INVOICE",
                "files": [
                    {}
                ],
                "cover": true
            }
        ],
        "buzIdentify": "string",
        "buzDeclare": "string",
        "shoudRelReceiptNum": 0,
        "shoudRelInvoiceNum": 0,
        "principalMail": "string",
        "custom": {
            "key": {}
        },
        "userPrepared": "string",
        "originalType": "PAPER",
        "refer": "string"
    }
]

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/open/voucher/v3/' \
--header 'Authorization: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "voucherId": "string",
        "businessEntityName": "string",
        "businessEntityCode": "string",
        "voucherPeriod": "string",
        "voucherType": "string",
        "voucherNo": "string",
        "accountSetNo": "string",
        "setNo": "string",
        "voucherDate": "string",
        "voucherWord": "string",
        "attachmentsNumber": 0,
        "preparedBy": "string",
        "approvedBy": "string",
        "operator": "string",
        "reviewer": "string",
        "postingMan": "string",
        "cashier": "string",
        "lines": [
            {
                "voucherAbstract": "string",
                "subjectCode": "string",
                "subjectName": "string",
                "originalAmount": 0,
                "debitAmount": 0,
                "creditAmount": 0,
                "entrySequenceNo": "string",
                "quantity": 0,
                "unitPrice": 0,
                "currency": "string",
                "exchangeRate": 0,
                "deptCode": "string",
                "deptName": "string",
                "employeeCode": "string",
                "employeeName": "string",
                "projectCode": "string",
                "projectName": "string",
                "transactionUnitCode": "string",
                "transactionUnitName": "string",
                "supplierCode": "string",
                "supplierName": "string",
                "merchantCode": "string",
                "merchantName": "string",
                "inventoryCode": "string",
                "inventoryName": "string",
                "cashFlowCode": "string",
                "cashFlowName": "string",
                "auxiliaryAccountings": [
                    {
                        "type": "string",
                        "code": "string",
                        "name": "string",
                        "value": "string"
                    }
                ],
                "auxiliaryStr": "string",
                "explain": {
                    "key": "string"
                },
                "custom": {
                    "key": {}
                },
                "businessRemark": "string"
            }
        ],
        "total": 0,
        "standardCurrency": "string",
        "attchements": [
            {
                "type": "INVOICE",
                "files": [
                    {}
                ],
                "cover": true
            }
        ],
        "buzIdentify": "string",
        "buzDeclare": "string",
        "shoudRelReceiptNum": 0,
        "shoudRelInvoiceNum": 0,
        "principalMail": "string",
        "custom": {
            "key": {}
        },
        "userPrepared": "string",
        "originalType": "PAPER",
        "refer": "string"
    }
]'

返回响应

🟢200成功

application/json

Body

com.maycur.cm.dto.OpenResultDto<com.maycur.cm.dto.OpenBatchResultDataDto,java.util.List<com.maycur.cm.dto.voucher.VoucherImportResultDTO>>

code

integer | null

结果代码

可选

message

string | null

结果信息

可选

errMsg

string | null

错误信息

可选

data

object (OpenBatchResultDataDto)

结果数据

可选

successAmount

integer | null

成功条数

可选

timestamp

string | null

时间戳

可选

errData

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

错误信息

可选

示例

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

修改于 2023-10-24 02:47:30

凭证分录行删除接口V3

凭证批量同步接口