批量同步接口
- 接口:common/customizedTaxBlacklist/batch
- Method:POST
- 数据格式:JSON
- 接口说明:单次数据量过大时候(超过200条)会全部转为异步处理,具体参考回调示例
- 参数校验:
- 当任意必填参数未填写时,整个批量创建任务会被拒绝。
- 相同批次中如果出现external_id相同的数据,会以最后一个为准。
- 生效时间不能大于失效时间。
参数
请求参数
字段 |
类型 |
释义 |
是否必填 |
bizId |
String |
当前次接口同步的唯一标识(UUID) |
Y |
timestamp |
long |
当前次接口同步时间对应的时间戳(TIMESTAMP) |
Y |
data |
List |
请求数据体 |
Y |
url |
String |
批量导入数据量大于200时的回调接口 |
数据量大于200时必填 |
BlacklistInfo
字段 |
类型 |
释义 |
是否必填 |
external_id |
String |
外部id |
Y |
tax_code |
String |
企业税号 |
Y |
corporate_name |
String |
企业名称 |
N |
expense_prohibition |
String |
禁止该税号下的发票导入系统(Y/N) |
N |
start_time |
long |
生效时间戳 |
N |
end_time |
long |
失效时间戳 |
N |
description |
String |
描述 |
N |
employee_number |
String |
员工号 (无效时任取其他Info内的有效员工号) |
Y |
返回参数
字段名称 |
字段类型 |
字段描述 |
bizId |
String |
当前次接口同步的唯一标识 |
resCode |
Integer |
响应状态码(见附录) |
resMsg |
String |
返回信息描述 |
validatorErrors |
Array |
字段强校验不合格的数据 |
dbErrors |
Array |
数据持久化时出现错误的数据 |
warnings |
Array |
字段弱校验不合格的数据,仍会做同步处理 |
请求参数示例
{
"bizId": "3123",
"timestamp": 123456789123456,
"data": [
{
"external_id": "1001",
"tax_code": "123",
"employee_number": "yrhch6@163.com"
},
{
"external_id": "1001",
"tax_code": "123",
"employee_number": "yrhch6@163.com"
},
{
"external_id": "1001",
"tax_code": "123456",
"employee_number": "123",
"expense_prohibition": "Y",
"description": "from api"
}
]
}
返回参数示例
{
"resCode": 200000,
"resMsg": "success",
"bizId": "3123",
"data": {
"validatorErrors": [],
"warnings": [
{
"code": "employee_number",
"messages": [
"无效的employee_number:123"
]
},
{
"code": "external_id",
"messages": [
"重复的external_id:1001",
"重复的external_id:1001"
]
}
],
"dbErrors": []
}
}
任意一条数据未填写external_id时
{
"resCode": 500060,
"resMsg": "external_id不能为空",
"bizId": "3123"
}