异构系统接口定义
1 概述
1.1 目的
本文档旨在编写一个面向开发者的完整的API调用规范,供需要调用发票云功能的开发者使用。本文档不包括API具体的实现细节。
1.2 适用范围
本文档适用阅读人员包括:发票云的设计、开发人员,公司内部合作部门成员。本文档的接口也仅限于公司内部应用使用。
1.3 适用版本
无。
1.4 归档凭证和单据推荐使用方案
1.4.1凭证提供接口列表:
第3章3.2(包含下载文件地址), 3.4
1.4.2单据提供接口列表:
第4章4.2(包含下载文件地址),4.4
1.4.3凭证和单据关联关系:
第3章3.5和第4章4.5提供其中一个即可
1.4.4归档流程示意图,以凭证为示例:
2 基础接口
2.1获取授权接口(不是必须的,如果不需要授权可以不此接口)
接口请求说明:http请求方式:POST(请使用https协议)
url:https://${baseUrl}/api/erp/base/oauth/company/token
请求数据结构:
{
"clientId": "vc0c6hjlgnKCic",
"sign": "8b9c78fccedbb72eff1106c57505b8f6",
"timestamp": 1463468225650
}
返回数据结构:
{
"accessToken": "7ffe2cced2a0e3615a24705ee39f53d09a243911c0e932991570ffa1d86abbf4",
"expiresTime": 43200,
"errcode": "0000",
"description": "操作成功"
}
参数描述:
参数 | 类型 | 是否必须 | 描述 |
---|---|---|---|
client_id | String | 是 | 用于授权验证的唯一标识clientId, |
sign | String | 是 | 签名(由clientId+ clientSecret+ timestamp的值MD5加密生成) |
Timestamp | long | 是 | 时间戳 |
返回参数:
参数 | 类型 | 描述 |
---|---|---|
access_token | String | 字符串, 最长255,用于后续访问的令牌,随机字符串 |
expires_in | long |
长整型,令牌在多少秒内有效,单位为秒 |
errcode | String | 操作结果码 |
description | String | 操作描述 |
2.2获取获取归档组织清单接口(目前暂未用到,可以忽略)
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/base/getOrganization?access_token={access_token}
请求数据结构:json
{
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data":
[
{
"organizationNo ": "001", //归档组织编号
"organizationName": "金蝶软件", //归档组织名称
"parentOrganizationNo": "002", //父级归档组织编码
"creater": "创建人", //创建人
"createTime": "2020-03-11 16:10:10", //创建时间
}
]
}
data说明
字段 | 描述 |
---|---|
organizationNo | 归档组织编号 |
organizationName | 归档组织名称 |
parentOrganizationNo | 父级归档组织编码 |
creater | 创建人 |
createTime | 创建时间,格式 yyyy-mm-dd hh:mm:ss |
3 凭证数据源接口模板定义
3.1获取凭证清单数据接口
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/voucher/list?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属,格式yyyy-mm
"pageSize": 10 , //分页查询,每页数量
"currentPage": 1 //分页查询,当前页
"voucherNum": "1", //凭证号
"voucherType": "1" //凭证类型
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | True(有token接口才为ture) |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
voucherNum | 凭证编号 001 | String | False |
voucherType | 凭证类型 记、转,付 | String | false |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"id": "1",
"billId": "sad1",
"title": "国际服饰(中国)有限公司",
"voucherOrgNumber": "1000", cou
"voucherOrgName": "国际服饰(中国)有限公司",
"accountDate": "2017-07-28",
"period": "2017-07",
"voucherNum": "KZ-10001485",
"attachNum": "2",
"voucherType": "KZ",
"currency": "CNY",
"rate": "1",
"totalDebitTra": "100.00",
"totalDebitLoc": "100.00",
"totalCreditTra": "100.00",
"totalCreditLoc": "100.00",
"approval": "张三",
"posting": "李四",
"review": "王五",
"creater": "钱六",
"operator": "赵七",
"cashier": "黄芪",
"auditing": "ad",
"accounter": "ad",
"scanBillNo": "ad",
"isPaper": "1",
"item": [
{
"accountcode": "001",
"accountname": "税收税款",
"desc": "摘要信息",
"costcenter": "成本中心",
"dr": "100.02",
"cr": "100.02"
}
],
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
} ]
}
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
id | 凭证id |
billId | 凭证billId |
title | 凭证抬头 |
voucherOrgNumber | 核算单位编码 |
voucherOrgName | 核算单位名字 |
accountDate | 过账日期 |
period | 凭证所属期属 |
voucherNum | 凭证号 |
attachNum | 附件张数,非必填 |
voucherType | 凭证类型 ,记,转付 |
currency | 币种 |
rate | 汇率 |
totalDebitTra | 借方交易币合计 |
totalDebitLoc | 借方本位币合计 |
totalCreditTra | 贷方交易币合计 |
totalCreditLoc | 贷方本位币合计 |
approval | 会计主管 ,非必填 |
posting | 记账人 |
review | 复核人 |
creater | 制单人,非必填 |
operator | 经办人,非必填 |
cashier | 出纳,非必填 |
auditing | 审核人 |
accounter | 过账人 |
scanBillNo | 影像编号 |
isPaper | 是否包含纸质,1包含 2不包含,非必填 |
Item凭证分录字段说明
字段 | 说明 |
---|---|
accountcode | 会计科目代码 |
accountname | 会计科目名称 |
desc | 凭证摘要 |
costcenter | 成本中心 |
dr | 借方金额 |
cr | 贷方金额 |
file文件属性说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
3.2 根据凭证唯一id和文件名下载文件(如果3.2接口返回里面有文件的下载地址,则不需要此接口)
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/voucher/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02", //归档期属范围,格式yyyy-mm
"voucherNum": "1", //凭证号
"voucherType": "1", //凭证类型
"fileName": "aaaa.pdf" //文件名
" isMainFile": 0 //是否是主文件
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
voucherNum | 凭证编号 001 | String | true |
voucherType | 凭证类型 记、转,付 | String | true |
fileName | 要下载文件名 | String | true |
isMainFile | 是否是主文件 | Int | true |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)
3.3 根据凭证唯一id查询关联发票信息
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/voucher/invoice?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属范围,格式yyyy-mm
"voucherNum": "1", //凭证号
"voucherType": "1" //凭证类型
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true true(有token接口才为ture) |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
voucherNum | 凭证编号 001 | String | true |
voucherType | 凭证类型 记、转,付 | String | true |
返回结果格式参照:
有和发票云收票或者开票对接,返回格式:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"serialNo": "00102", //发票流水号
"invoiceCode": "00102",//发票代码
"invoiceNo": "00102",//发票流号码
"isPaper": "1",//是否包含纸质,1包含 2不包含
}
]
}
没有返回格式:
https://app.apifox.com/link/project/3958968/apis/doc-5254131
3.4 根据凭证唯一id查询关联单据或者回单
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/voucher/billRelation?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属范围,格式yyyy-mm
"voucherNum": "1", //凭证号
"voucherType": "1" //凭证类型
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true true(有token接口才为ture) |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
voucherNum | 凭证编号 001 | String | true |
voucherType | 凭证类型 记、转,付 | String | true |
billType | 单据类型 | String | False |
返回结果格式:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"billNo": "00102", //单据编号,具有唯一性
"billType": "00102"//单据类型
}
{
"billNo":"32250198626000000398-e-20230925-100000.00-e-3229862600N9PKYDP4I ", //单据编号,具有唯一性
"billType": "bankReceipt"//单据类型
}
{
"billNo":"32250198626000000398-e-20230925-100000.00-e-3229862600N9PKYDP4I ", //单据编号,具有唯一性
"billType": "bankReceipt"//单据类型
}
]
}
data说明
字段 | 说明 |
---|---|
billNo | 单据编号或银行回单 |
billType | 单据类型(如果关联个的是回单,则固定返回“bankReceipt”字符串) |
4 单据数据源接口模板定义
4.1获取单据清单数据接口(单据编号需全局唯一)
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/bill/List?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属范围,格式yyyy-mm
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
"billNo": "011", //单据编号
"billType": "1", //单据类型
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true true(有token接口才为ture) |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | False |
period | 归档期属,格式yyyy-mm | String | False |
billNo | 单据编号,具有唯一性 | String | False |
billType | 单据类型 | String | False |
注意:单据编号、类型与属期不能同时为空
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"id":1, //单据id
"billId":"zxcas", //单据billId
"billNo":"001", //单据编号
"upperbillNo":"001", //关联的上游单据编号(一对一)
"upperbillNoList":[
{
"billNo":"001"
}
], //关联的上游单据编号(一对多)
"downbillNo":"001", //关联的下游单据编号
"period":"2020-01", //所属期属
"scanBillNo":"yx-oo1", //单据的影像编号
"billName":"费用报销单", //单据名称
"voucherOrgNumber": "1000", //核算单位代码
"voucherOrgName": "国际服饰(中国)有限公司", //核算单位名称
"creater":"001", //制单人
"amount":100.01, //单据金额
"settlementNo":"001", //付款单关联结算号
"scanBillNo": "ad", //影像编号,附件都可以放到这里
"lastUpdateTime": "2021-02-02 16:11:09", //最后修改日期
"isPaper": "1",
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
} ]
}
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
id | 单据id |
billId | 单据billId |
billNo | 单据编号 |
period | 所属期属 |
scanBillNo | 单据的影像编号 |
billName | 单据名称 |
voucherOrgNumber | 核算单位代码 |
voucherOrgName | 算单位名称 |
creater | 制单人 |
upperbillNo | 关联的上游单据编号(一对一),即由上游单据下推生成此单据 |
upperbillNoList | 关联的上游单据编号(一对多) |
downbillNo | 关联的下游单据编号,即有此单据下推生成关联的对应的单据编号 |
isPaper | 是否包含纸质,1包含 2不包含,非必填 |
file说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
4.2 根据单据编号和文件名下载文件
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/bill/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"billNo": "011", //单据编号
"fileName": "aaaa.pdf" //文件名
“isMainFile”: 0, //0主文件1附件 //是否是主文件
"period": "2021-02" , //归档期属范围,格式yyyy-mm
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true true(有token接口才为ture) |
organizationNo | 组织唯一编号,多个用“,”隔开 | String | False |
fileName | 要下载文件名 | String | true |
isMainFile | 是否是主文件 | Int | true |
billNo | 单据编号,具有唯一性 | String | True |
billType | 单据类型 | String | False |
period | 归档期属,格式yyyy-mm | String | False |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)
4.3 根据单据编号查询关联发票信息
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/bill/invoice?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属范围,格式yyyy-mm
"billNo": "011", //单据编号
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true true(有token接口才为ture) |
organizationNo | 组织唯一编号,多个用“,”隔开 | String | False |
billNo | 单据编号,具有唯一性 | String | True |
billType | 单据类型 | String | False |
period | 归档期属,格式yyyy-mm | String | False |
返回结果格式参照:
有和发票云收票或者开票对接,返回格式:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"serialNo": "00102", //发票流水号
"invoiceCode": "00102"//发票代码
"invoiceNo": "00102"//发票流号码
"isPaper": "1",//是否包含纸质,1包含 2不包含
}
]
}
没有返回格式:
https://app.apifox.com/link/project/3958968/apis/doc-5254131
4.4 根据报销单查询关联凭证(只支持同期属关联)
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/bill/voucherRelation?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属范围,格式yyyy-mm
"billNo": "011", //单据编号
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true true(有token接口才为ture) |
organizationNo | 组织唯一编号,多个用“,”隔开 | String | true |
billNo | 单据编号,具有唯一性 | String | True |
period | 归档期属,格式yyyy-mm | String | true |
返回结果格式:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"voucherNum": "00102", //凭证号
"voucherType": "记", /凭证类型
}
]
}
data说明
字段 | 说明 |
---|---|
voucherNum | 凭证号 |
voucherType | 凭证类型 |
4.5 根据报销单id查询关联发票(如果不能提供4.4接口,需对应的收票厂商提供此接口)
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/bill/invoice?access_token={access_token}
请求数据结构:json
{
"expenseId": "", // 报销单ID
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
expenseId | 单据唯一id | String | False |
返回结构:
5 总账数据源接口模板定义
5.1获取总账清单数据接口
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/ledger/List?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"id":1, //总账id
"billId":"zxcas", //总账唯一id
"period":"2020-10", //期属
"voucherOrgNumber":" 1000", //核算单位代码
"voucherOrgName": "国际服饰(中国)有限公司", //核算单位名称
"currency":"CNY", //币种
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
} ]
},
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
id | 总账id |
billId | 账簿唯一billId |
period | 期属 |
voucherOrgNumber | 核算单位代码 |
voucherOrgName | 核算单位名称 |
currency | 币种 |
file说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
5.2 根据下载总账主文件和附件文件
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/ledger/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"fileName": "aaaa.pdf" //文件名
“isMainFile”: 0, //0主文件1附件 //是否是主文件
"period": "2021-02" , //归档期属
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号 | String | true |
fileName | 要下载文件名 | String | true |
isMainFile | 是否是主文件 | Int | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)
6 明细账数据源接口模板定义
6.1获取明细账清单数据接口
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/detail/List?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"id":1, //明细账id
"billId":"zxcas", //明细账唯一id
"period":"2020-10", //期属
"voucherOrgNumber":" 1000", //核算单位代码
"voucherOrgName": "国际服饰(中国)有限公司", //核算单位名称
"subjno":" 1000", //科目编码
"subj": "主营业务收入", //科目名称
"currency":"CNY", //币种
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
} ]
}
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
id | 明细账id |
billId | 明细账唯一billId |
period | 期属 |
voucherOrgNumber | 核算单位代码 |
voucherOrgName | 核算单位名称 |
currency | 币种 |
subj | 科目名称 |
subjno | 科目编码 |
file说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
6.2 根据下载明细账主文件和附件文件
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/detail/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"fileName": "aaaa.pdf" //文件名
“isMainFile”: 0, //0主文件1附件 //是否是主文件
"period": "2021-02" , //归档期属
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号 | String | true |
fileName | 要下载文件名 | String | true |
isMainFile | 是否是主文件 | Int | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)
7 月报数据源接口模板定义
7.1获取月报清单数据接口
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/month/List?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"id":1, //月报id
"billId":"zxcas", //月报唯一id
"period":"2020-10", //期属
"voucherOrgNumber":" 1000", //核算单位代码
"voucherOrgName": "国际服饰(中国)有限公司", //核算单位名称
" reportType ":"资产负债表", //报表类型
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
} ]
}
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
id | 月报id |
billId | 月报唯一billId |
period | 期属 |
voucherOrgNumber | 核算单位代码 |
voucherOrgName | 核算单位名称 |
reportType | 报表类型 例: 资产负债表,利润表 |
file说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
7.2 下载月报主文件和附件文件
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/month/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"fileName": "aaaa.pdf" //文件名
“isMainFile”: 0, //0主文件1附件 //是否是主文件
"period": "2021-02" , //归档期属
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号 | String | true |
fileName | 要下载文件名 | String | true |
isMainFile | 是否是主文件 | Int | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)
8 季报数据源接口模板定义
8.1获取季报清单数据接口
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/quarter/List?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"id":1, //季报id
"billId":"zxcas", //季报唯一id
"period":"2020-10", //期属
"voucherOrgNumber":" 1000", //核算单位代码
"voucherOrgName": "国际服饰(中国)有限公司", //核算单位名称
" reportType ":"资产负债表", //报表类型
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
}
]
}
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
id | 季报id |
billId | 季报唯一billId |
period | 期属 |
voucherOrgNumber | 核算单位代码 |
voucherOrgName | 核算单位名称 |
reportType | 报表类型 例: 资产负债表,利润表 |
file说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
8.2 下载季报主文件和附件文件
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/quarter/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"fileName": "aaaa.pdf" //文件名
“isMainFile”: 0, //0主文件1附件 //是否是主文件
"period": "2021-02" , //归档期属
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号 | String | true |
fileName | 要下载文件名 | String | true |
isMainFile | 是否是主文件 | Int | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)
9 半年报数据源接口模板定义
9.1获取半年报清单数据接口
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/halfyear/List?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"id":1, //半年报id
"billId":"zxcas", //半年报唯一id
"period":"2020-10", //期属
"voucherOrgNumber":" 1000", //核算单位代码
"voucherOrgName": "国际服饰(中国)有限公司", //核算单位名称
" reportType ":"资产负债表", //报表类型
" year":"2020", //年度
" barcode":"001", //条码
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
} ]
}
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
id | 半年报id |
billId | 半年报唯一billId |
period | 期属 |
voucherOrgNumber | 核算单位代码 |
voucherOrgName | 核算单位名称 |
reportType | 报表类型 例: 资产负债表,利润表 |
year | 年度 |
barcode | 条码 |
file说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
9.2 下载半年报主文件和附件文件
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/halfyear/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"fileName": "aaaa.pdf" //文件名
“isMainFile”: 0, //0主文件1附件 //是否是主文件
"period": "2021-02" , //归档期属
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号 | String | true |
fileName | 要下载文件名 | String | true |
isMainFile | 是否是主文件 | Int | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)
10 年报数据源接口模板定义
10.1获取年报清单数据接口
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/year/List?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"id":1, //年报id
"billId":"zxcas", //年报唯一id
"period":"2020-10", //期属
"voucherOrgNumber":" 1000", //核算单位代码
"voucherOrgName": "国际服饰(中国)有限公司", //核算单位名称
" reportType ":"资产负债表", //报表类型
" year":"2020", //年度
" barcode":"001", //条码
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
} ]
}
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
id | 年报id |
billId | 年报唯一billId |
period | 期属 |
voucherOrgNumber | 核算单位代码 |
voucherOrgName | 核算单位名称 |
reportType | 报表类型 例: 资产负债表,利润表 |
year | 年度 |
barcode | 条码 |
file说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
10.2 下载年报主文件和附件文件
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/year/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"fileName": "aaaa.pdf" //文件名
“isMainFile”: 0, //0主文件1附件 //是否是主文件
"period": "2021-02" , //归档期属
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号 | String | true |
fileName | 要下载文件名 | String | true |
isMainFile | 是否是主文件 | Int | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)
11 固定资产数据源接口模板定义
11.1获取固定资产清单数据接口
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/assetscard/List?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"id":1, //固定资产id
"billId":"zxcas", //固定资产唯一id
"period":"2020-10", //期属
"voucherOrgNumber":" 1000", //核算单位代码
"voucherOrgName": "国际服饰(中国)有限公司", //核算单位名称
"currency":"CNY", //币种
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
} ]
}
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
id | 固定资产id |
billId | 固定资产唯一billId |
period | 期属 |
voucherOrgNumber | 核算单位代码 |
voucherOrgName | 核算单位名称 |
currency | 币种 |
file说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
11.2 下载固定资产主文件和附件文件
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/assetscard/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"fileName": "aaaa.pdf" //文件名
“isMainFile”: 0, //0主文件1附件 //是否是主文件
"period": "2021-02" , //归档期属
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号 | String | true |
fileName | 要下载文件名 | String | true |
isMainFile | 是否是主文件 | Int | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)
12 银行回单数据源接口模板定义
12.1获取银行回单清单数据接口
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/bank/List?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
"tradeId": " DER2323111111", //银行交易明细ID
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
tradeId | 银行交易明细ID | String | false |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"billId": "273492hr928hroiehr28herh1",
"tradeId": "DER2323111111",
"payeeName": "马腾",
"payeeAccount": "6225887860913444",
"payeeBank": "招商银行深圳南山科技园支行",
"paymentName": "马腾",
"paymentAccount": "62148300566012002",
"paymentBank": "中国工商银行常熟白茆支行",
"tradeDate": "2016-12-15",
"currency": "人民币",
"amount": "23030.80",
"postScript": "移动费",
"isPaper": "1",
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
} ]
}
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
billId | 银行回单billId |
tradeId | 银行回单流水号唯一id |
payeeName | 收款人户名 |
payeeAccount | 收款人账号 |
payeeBank | 收款方开户行 |
paymentName | 付款人户名 |
paymentAccount | 付款人账号 |
paymentBank | 付款方开户行 |
tradeDate | 交易日期 |
currency | 币种 |
amount | 金额 |
postScript | 附言 |
isPaper | 是否包含纸质,1包含 2不包含,非必填 |
file说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
12.2 根据单据编号和文件名下载文件
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/bank/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
"tradeId": " DER2323111111", //银行交易明细ID
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
tradeId | 银行交易明细ID | String | ture |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)
12.3 根据单据编号查询关联凭证(只支持同期属关联)
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/bill/voucherRelation?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"tradeId": " DER2323111111", //银行交易明细ID
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号,多个用“,”隔开 | String | true |
tradeId | 银行流水号,唯一ID | String | True |
period | 归档期属 | String | True |
返回结果格式:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"voucherNum": "00102", //凭证号
"voucherType": "记", /凭证类型
}
]
}
data说明
字段 | 说明 |
---|---|
voucherNum | 凭证号 |
voucherType | 凭证类型 |
13 获取各归档数据的应归档数量
13.1获取各归档数据的应归档数量
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/count?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"type": "凭证", //业务类型,和集成平台归档内容配置的名称保持一致
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
type | 业务类型,和集成平台归档内容配置的名称保持一致 | String | true |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": 1000
}
data说明
data返回对应业务应归档的数量统计
14 银行对账单数据源接口模板定义
14.1获取银行对账单清单数据接口
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/bankStatement/List?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"id":1, //id
"billId":"zxcas", //唯一id
"period":"2020-10", //期属
"voucherOrgNumber":" 1000", //核算单位代码
"voucherOrgName": "国际服饰(中国)有限公司", //核算单位名称
"currency":"CNY", //币种
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
} ]
}
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
id | id |
billId | 唯一billId |
period | 期属 |
voucherOrgNumber | 核算单位代码 |
voucherOrgName | 核算单位名称 |
currency | 币种 |
file说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
14.2 下载银行对账单主文件和附件文件
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/bankStatement/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"fileName": "aaaa.pdf" //文件名
“isMainFile”: 0, //0主文件1附件 //是否是主文件
"period": "2021-02" , //归档期属
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号 | String | true |
fileName | 要下载文件名 | String | true |
isMainFile | 是否是主文件 | Int | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)
15 现金日记账数据源接口模板定义
15.1获取现金日记账清单数据接口
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/cash/List?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"id":1, //id
"billId":"zxcas", //唯一id
"period":"2020-10", //期属
"voucherOrgNumber":" 1000", //核算单位代码
"voucherOrgName": "国际服饰(中国)有限公司", //核算单位名称
"currency":"CNY", //币种
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
} ]
}
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
id | id |
billId | 唯一billId |
period | 期属 |
voucherOrgNumber | 核算单位代码 |
voucherOrgName | 核算单位名称 |
currency | 币种 |
file说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
15.2 下载现金日记账主文件和附件文件
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/cash/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"fileName": "aaaa.pdf" //文件名
“isMainFile”: 0, //0主文件1附件 //是否是主文件
"period": "2021-02" , //归档期属
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号 | String | true |
fileName | 要下载文件名 | String | true |
isMainFile | 是否是主文件 | Int | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)
16 银行存款日记账数据源接口模板定义
16.1获取银行存款日记账清单数据接口
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/bankDeposit/List?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"id":1, //id
"billId":"zxcas", //唯一id
"period":"2020-10", //期属
"voucherOrgNumber":" 1000", //核算单位代码
"voucherOrgName": "国际服饰(中国)有限公司", //核算单位名称
"currency":"CNY", //币种
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
} ]
}
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
id | id |
billId | 唯一billId |
period | 期属 |
voucherOrgNumber | 核算单位代码 |
voucherOrgName | 核算单位名称 |
currency | 币种 |
file说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
16.2 下载银行存款日记账主文件和附件文件
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/bankDeposit/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"fileName": "aaaa.pdf" //文件名
“isMainFile”: 0, //0主文件1附件 //是否是主文件
"period": "2021-02" , //归档期属
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号 | String | true |
fileName | 要下载文件名 | String | true |
isMainFile | 是否是主文件 | Int | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)
17 银行存款余额调节表数据源接口模板定义
17.1获取银行存款余额调节表清单数据接口
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/bankBalance/List?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"id":1, //id
"billId":"zxcas", //唯一id
"period":"2020-10", //期属
"voucherOrgNumber":" 1000", //核算单位代码
"voucherOrgName": "国际服饰(中国)有限公司", //核算单位名称
"currency":"CNY", //币种
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
} ]
}
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
id | id |
billId | 唯一billId |
period | 期属 |
voucherOrgNumber | 核算单位代码 |
voucherOrgName | 核算单位名称 |
currency | 币种 |
file说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
17.2 下载银行存款余额调节表主文件和附件文件
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/bankBalance/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"fileName": "aaaa.pdf" //文件名
“isMainFile”: 0, //0主文件1附件 //是否是主文件
"period": "2021-02" , //归档期属
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号 | String | true |
fileName | 要下载文件名 | String | true |
isMainFile | 是否是主文件 | Int | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)
18 纳税申报表数据源接口模板定义
18.1获取纳税申报表清单数据接口
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/taxReport/List?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"period": "2021-02" , //归档期属
"pageSize": 10, //分页查询,每页数量
"currentPage": 1, //分页查询,当前页
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
pageSize | 分页查询,每页数量 | Int | true |
currentPage | 分页查询,当前页 | Int | true |
organizationNo | 组织唯一编号 | String | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
成功信息:
{
"errcode": "0000",
"description": "操作成功",
"data": [
{
"id":1, //id
"billId":"zxcas", //唯一id
"period":"2020-10", //期属
"voucherOrgNumber":" 1000", //核算单位代码
"voucherOrgName": "国际服饰(中国)有限公司", //核算单位名称
"currency":"CNY", //币种
"file": [
{
"fileName": "文件名,保证唯一性",
“isMainFile”: 0, //0主文件1附件,
"srcName":"源文件名",
"download":"文件下载地址"
} ]
}
],
"totalElements": 1,
"totalPage": 1,
"pageSize": 10,
"currentPage": 1
}
data说明
参数 | 描述 |
---|---|
id | id |
billId | 唯一billId |
period | 期属 |
voucherOrgNumber | 核算单位代码 |
voucherOrgName | 核算单位名称 |
currency | 币种 |
file说明
字段 | 说明 |
---|---|
fileName | 文件名(用于存储) |
isMainFile | 是否是主文件,0主文件1关联附件 |
srcName | 源文件名(用于展示) |
download | 文件下载地址 |
18.2 下载纳税申报表主文件和附件文件
接口请求说明:http请求方式:POST(请使用https协议)
http://{baseUrl}/api/erp/taxReport/file/download?access_token={access_token}
请求数据结构:json
{
"organizationNo": "001", //组织唯一编号
"fileName": "aaaa.pdf" //文件名
“isMainFile”: 0, //0主文件1附件 //是否是主文件
"period": "2021-02" , //归档期属
}
入参 | 描述 | 类型 | 是否必须 |
---|---|---|---|
access_token | 授权token | String | true |
organizationNo | 组织唯一编号 | String | true |
fileName | 要下载文件名 | String | true |
isMainFile | 是否是主文件 | Int | true |
period | 归档期属,格式yyyy-mm | String | true |
返回结果:
返回对应文件base64或文件流(根据数据源配置,默认base64)