创建企业

1、接口描述

该接口用于创建一个企业到企享云AGG平台, 创建成功后会返回唯一标识aggOrgId,aggOrgId作为双方平台企业关联的唯一标识, 在之后的接口中都要用到,用户必须保存起来,以便后续接口调用。 同步接口

2、接口地址

POST /v1/AGG/org/create  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgName String 企业名称(企业名称创建后不能修改,走删除,再创建)
nsrsbh String 企业纳税人识别号(纳税人识别号创建后不能修改,走删除,再创建)
orgTaxLogin.dq String 省市地区代码
  • 示例参数
{
    "nsrsbh": "税号",
    "aggOrgName": "企业名称",
    "orgTaxLogin": {
        "dq": "11"
    }
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

示例返回结果:
{
    "result": {
        "req_id": "76f51c4648d94ac197129d1089720733",
        "success": true,
        "time": 38,
        "timestamp": 1665812781803
    },
    "value": {
        "nsrsbh": "911303*****DBMRW2L",
        "flag": null,
        "aggOrgName": "昌黎县卓*****售有限公司",
        "createTime": null,
        "deleteTime": null,
        "appKey": 10001997,
        "aggOrgId": 428233065****128,
        "oldNsrsbh": null,
        "isFprz": null
    }
}
  • 字段说明
字段名 说明
aggOrgId 企业 id,当调用其他业务接口时,可以传入此 id

5、错误码

错误代码 错误信息 说明
601003 纳税人识别号(nsrsbh)不能为空! 200

企业基本信息准备

1、接口描述

新增企业扣缴义务人信息,用于实例RPA机器人客户端服务,支持新增修改企业信息。 异步接口

2、接口地址

POST /v1/GS/kjywr/save  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId String 维护企业信息接口返回的 aggOrgId
nsrmc String 扣缴义务人名称
nsrsbh String 企业纳税人识别号(不可修改)
djxh String 登记序号
encryptionType Integer 加密类型 1表示加密 ,其他不加密
smdlzh String 实名登录账户,当 encryptionType=1时,有值必须加密。
实名账户信息和申报密码两者其中之一不能为空,两者同时存在时优先实名账密
smdlmm String 实名登录密码,当 encryptionType=1时,有值必须加密。
实名账户信息和申报密码两者其中之一不能为空,两者同时存在时优先实名账密
sbmm String 申报密码,当 encryptionType=1时,有值必须加密。
实名账户信息和申报密码两者其中之一不能为空,两者同时存在时优先实名账密
bsrmc String 办税人名称
bsrlxdh String 办税人联系电话
swjgdm String 扣缴义务人税务机关代码
swjgmc String 税务机关名称
xzqhdm String 地区代码(例:北京 11)
  • 加密工具示例

          JSONObject jsonObject=new JSONObject();
          jsonObject.put("aggOrgId",441151611156544L);
          jsonObject.put("zgswjgmc","111");
          jsonObject.put("encryptionType",1);
          JSONObject  orgTaxLogin=new JSONObject();
          orgTaxLogin.put("gdsdlzh",RSAClientUtil.encrypt("yyyyy222!!@@"));
          jsonObject.put("orgTaxLogin",orgTaxLogin);
    
  • 公钥:

    MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+vuYMGtTU+42wwbaFX+PkCuSeoREKe5V4EJMi553Gc03ficUdpLHIFdEjAMHAxepwm3RAGLwyxYFK/S93k8GYMuV35L2Nj/cVeHS8scsdqXzqLUKaI4wj438OI6HDh7rWsw1M5EgMsoZvQqja53+SgD3mgIy3XyILbmA5jUp2IwIDAQAB
    
  • 加密方法样例

     public static String encrypt(String data) throws Exception {
             byte[] bytes = Base64.decode(publicKey);//publicKey 公钥
             X509EncodedKeySpec spec = new X509EncodedKeySpec(bytes);
             KeyFactory factory = KeyFactory.getInstance("RSA");
             PublicKey publicKey = factory.generatePublic(spec);
             Cipher cipher = Cipher.getInstance("RSA");
               cipher.init(Cipher.ENCRYPT_MODE, publicKey);
               int inputLen = data.getBytes().length;
               ByteArrayOutputStream out = new ByteArrayOutputStream();
               int offset = 0;
               byte[] cache;
               int i = 0;
               while (inputLen - offset > 0) {
                   if (inputLen - offset > 117) {
                       cache = cipher.doFinal(data.getBytes(), offset, 117);
                   } else {
                       cache = cipher.doFinal(data.getBytes(), offset, inputLen - offset);
                   }
                   out.write(cache, 0, cache.length);
                   i++;
                   offset = i * 117;
               }
               byte[] encryptedData = out.toByteArray();
               out.close();
               return Base64.encode(encryptedData);
    
         }
    
  • 示例参数
{
    "aggOrgId": 401671138*****4,
    "nsrmc": "成都******设备有限公司",
    "nsrsbh": "91510116MA7LG*****",
    "djxh": "",
    "smdlzh": "",
    "smdlmm": "",
    "sbmm": "Dg******40",
    "bsrmc": "万***",
    "bsrlxdh": "15810000000",
    "swjgdm": "2550913",
    "swjgmc": "某某税务分局",
    "xzqhdm": "51"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

示例返回结果:
{
    "result": {
        "req_id": "04487351557b4a538911aaf57264ff4e",
        "success": true,
        "time": 280,
        "timestamp": 1653277641564
    },
    "value": {
        "code": "SUCCESS",
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明

5、错误码

错误代码 错误信息 说明
SUCCESS 请求参数纳税人识别号不允许为空 200

企业基本信息查询

1、接口描述

该接口用于获取个税企业基本信息查询功能 同步接口

2、接口地址

POST /v1/GS/kjywr/getKjywrxx  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 维护企业信息接口返回的 aggOrgId
nsrsbh String 企业纳税人识别号

​ 示例参数

{    
    "aggOrgId":401671138175104,
    "nsrsbh": "91510116MA7LG*****"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "bc092e45d636405b9105029fbe2d931a",
        "success": true,
        "time": 369,
        "timestamp": 1653284729265
    },
    "value": {
        "code": "SUCCESS",
        "success": true,
        "message": "成功!",
        "data": {
            "xgr": "401671139713024",
            "nsrmc": "成都******设备有限公司",
            "bsrlxdh": "",
            "swjgmc": "某某税务分局",
            "message": "success",
            "kjywrid": 13,
            "bsrmc": "张三",
            "lrr": "czyId100001",
            "smdlmm": "",
            "yxbz": "Y",
            "swjgdm": "25*****",
            "xzqhdm": "44",
            "nsrsbh": "91510116MA7LG*****",
            "xgrq": "2022-05-23T05:41:03.000+00:00",
            "lrrq": "2022-04-27T00:55:14.000+00:00",
            "sbmm": "B4FD83F4672418D9DDCF7A213DE0B853",
            "zt": "1",
            "smdlzh": ""
        }        
    }
}
  • 字段说明
字段名 字段类型 说明
kjywrid Int 扣缴义务人ID
nsrmc String 扣缴义务人名称
nsrsbh String 纳税人识别号
djxh String 登记序号
smdlzh String 实名登录账户
smdlmm Sting 实名登录密码
sbmm String 申报密码
bsrmc String 办税人名称
bsrlxdh String 办税人联系电话
swjgdm String 扣缴义务人税务机关代码
swjgmc String 税务机关名称
xzqhdm Stirng 地区代码
lrr String 录入人
lrsj Date 录入时间
xgr String 修改人
xgrq Date 修改时间
zt String 状态 1初始化成功 0失败 2初始化中
message String 客户端返回状态说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业 200

人员信息登记采集

1、接口描述

该接口用于个税人员信息登记采集,主要用于采集:人员基础信息、任职受雇从业信息、联系方式、投资信息等 同步接口

2、接口地址

POST /v1/GS/nsrjcxx/saveBatchRyxx  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 维护企业信息接口返回的 aggOrgId
nsrsbh String 扣缴义务人识别号
kjywrid Int 扣缴义务人主键ID
ryjcxx 数组 List集合对象 以下为数组中数据字段
gh String 工号
xm String 姓名
zjlx String 证件类型
zjhm String 证件号码
gj String 国籍地区
xb String 性别
xl String 学历代码(0-研究生 1-大学本科 2-大学本科以下)
csny Date 出生年月(格式yyyy-MM-dd)
ryzt String 人员状态(1、正常 0、非正常)
rylx String 人员类型(1、境外人员 0、境内人员)
sfcj String 是否残疾(1、是 0不是)
sfls String 是否烈属(1、是 0不是)
sfgl String 是否孤老(1、是 0不是)
cjzh String 残疾证号(是否残疾 是1 时残疾证号必须为32位 )
lszh String 烈属证号(是否烈属 是1 时烈属证号必须填 )
csgj String 出生国家
zwm String 中文姓名
lxdz String 联系地址
lhsj Date 来华时间(条件必填:证件类型不是身份证时必填)
lxdh String 联系电话
dzyx String 电子邮箱
rzqx String 任职期限
qtzjlx String 其他证件类型
qtzjhm String 其他证件号码
ljsj Date 离境时间(条件必填:证件类型不是身份证时必填)
ljdz String 离境地址
jnzw String 境内职务
jwzf String 境外职务
sssy String 涉税事由(默认涉税事由是任职受雇,目前默认无需填写)
zfd String 支付地址(境外的)
yzbm String 邮政编码
rzsglx String 任职受雇类型
rzsgrq Date 任职受雇日期
lzrq Date 离职日期(人员状态为非正常时必传)
kcjcfybz String 扣除减除费用标志
(扣除5000,生产经营的扣除,0 不扣除 1 默认扣除)
rzndjyqx String 任职年度就业情形
zw String 职务
jcjjdSheng String 经常居住地省
jcjjdShi String 经常居住地市
jcjjdQx String 经常居住地区县
jcjjdJd String 经常居住地街道
jcjjdXxdz String 经常居住地详细地址
lxdzSheng String 联系地址省
lxdzShi String 联系地址地市
lxdzQx String 联系地址区县
lxdzJd String 联系地址街道
lxdzXxdz String 联系地址详细地址
hjdzSheng String 户籍地址省
hjdzShi String 户籍地址地市
hjdzQx String 户籍地址区县
hjdzJd String 户籍地址街道
hjdzXxdz String 户籍地址详细地址
khyh String 开户银行
khhsf String 开户行省份
grtzbl String 个人投资比例(0到1)
(精度范围:4位小数
例子:0.3413,录入其中一个时,其他的必录)
grtze String 个人投资额: 个人投资金额(元)
(精度范围:2位小数。
例子:11.34,录入其中一个时,其他的必录)
  • 示例参数
{
"aggOrgId":401671138175104,
"nsrsbh":"91440XXXFM20",//纳税人识别号
"kjywrid":"1",//扣缴义务人ID
    "ryjcxx":[ //人员基础信息
        {
            "gh":"3", //工号
            "lxdh":"13018657910",//联系电话
            "gj":"156",//国籍代码
            "xm":"徐欢",//人员姓名
            "zjlx":"201",//证件类型
            "csny":"", //出生年月
            "rylx":"1",//人员类型
            "xb":"",//性别
            "zjhm":"4307xxxx36514",//证件号码
            "rzsglx":"3",//任职受雇类型
            "rzsgrq":"2024-01-01"//任职受雇日期
        },
        {
            "gh":"4",
            "lhsj":"2020-01-01",//来华时间
            "lxdh":"13923381730",
            "gj":"344",
            "zjlx":"210",
            "rylx":"1",
            "ljsj":"2022-01-01",
            "xb":"1",
            "zjhm":"Hxxx146",
            "rzsgrq":"2021-01-01",
            "xm":"柯英娜",
            "csny":"1966-01-13",
            "csgj":"344",//出生国家
            "rzsglx":"0"
        },
        {
            "gh":"1",
            "lxdh":"13018657930",
            "gj":"156",
            "xm":"周X",
            "zjlx":"201",
            "rylx":"1",
            "zjhm":"4306ssss8446",
            "rzsglx":"0",
            "rzsgrq":"2021-01-01"
        }
    ]
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "0d95a10414ae4a0bab6bb933f618e740",
        "success": true,
        "time": 305,
        "timestamp": 1654057636500
    },
    "value": {
        "code": "SUCCESS",
        "data": {
            "failNum": 0,
            "successNum": 1,
            "succList": [
                1
            ],
            "rowMsgMap": {
            },
            "resultMsg": ""
        },
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 说明

5、错误码

错误代码 错误 说明
PARAMETER_ERROR 没有找到对应的企业

批量人员信息登记采集接口

1、接口描述

该接口用于个税人员信息登记采集,主要用于采集:人员基础信息、任职受雇从业信息、联系方式、投资信息等 同步接口

2、接口地址

POST /v1/GS/nsrjcxx/batchSaveRyxx  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 维护企业信息接口返回的 aggOrgId
nsrsbh String 扣缴义务人识别号
kjywrid Int 扣缴义务人主键ID
ryjcxx 数组 List集合对象 以下为数组中数据字段
gh String 工号
xm String 姓名
zjlx String 证件类型
zjhm String 证件号码
gj String 国籍地区
xb String 性别
xl String 学历代码(0-研究生 1-大学本科 2-大学本科以下)
csny Date 出生年月(格式yyyy-MM-dd)
ryzt String 人员状态(1、正常 0、非正常)
rylx String 人员类型(1、境外人员 0、境内人员)
sfcj String 是否残疾(1、是 0不是)
sfls String 是否烈属(1、是 0不是)
sfgl String 是否孤老(1、是 0不是)
cjzh String 残疾证号(是否残疾 是1 时残疾证号必须为32位 )
lszh String 烈属证号(是否烈属 是1 时烈属证号必须填 )
csgj String 出生国家
zwm String 中文姓名
lxdz String 联系地址
lhsj Date 来华时间(条件必填:证件类型不是身份证时必填)
lxdh String 联系电话
dzyx String 电子邮箱
rzqx String 任职期限
qtzjlx String 其他证件类型
qtzjhm String 其他证件号码
ljsj Date 离境时间(条件必填:证件类型不是身份证时必填)
ljdz String 离境地址
jnzw String 境内职务
jwzf String 境外职务
sssy String 涉税事由(默认涉税事由是任职受雇,目前默认无需填写)
zfd String 支付地址(境外的)
yzbm String 邮政编码
rzsglx String 任职受雇类型
rzsgrq Date 任职受雇日期
lzrq Date 离职日期(人员状态为非正常时必传)
kcjcfybz String 扣除减除费用标志
(扣除5000,生产经营的扣除,0 不扣除 1 默认扣除)
rzndjyqx String 任职年度就业情形
zw String 职务
jcjjdSheng String 经常居住地省
jcjjdShi String 经常居住地市
jcjjdQx String 经常居住地区县
jcjjdJd String 经常居住地街道
jcjjdXxdz String 经常居住地详细地址
lxdzSheng String 联系地址省
lxdzShi String 联系地址地市
lxdzQx String 联系地址区县
lxdzJd String 联系地址街道
lxdzXxdz String 联系地址详细地址
hjdzSheng String 户籍地址省
hjdzShi String 户籍地址地市
hjdzQx String 户籍地址区县
hjdzJd String 户籍地址街道
hjdzXxdz String 户籍地址详细地址
khyh String 开户银行
khhsf String 开户行省份
grtzbl String 个人投资比例(0到1)
(精度范围:4位小数
例子:0.3413,录入其中一个时,其他的必录)
grtze String 个人投资额: 个人投资金额(元)
(精度范围:2位小数。
例子:11.34,录入其中一个时,其他的必录)
  • 示例参数
{
    "aggOrgId": "401671138175104",//企业ID
    "nsrsbh": "91370214MA3RXLGE0Q",//纳税人识别号
    "ryjcxx": [
        {
            "gh": "91927864800006", //工号
            "lxdh": "1***********",//联系电话
            "gj": "156",//国籍代码
            "xm": "**",//人员姓名
            "zjlx": "201",//证件类型
            "csny": "19**-05-20",//出生年月
            "rylx": "0",//人员类型
            "xb": "1",//性别
            "zjhm": "140***********7581",//证件号码
            "rzsglx": "4",//任职受雇类型
            "rzsgrq": "2023-01-01"//任职受雇日期
        },
        {
            "gh": "91927864800007",
            "lxdh": "1***********",
            "gj": "156",
            "xm": "***",
            "zjlx": "201",
            "csny": "1987-05-21",
            "rylx": "0",
            "xb": "0",
            "zjhm": "1423**********361x",
            "rzsglx": "4",
            "rzsgrq": "2023-01-01"
        }
    ]
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "d42dc12f214f4eca9ed59aea5704d855",
        "success": true,
        "time": 287,
        "timestamp": 1699845348932
    },
    "value": {
        "code": "SUCCESS",
        "data": {
            "sumNum": 2,
            "succeedNum": 1,
            "failNum": 1,
            "detail": [{
                    "msg": "更新成功,没有需要更新的值!",
                    "hb": "1"
                }, {
                    "msg": "第2行:身份证的校验位不正确<br>",
                    "hb": "2"
                }
            ]
        },
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明
sumNum int 总条数
succeedNum int 成功条数
failNum int 失败条数
detail array 数据详情
detail.hb String 行标
detail.msg String 成功或失败信息

5、错误码

错误代码 错误 说明
PARAMETER_ERROR 没有找到对应的企业

人员信息查询

1、接口描述

该接口用于个税的人员信息查询,支持查询人员报送和验证状态,以及人员 基础信息、任职受雇从业信息、联系方式、投资信息等。支持单人查询和全量查询。 同步接口

2、接口地址

POST /v1/GS/nsrjcxx/query  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 维护企业信息接口返回的 aggOrgId
nsrsbh String 纳税人识别号
gh String 工号
zjhm String 证件号码
zjlx String 证件类型
xm String 姓名
ryzt String 人员状态
rzsglx String 任职受雇类型
rzyf String 任职月份(yyyy-MM)
lzyf String 离职月份(yyyy-MM)
bszt String 报送状态
yzzt String 验证状态
page
current Long 起始页
pageSize Long 当页显示条数
  • 示例参数
{    
    "aggOrgId":401671138175104,
    "nsrsbh": "91510116MA7LG*****",
    "page":{
        "current":1,
        "pageSize":10    
    }
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "d72d8e2d574a4285a37c7c4cb23aec11",
        "success": true,
        "time": 313,
        "timestamp": 1653290723126
    },
    "value": {
        "code": "SUCCESS",
        "success": true,
        "message": "成功!",
        "data": {
            "ryjcxx": [
                {
                    "zjlx": "201",
                    "zjhm": "41152*********891X",
                    "yxbz": "Y",
                    "csny": "1999-02-23T16:00:00.000+00:00",
                    "lxdh": "13200112233",
                    "yzzt": "2",
                    "rylx": "0",
                    "lrr": "czyId100001",
                    "rzsgrq": "2021-01-01T00:00:00.000+00:00",
                    "sfls": "0",
                    "lszh": "",
                    "kjywrid": 13,
                    "sfgl": "0",
                    "sfcj": "0",
                    "rzndjyqx": "0",
                    "xgrq": "2022-05-18T11:20:19.000+00:00",
                    "kcjcfybz": "1",
                    "rzsglx": "0",
                    "gh": "1",
                    "xgr": "401671139713024",
                    "gj": "156",
                    "bszt": "2",
                    "xb": "0",
                    "nsrid": "5287b760c7d446549cac54e0a5f4e718",
                    "ryzt": "1",
                    "xm": "万**",
                    "lrrq": "2022-05-02T08:35:35.000+00:00",
                    "cjzh": ""
                }
            ],
            "page": {
                "current": 1,
                "total": 1,
                "pageSize": 10
            }
        }
    }
}
  • 字段说明
字段名 字段类型 说明
ryjcxx list 人员信息集合
nsrid String 人员员工ID
gh String 工号
xm String 姓名
zjlx String 证件类型
zjhm String 证件号码
gj String 国籍地区
xb String 性别
xl String 学历代码
csny Date 出生年月
rylx String 人员类型
ryzt String 人员状态
sfcj String 是否残疾
sfls String 是否烈属
sfgl String 是否孤老
cjzh String 残疾证号
lszh String 烈属证号
csgj String 出生国家
zwm String 中文姓名
lxdz String 联系地址
lxdh String 联系电话
dzyx String 电子邮箱
lhsj Date 来华时间
rzqx String 任职期限
qtzjlx String 其他证件类型
qtzjhm String 其他证件号码
ljsj Date 离境时间
ljdz String 离境地址
jnzw String 境内职务
jwzf String 境外职务
zfd String 支付地址
yzbm String 邮政编码
rzsglx String 任职受雇类型
rzsgrq Date 任职受雇日期
lzrq Date 离职日期
kcjcfybz String 扣除减除费用标志
rzndjyqx String 任职年度就业情形
zw String 职务
jcjjdSheng String 经常居住地省
jcjjdShi String 经常居住地市
jcjjdQx String 经常居住地区县
jcjjdJd String 经常居住地街道
jcjjdXxdz String 经常居住地详细地址
lxdzSheng String 联系地址省
lxdzShi String 联系地址地市
lxdzQx String 联系地址区县
lxdzJd String 联系地址街道
lxdzXxdz String 联系地址详细地址
hjdzSheng String 户籍地址省
hjdzShi String 户籍地址地市
hjdzQx String 户籍地址区县
hjdzJd String 户籍地址街道
hjdzXxdz String 户籍地址详细地址
khyh String 开户银行
khhsf String 开户行省份
grtzbl String 个人投资比例
grtze String 个人投资额
bszt String 报送状态
yzzt String 身份验证状态
sssy String 涉税事由
sftzr String 是否投资人
(不展示就是放到数据库打标志,生产经营,区分出投资人。
员工报薪资,投资人报生产经营所得。)
page
current Int 当前页码
total Int 总条数
pageSize Int 每页分页数

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

人员报送

1、接口描述

该接口用于已采集的人员信息的报送和人员的验证。 流程类型代码:ryxxbs
异步接口

2、接口地址

POST /v1/GS/nsrjcxx/sendRyxxTkhd HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 维护企业信息接口返回的 aggOrgId
kjywrid Int 扣缴义务人ID(两者其一必填)
nsrsbh String 扣缴义务人识别号(两者其一必填)
  • 示例参数
{    
    "aggOrgId":401671138175104,
    "nsrsbh": "91510116MA7LG*****"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "success": true,
        "req_id": "4933f9b2f980423da67c14495f60884b",
        "timestamp": 1684203527915,
        "time": 161
    },
    "value": {
        "code": "SUCCESS",
        "data": null,
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

客户端人员名称修改接口

1、接口描述

该接口用于客户端人员名称修改 异步接口

2、接口地址

POST /v1/GS/nsrjcxx/ryxxTxqxcl      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrid String 纳税人ID
  • 示例参数
{
    "aggOrgId": "406485007040704",
    "nsrid": "8204f8a0f7834eb799fb53ece6bf89b1"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "dc571a0db88c4bbbaa5b25ebf45475e6",
        "success": true,
        "time": 214,
        "timestamp": 1655207517687
    },
    "value": {
        "code": "SUCCESS",
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

人员删除

1、接口描述

该接口用于个税未报送人员删除。 同步接口

2、接口地址

POST /v1/GS/nsrjcxx/delete  HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
kjywrid Int 扣缴义务人ID
kjsqq Date 扣缴属期起
ids List 人员基础信息idList(id请参数参考人员信息查询返回nsrid)
  • 示例参数
{
    "aggOrgId": "401671138175104",
    "kjywrid": 13,
    "kjsqq": "2022-03-01",
    "ids": [
        "5287b760c7d446549cac54e0a5f4e718"
    ]
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
 "result": {
   "req_id": "9bb713e666ab444ba16bbc4b3a1cd2bb",
   "success": true,
   "time": 71,
   "timestamp": 1669711225226
  },
 "value": {
   "code": "SUCCESS",
   "data": "人员[李四]信息已报送,不允许删除。若该人员已离退,请修改人员状态。<br>共选择了[2]个人员,其中[1]个人员被删除了。",
   "message": "成功!",
   "success": true
  }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

专项附加扣除查询

1、接口描述

该接口用于个税人员专项附加扣除信息查询。 同步接口

2、接口地址

POST /v1/GS/zxfjkc/query      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号
kcnd String 扣除年度
zjlx String 证件类型
zjhm String 证件号码
xm String 姓名
  • 示例参数
{
    "aggOrgId": "401671138175104",
    "nsrsbh": "91510116MA7LG*****",
    "kcnd": "2021",
    "xm": "万**",
    "zjhm": "41152*********891X",
    "zjlx": "201"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "42bb6198023540a6abb23a9a4fc6c20d",
        "success": true,
        "time": 394,
        "timestamp": 1653376971746
    },
    "value": {
        "code": "SUCCESS",
        "data": {
            "itsZxfjkcZbs": []
        },
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明
zjlx String 证件类型
zjhm String 证件号码
xm String 姓名
znjykcrs int 子女扣除人数
jxjykcrs int 继续教育扣除人数
sylrkcrs int 赡养老人扣除人数
zfdkkcrs int 住房贷款扣除人数
zfzjkcrs int 住房租金扣除人数
yyrzhkcrs int 婴幼儿照护费用扣除人数
poxm String 配偶姓名
pozjhm String 配偶证件号码
pozjlx String 配偶证件类型
pogjdm String 配偶国籍地区
sfyzzt String 配偶身份验证状态
bz String 备注
gxrq String 更新日期
cjly String 采集来源
zxfjkcJxjyzcList List集合 上述人员继续教育扣除明细
jxjylx String 继续教育类型(0为学历学位继续教育,1为职业资格继续教育)
jyjd String 教育阶段
fzrq String 发证日期
zsmc String 证书名称
zsbh String 证书编号
fzjg String 发证机关
zyzgjylx String 职业资格教育类型
kcyxqq String 扣除有效期起
kcyxqz String 扣除有效期止
zxfjkcSylrzcList List 赡养老人扣除明细
bsyrxm String 被赡养人姓名
bsyrzjlx String 被赡养人证件类型
bsyrzjhm String 被赡养人证件号码
qjdq String 国籍地区
ybsyrgx String 与被赡养人关系
bsyrcsrq String 被赡养人出生日期
sfdszn String 是否独生子女
ftfs String 分摊方式
bndykcje String 本年度月扣除金额
kcyxqq String 扣除有效期起
kcyxqz String 扣除有效期止
zxfjkcZfzjzcList list 住房租金支出
czflx String 出租方类型
czfxm String 出租房姓名(单位名称)
gzcs String 工作城市
czfzjlx String 出租方证件类型
sfzjhm String 出租方身份证件号码
fwzllph String 房屋坐落楼牌号
zfflhtbh String 住房租赁合同编号
zlqq String 租赁期起
zlqz String 租赁期止
kcyxqq String 扣除有效期起
kcyxqz String 扣除有效期止
zxfjkcZfdklxzcList list 住房贷款明细
fwzldz String 房屋坐落地址
fwlph String 房屋楼牌号
zslx String 证书类型
fwzsh String 房屋证书号
brsfjkr String 本人是否借款人(是/否)
sfhqdkhhkc String 是否婚前财产婚后扣除50(Y/N)
gjj_dkhtbh String 公积金贷款合同编号
gjj_schkrq String 首次还款日期
gjj_dkqx String 贷款期限
gjj_dkqx String 贷款期限
gjj_kcyxqq String 扣除有效期
gjj_kcyxqz String 扣除有效期止
sy_dkhtbh String 商业贷款合同编号
sy_schkrq String 商业贷款首次还款日期
sy_dkqx String 商业贷款贷款期限
sy_kcyxqq String 扣除有效期起
sy_kcyxqz String 扣除有效期止
sy_dkyh String 商业贷款银行
zxfjkcZnjyzcList List 子女教育支出
zngx String 子女关系
znxm String 子女姓名
znzjlx String 子女证件类型
znzjhm String 子女证件号码
zncsrq String 出生日期
zngjdq String 就读国家
sfyzzt String 身份验证状态
dqsjyjd String 受教育阶段
dqsjyjdq String 受教育阶段起
dqsjyjdz String 受教育阶段止
jyzzrq String 教育截止日期
jdgddq String 当前受教育阶段
jdxxmc String 就读学校
brkcbl String 本人扣除比例
kcyxqq String 扣除有效期起
kcyxqz String 扣除有效期止
zxfjkcYyrzhfyzcList list 婴幼儿照护费用支出
zngx String 子女关系
znxm String 子女姓名
znzjlx String 子女证件类型
znzjhm String 子女证件号码
zncsrq String 出生日期
zngjdq String 国家地区
brkcbl String 本人扣除比例
kcyxqq String 扣除有效期起
kcyxqz String 扣除有效期止
bz String 备注

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

专项附加扣除更新

1、接口描述

该接口用于更新客户端专项附加扣除最新数据。 异步接口

2、接口地址

POST /v1/GS/zxfjkc/xzZxfjkc      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号
kcnd String 扣除年度
kjsqq String 扣除所属期起
  • 示例参数
{
    "aggOrgId": "401671138175104",
    "nsrsbh": "91510116MA7LG*****",
    "kcnd": "2022",
    "kjsqq": "2022-01-01"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "33e12ed5c0e14dfba1ded06328bff572",
        "success": true,
        "time": 472,
        "timestamp": 1653377611643
    },
    "value": {
        "code": "SUCCESS",
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

申报数据专项附加扣除预填写

1、接口描述

该接口用于个税申报数据专项附加扣除预填写 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/ytzxfjkc      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号
kjsqq String 扣除所属期起
idList List 预填写扣除明细ID(对应的申报纳税人FB的明细id。不传默认查询该属期综合所得申报所有工资薪金的数据进行预填)
  • 示例参数
{
    "aggOrgId": "401671138175104",
    "nsrsbh": "91510116MA7LG*****",
    "kjsqq": "2022-01-01"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "42bb6198023540a6abb23a9a4fc6c20d",
        "success": true,
        "time": 394,
        "timestamp": 1653376971746
    },
    "value": {
        "code": "SUCCESS",
        "data": {
            "successCount": 0
        },
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明
successCount int 成功预填写人数

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

减除费用扣除6万更新接口

1、接口描述

该接口用于减除费用扣除6万更新接口 异步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/gxjcfyqrxx      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号
  • 示例参数
{
    "aggOrgId": "401671138175104",
    "nsrsbh": "91510116MA7LGREC7Q"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "be70e05f09b646adb4cb7a51df7d4718",
        "success": true,
        "time": 172,
        "timestamp": 1655188329370
    },
    "value": {
        "code": "SUCCESS",
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

申报表填写

1、接口描述

该接口用于个税申报表填写。目前支持综合所得下的正常工资薪金、全年一次性奖金、劳务报酬(一般劳务、其他非联系劳务) 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/receiveSbb      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号(两者其一必填)
kjywrid Int 扣缴义务人ID(两者其一必填)
bblx String 报表类型(1、综合、2分类 3、非居民)
kjsqq Date 扣缴属期起
kjsqz Date 扣缴属期止
dkdjNsrfbList 以下内容属于集合数据
xm String 员工姓名
zjhm String 证件号码
zjlx String 证件类型
zspmdm String 征收项目代码
sdxmdm String 所得项目代码(劳务报酬必填)
sre Float 本期收入(该字段通用其他申报表的计税收入额:
一次性补偿收入,一次性补贴收入,全年一次性奖金额,年金领取收入额,
当月取得数月奖金额,收入,本月股权激励收入,本期收入)
ljsre Float 累计收入额(个人股权激励本年累计股权激励收入)
fy Float 费用
ljmssd Float 累计免税所得
ywsjfe Float 已完税费额
qbjfe Float 全部缴费额
mssd Float 免税所得
jbylf Float 基本养老保险
jbybf Float 基本医疗保险
sybxf Float 失业保险费
zfgjj Float 住房公积金
jajsbl Float 按减计比例(值只能为0%,50%或者100%)
ccyz Float 财产原值
zycb Float 展业成本
yxkcfye Float 允许扣除的税费(0411、0412等劳务报酬表单填写)
sqkcxmqt Float 税前扣除项目其他
tzdk Float 投资抵扣(0915、0989表单填写)
nj Float 年金
syjkx Float 商业健康保险费
zykcjze Float 准予扣除转赠额
ftyf Long 分摊月份(年金领取、内退一次性补偿、提前退休一次性补贴填写)
sftgccyz String 是否提供财产原值(Y 是、 N 否 非居民财产转让、分类财产租赁、转让附表填写)
xdsl String 协定税率(为空 表示不享受。)
sl Float 税率(财产租赁选择填写 0.1或者 0.2)
sfycxlq String 是否一次性领取(0 是 、 1 否)
njlqfs String 年金领取方式(一次性领取选否时领取方式选择:"按月", "按季","按年")
njlqyy String 年金领取原因(是一次性领取时必填:"出国定居或个人死亡", "其他"两种)
sygs String 适用公式
jnts Long 境内工作天数
jwts Long 境外工作天数
jnzf Float 境内支付
jwzf Float 境外支付
znjyzc Float 子女教育支出
zfdklxzc Float 住房贷款
zfzjzc Float 住房租金
sylrzc Float 赡养老人
jxjyzc Float 继续教育支出
yyrzhfyzc Float 婴幼儿照护费用支出
bz String 备注(其他扣除金额填写后该字段必录)
ssxdjmje Float 税收协定减免金额(填写后需要维护税收协定附表)
yikjse Float 已预缴税额(个人股权激励对应本年累计已预缴)
dyxylbx Float 递延性养老保险(目前只有福建支持)
jmje Float 减免金额
yxbz String 有效标志(N=删除状态 默认Y=有效状态)
jmxxList 减免税额大于0 或免税收入大于0时填写 减免信息附表
jmsxdm String 减免事项代码
jmxzdm String 减免性质代码
jmse Float 金额
jmfs String 减免方式(1、免税所得 2、减免税额)
syjkbxList 商业健康附表(减免税额大于0 或免税收入大于0时填写 减免信息附表)
sysbh String 税优识别号
ndbf Float 年度保费
ydbf Float 月度保费
bdsxrq date 保单生效日期
bqkcje Float 本期扣除金额
  • 示例参数
//1.综合所得申报 nsrfb可支持多个也可单个附表填写 各附表填写规则请参考规则说明文档

{
    "aggOrgId": "401671138175104",
    "nsrsbh": "91510116MA7LG*****",
    "bblx": "1",
    "kjsqq": "2022-04-01",
    "kjsqz": "2022-04-30",
     "dkdjNsrfbList":[
        {    
            "xm":"周x", //姓名
            "zjlx":"201",//证件类型
"zjhm":"430898919190091123",//证件号码
            "zspmdm":"0101",//征收品目 -工资薪金
            "sre":5000,//本期收入额
            "mssd":0,//免税所得
            "jbylf":0,//基本养老保险
            "jbybf":0,//基本医疗保险
            "sybxf":0, //失业保险
            "zfgjj":0,//住房公积金
            "nj":0, //企业职业年金
            "syjkx":0,//商业健康保险
            "dyxylbx":0,//税优递延养老保险费
            "sqkcxmqt":0,//税前扣除其他
            "zykcjze":0,//准予扣除捐赠额
            "jmje":0 ,  //减免金额 
"bz": ""  //备注 
        },{    
            "xm":"周x", //姓名
            "zjlx":"201",//证件类型
"zjhm":"430898919190091123",//证件号码
            "zspmdm":"0103",//征收品目 -全年一次性奖金 
            "sre":5000,//一次性奖金收入
            "mssd":0,//免税所得
            "sqkcxmqt":0,
            "zykcjze":0,//准予扣除捐赠额
            "jmje":0   //减免金额
        },{    
            "xm":"周x", //姓名
            "zjlx":"201",//证件类型
"zjhm":"430898919190091123",//证件号码
            "zspmdm":"0107",//征收品目 -内退一次性补偿金 
            "sre":5000,//一次性补偿收入 
"ftyf":10,//分摊月份 1-99 整数 
            "mssd":0,//免税所得
            "sqkcxmqt":0,//税前扣除其他
"zykcjze":0,//准予扣除捐赠额
            "jmje":0   //减免金额
        },{    
            "xm":"周x", //姓名
            "zjlx":"201",//证件类型
"zjhm":"430898919190091123",//证件号码
            "zspmdm":"0108",//征收品目 -解除劳动合同一次性补偿金 
            "sre":5000,//一次性补偿收入
            "mssd":0,//免税所得
            "sqkcxmqt":0,//税前扣除其他
"zykcjze":0,//准予扣除捐赠额
            "jmje":0   //减免金额
        },{    
            "xm":"周x", //姓名
            "zjlx":"201",//证件类型
"zjhm":"430898919190091123",//证件号码
            "zspmdm":"0109",//征收品目 -个人股权激励收入 
            "sre":5000,// 本月股权激励收入
"ljsre":10000,// 本年累计股权激励收入(不含本月)
            "mssd":0,//免税所得
            "ljqtkchj":0,//本年累计其他
"zykcjze":0,//准予扣除捐赠额
            "ljjmje":0,   //本年累计减免金额
"yikjse":0   //本年累计已扣缴税额
        },{
              "xm":"何XX",
              "zjlx":"201",
              "zjhm":"4501xxxxx0154X",
              "zspmdm":"0110",//征收品目 -年金领取 
              "sre":"100", //年金领取收入额
"qbjfe":"100",//全部缴费额
"ywsjfe":"100",//已完税缴费额
              "sfycxlq":"1",//是否一次性领取  0 :是   1:否
              "njlqfs":"按月",//非一次性领取 选择领取方式 按月、按季、按年
"njlqyy":"其他",//一次性领取时选择领取原因"出国定居或个人死亡", "其他"
              "mssd":0,//免税所得
              "syjkx":0,//商业健康保险
            "dyxylbx":0,//税优递延养老保险费
            "sqkcxmqt":0,//税前扣除其他
            "zykcjze":0,//准予扣除捐赠额
            "jmje":0   //减免金额
           },{
            "xm":"周x", //姓名
            "zjlx":"201",//证件类型
"zjhm":"430898919190091123",//证件号码
            "zspmdm":"0111",//征收品目 -提前退休一次性补贴 
            "sre":5000,// 一次性补贴收入
            "mssd":0,//免税所得
"ftyf":10,//分摊年度数 1-99 整数
            "sqkcxmqt":0,//税前扣除其他
"zykcjze":0,//准予扣除捐赠额
            "jmje":0   //减免金额
        },{
            "xm":"周x", //姓名
            "zjlx":"201",//证件类型
"zjhm":"430898919190091123",//证件号码
            "zspmdm":"0411",//征收品目 -劳务报酬所得(保险营销员、证券经纪人) 
            "sdxmdm":"0402",//所得项目代码
"sre":5000,//本期收入额
             "mssd":0,//免税所得
             "syjkx":0,//商业健康保险
             "dyxylbx":0,//税优递延养老保险费
             "sqkcxmqt":0,//税前扣除其他
             "zykcjze":0,//准予扣除捐赠额
             "jmje":0   //减免金额
        },{
            "xm":"周x", //姓名
            "zjlx":"201",//证件类型
"zjhm":"430898919190091123",//证件号码
            "zspmdm":"0412",//征收品目 -劳务报酬所得(一般劳务、其它劳务) 
            "sdxmdm":"0401",//所得项目代码 选择 0401 或者0499
"sre":5000,//本期收入额
             "mssd":0,//免税所得
             "syjkx":0,//商业健康保险
             "dyxylbx":0,//税优递延养老保险费
             "sqkcxmqt":0,//税前扣除其他
             "zykcjze":0,//准予扣除捐赠额
             "jmje":0   //减免金额
        },{
            "xm":"周x", //姓名
            "zjlx":"201",//证件类型
"zjhm":"430898919190091123",//证件号码
            "zspmdm":"0500",//征收品目 -稿酬所得 
            "sre":5000,// 本期收入
            "mssd":0,//免税所得
            "sqkcxmqt":0,//税前扣除其他
            "jmje":0   //减免金额
        },{
            "xm":"周x", //姓名
            "zjlx":"201",//证件类型
"zjhm":"430898919190091123",//证件号码
            "zspmdm":"0600",//征收品目 -特殊权使用费 
            "sre":5000,// 本期收入
            "mssd":0,//免税所得
            "sqkcxmqt":0,//税前扣除其他
            "jmje":0   //减免金额
        }]
} 

//2、分类所得申报表

{
    "aggOrgId": "401671138175104",
    "nsrsbh": "91510116MA7LG*****",
    "bblx": "2",
    "kjsqq": "2022-04-01",
    "kjsqz": "2022-04-30",
 "dkdjNsrfbList":[
        {
            "xm":"周X", //姓名
            "zjlx":"201",
"zjhm":"430681xxxx8446",
            "zspmdm":"0700",//征收品目 -利息股息红利所得
"sdxmdm":"0738",//所得项目
            "sre":"100",//本期收入
"mssd":0,//免税收入
            "jajsbl":"0%",//减按计税比例 0% ,50%,100% 三项选择
            "zykcjze":0,//准予扣除捐赠额
"jmje":0   //减免金额
        },{
            "xm":"何XX",
            "zjlx":"201",
"zjhm":"4501xxxx20154X",
            "zspmdm":"0899",//征收品目 -财产租赁所得
            "sre":"100",
"mssd":0,//免税收入
            "sdxmdm":"080001",//所得项目
"yxkcfye":"0",//允许扣除的税费
            "sl":"0.1", //税率 固定传入 0.1 、 0.2 两种税率
            "zykcjze":0,//准予扣除捐赠额
"jmje":0   //减免金额
        },
        {
            "xm":"周X",
            "zjlx":"201",
            "zspmdm":"0989",//财产转让所得
            "sre":"100",
"mssd":0,//免税收入
            "sdxmdm":"0906",//所得项目
            "sftgccyz":"Y",//是否提供财产原值凭证
            "sl":"0.2",//税率 固定 0.2 可不传
            "zjhm":"430xxx38446",
            "ccyz":100,//财产原值
"yxkcfye":0,//允许扣除的税费
"tzdk":0,//投资抵扣
"zykcjze":0,//准予扣除捐赠额
"sqkcxmqt":0,//税前扣除其他
"jmje":0   //减免金额
        },
        {
            "xm":"何XX",
            "zjlx":"201",
"zjhm":"45012xxxxx54X",
            "zspmdm":"1000",//偶然所得
            "sre":"10",
"mssd":0,//免税收入
            "sdxmdm":"1038",//所得项目
"zykcjze":0,//准予扣除捐赠额
"jmje":0   //减免金额
        }
    ]
}

//3、非居民所得申报

{
    "aggOrgId": "401671138175104",
    "nsrsbh": "91510116MA7LG*****",
    "bblx": "3",
    "kjsqq": "2022-04-01",
    "kjsqz": "2022-04-30",
 "dkdjNsrfbList":[
        {
            "xm":"柯XX",
            "zjlx":"210",
            "zjhm":"H00971146",
            "zspmdm":"0102",//无住所个人正常工资薪金
"sygs":"sygs02_fgg183",//适用公式 传参后自动计算sre无需传参
"jnts":"100", //境内天数选择公式时候传
"jwts":"10", //境外天数选择公式时候传
"jnzf":"200", //境内支付选择公式时候传
"jwzf":"200", //境外支付选择公式时候传
            "sre":"5000", //收入 – 手动传本期收入无需传适用公式等参数
"mssd":0,//免税收入
"sqkcxmqt":0,//税前扣除其他
            "zykcjze":"0",//准予扣除转赠额 
            "jmje":"0"
        },{
            "xm":"柯XX",
            "zjlx":"210",
            "zjhm":"H00971146",
            "zspmdm":"0104",//无住所数月奖金
"sygs":"sygs02_fgg183",//适用公式 传参后自动计算sre无需传参
"jnts":"100", //境内天数选择公式时候传
"jwts":"10", //境外天数选择公式时候传
"jnzf":"200", //境内支付选择公式时候传
"jwzf":"200", //境外支付选择公式时候传
            "sre":"5000", //收入 – 手动传本期收入无需传适用公式等参数
"mssd":0,//免税收入
"sqkcxmqt":0,//税前扣除其他
            "zykcjze":"0",//准予扣除转赠额 
            "jmje":"0"
        },{
            "xm":"柯XX",
            "zjlx":"210",
            "zjhm":"H00971146",
            "zspmdm":"0118",//非居民解除劳动合同一次性补偿金 
            "sre":"5000", //一次性补偿收入
"sqkcxmqt":0,//税前扣除其他
            "zykcjze":"0",//准予扣除转赠额 
            "jmje":"0"
        },{
            "xm":"柯XX",
            "zjlx":"210",
            "zjhm":"H00971146",
            "zspmdm":"0119",//非居民个人股权激励
"sygs":"sygs02_fgg183",//适用公式 传参后自动计算sre无需传参
"jnts":"100", //境内天数选择公式时候传
"jwts":"10", //境外天数选择公式时候传
"jnzf":"200", //境内支付选择公式时候传
"jwzf":"200", //境外支付选择公式时候传
            "sre":5000,// 本月股权激励收入– 手动传本期收入无需传适用公式等参数
"ljsre":10000,// 本年累计股权激励收入(不含本月)
            "mssd":0,//免税所得
            "ljqtkchj":0,//本年累计其他
"zykcjze":0,//准予扣除捐赠额
            "ljjmje":0,   //本年累计减免金额
"yikjse":0   //本年累计已扣缴税额
        },{
            "xm":"柯XX",
            "zjlx":"210",
            "zjhm":"H00971146",
            "zspmdm":"0430",//非居民劳务报酬
"sdxmdm":"0401",//非居民劳务报酬所得项目
            "sre":"5000", //
"mssd":0,//免税收入
"sqkcxmqt":0,//税前扣除其他
"yxkcfye":0,//允许扣除的税费
            "zykcjze":"0",//准予扣除转赠额 
"ssxdjmse":"0",//税收协定减免税额
            "jmje":"0"
        },{
            "xm":"柯XX",
            "zjlx":"210",
            "zjhm":"H00971146",
            "zspmdm":"0501",//非居民稿酬所得
            "sre":"5000", //
"mssd":0,//免税收入
            "zykcjze":"0",//准予扣除转赠额
            "jmje":"0"
        },{
            "xm":"柯XX",
            "zjlx":"210",
            "zjhm":"H00971146",
            "zspmdm":"0603",//非居民特许权使用费所得
            "sre":"5000", //
"mssd":0,//免税收入
            "zykcjze":"0",//准予扣除转赠额
"xdsl":"不享受",//协定税率,参考客户端传参 5%,6%..... 
            "jmje":"0"
        },{
            "xm":"柯XX",
            "zjlx":"210",
            "zjhm":"H00971146",
            "zspmdm":"0701",//非居民利息股息红利所得
"sdxmdm":"0731",//非居民利息股息红利所得项目
            "sre":"5000", //
"mssd":0,//免税收入
"jajsbl":0%,//减按计税比例  50% 、0% 、100%传参规则
            "zykcjze":"0",//准予扣除转赠额
"xdsl":"不享受",//协定税率,参考客户端传参 5%,6%..... 
            "jmje":"0"
        } ,{
            "xm":"柯XX",
            "zjlx":"210",
            "zjhm":"H00971146",
            "zspmdm":"0898",//非居民财产租赁所得
"sdxmdm":"080001",//非居民财产租赁所得所得项目 080001、080002
            "sre":"5000", //
"mssd":0,//免税收入
"sl":0.1,//税率
"yxkcfye":0,//允许扣除的税费
            "zykcjze":"0",//准予扣除转赠额
            "jmje":"0"
        },{
            "xm":"柯XX",
            "zjlx":"210",
            "zjhm":"H00971146",
            "zspmdm":"0999",//非居民财产转让所得
"sdxmdm":"0906",//所得项目
"sre":"5000", //
"mssd":0,//免税收入
            "sftgccyz":"Y",//是否提供财产原值凭证
            "sl":"0.2",//税率
            "ccyz":100,//财产原值
"yxkcfye":0,//允许扣除的税费
"zykcjze":0,//准予扣除捐赠额
"sqkcxmqt":0,//税前扣除其他
"jmje":0   //减免金额
        },{
            "xm":"柯XX",
            "zjlx":"210",
            "zjhm":"H00971146",
            "zspmdm":"1001",//非居民偶然所得
"sdxmdm":"1031",//所得项目
"sre":"5000", //
"mssd":0,//免税收入
"zykcjze":0,//准予扣除捐赠额
"jmje":0   //减免金额
        }
    ]
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "f85f870150b140c2b6b366ee5f2935d8",
        "success": true,
        "time": 4617,
        "timestamp": 1653446308573
    },
    "value": {
        "code": "SUCCESS",
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

减免信息维护

1、接口描述

该接口用于个税减免信息维护。有【免税收入】或【减免税额】的人员,需要填写。 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/jmxxwh      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
param List
sbid String 申报id
nsrfbid String 纳税人附表ID
nsrid String 人员员工ID
zjhm String 证件号码
jmfs String 减免方式(1、免税所得 2、减免税额)
zspmdm String 征收品目代码
jmsxdm String 减免事项代码
jmxzdm String 减免性质代码
jmse float 减免税额
  • 示例参数
{
    "aggOrgId": "401671138175104",
    "param": [
        {
            "sbid": "7d331d04fbd04078bf971e534572780f",
            "nsrfbid": "1881b0c0e815420fa4c0175d60f8fb9b",
            "nsrid": "5287b760c7d446549cac54e0a5f4e718",
            "zjhm": "41152*********891X",
            "jmfs": "1",
            "zspmdm": "0101",
            "jmsxdm": "222",
            "jmxzdm": "333",
            "jmse": "1000"
        }
    ]
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "e5fe838010a147e18235a697cb9a0abe",
        "success": true,
        "time": 344,
        "timestamp": 1653472944556
    },
    "value": {
        "code": "SUCCESS",
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

商业健康险信息维护

1、接口描述

该接口用于个税商业健康险信息维护 。有【商业健康保险】的人员,需要填写。 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/syjkxwh      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
param List
sbid String 申报id
nsrfbid String 纳税人附表ID
nsrid String 人员员工ID
xm String 姓名
zjlx String 证件类型
zjhm String 证件号码
sysbh String 税优识别号
ndbf float 年度保费
ydbf float 月度保费
bdsxrq Date 减免性质代码
bqkcje float 本期扣除金额
  • 示例参数
{
    "aggOrgId": "401671138175104",
    "param": [
        {
            "sbid": "7d331d04fbd04078bf971e534572780f",
            "nsrfbid": "1881b0c0e815420fa4c0175d60f8fb9b",
            "nsrid": "5287b760c7d446549cac54e0a5f4e718",
            "xm": "万**",
            "zjlx": "201",
            "zjhm": "41152*********891X",
            "sysbh": "123111",
            "ndbf": "1000",
            "ydbf": "500",
            "bdsxrq": "1111",
            "bqkcje": "100"
        }
    ]
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "33c98babf985425fb56779f186b82136",
        "success": true,
        "time": 7355,
        "timestamp": 1653473293672
    },
    "value": {
        "code": "SUCCESS",
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

税延养老保险附表维护接口

1、接口描述

该接口用于税延养老保险附表维护接口.目前只有试点地区需要 。试点地区包括:上海、福建(含厦门)、苏州的工业园。 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/syylbxwh      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
param List 税延养老保险附表数组
sbid String 申报id
nsrid String 纳税人ID
nsrfbid String 纳税人附表ID
syylzh String 税延养老账号编号
bsjym String 报税校验码 (4位数字)
ndbf float 年度保费
ydbf float 月度保费
bqkcje float 本期扣除金额
zspmdm String 征收品目代码
  • 示例参数
{
    "aggOrgId": "406485007040704",
    "param": [
        {
            "sbid": "eeb7a72e00aa44cda94ae4fdfb24b427",
            "nsrid": "8204f8a0f7834eb799fb53ece6bf89b1",
            "nsrfbid": "b41ae150ff5a4da0935aaed20721f171",
            "syylzh": "099991231",
            "bsjym": "1234",
            "ndbf": 2022,
            "ydbf": 12,
            "bqkcje": 100,
            "zspmdm": "0101"
        }
    ]
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result":{
        "req_id":"b20011ce77fc41e1bfc90b3daa4e672a",
        "success":true,
        "time":114,
        "timestamp":1655102982530
    },
    "value":{
        "code":"SUCCESS",
        "success":true,
        "message":"成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

准予扣除捐赠附表维护接口

1、接口描述

该接口用于准予扣除捐赠附表维护。有【准予扣除的捐赠额】的人员需要填写。 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/zykcjzwh      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
param List 准予扣除捐赠附表数组
sbid String 申报id
nsrid String 纳税人ID
nsrfbid String 纳税人附表ID
zspmdm String 征收品目代码
szdwmc String 受赠单位名称
szdwnsrsbh String 受赠单位纳税人识别号
jzpzh String 捐赠凭证号
jzrq Date 捐赠日期
jzje float 转赠金额
kcbl String 扣除比例
sjkcje float 实际扣除金额
bz String 备注
  • 示例参数
{
    "aggOrgId": "406485007040704",
    "param": [
        {
            "sbid": "eeb7a72e00aa44cda94ae4fdfb24b427",
            "nsrid": "8204f8a0f7834eb799fb53ece6bf89b1",
            "nsrfbid": "b41ae150ff5a4da0935aaed20721f171",
            "zspmdm": "0101",
            "szdwmc": "",
            "szdwnsrsbh": "",
            "jzpzh": "22211",
            "jzrq": "2022-01-01",
            "jzje": "1000",
            "kcbl": "30%",
            "sjkcje": "200",
            "bz": "无"
        }
    ]
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result":{
        "req_id":"b20011ce77fc41e1bfc90b3daa4e672a",
        "success":true,
        "time":114,
        "timestamp":1655102982530
    },
    "value":{
        "code":"SUCCESS",
        "success":true,
        "message":"成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

个人股权转让附表维护接口

1、接口描述

该接口用于个人股权转让附表维护接口 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/gqzrwh      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
sbid String 申报id
nsrid String 纳税人ID
gqzrsblx String 股权转让申报类型(1、扣缴义务人申报 2、被投资企业申报)
btzqyshxydm String 被投资企业社会信用代码(股权转让申报类型 选择2 时可为空,系统自动默认)
btzqymc String 被投资企业名称(股权转让申报类型 选择2 时可为空,系统自动默认)
gqzrsj Date 股权转让时间
zrsqyzmjzzje float 转让时企业账面净资产金额
sszb float 实收资本
zbgj float 资本公积
yygj float 盈余公积
wfplr float 未分配利润
qt float 其他
gdzcqyzrjzz float 拥有规定资产的企业转让时净资产价值
crfxm String 出让方姓名
crfnsrsbh String 出让方纳税人识别号
btzqyzczb float 被投资企业注册资本(股权转让申报类型 选择2 时可为空,系统自动默认)
grgqzrmxes List 以下属于股权转让明细表
zrhtbh String 转让合同编号
gqzrfe float 个人股权转让份额
zrgqzzgbz int 转让股权占总股比重(0-100 范围)
gqzrhtxyjg float 股权转让合同协议价格
gqyz float 股权原值
xghlsf float 相关合理税费
sffqns String 是否分期纳税(是\否)
srflx String 受让方类型传中文(自然人\组织)
srfsf String 受让方所在省份(受让方类型 为组织时候传递,自然人无需该参数)
srfnsrsbh String 受让方纳税人识别号
srfnsrmc String 受让方纳税人名称
ycrfgx String 与股权出让方关系传 (直系亲属\非直系亲属)
srfbz String 受让方备注
babh String 备案编号
crfbz String 出让方备注
  • 示例参数
{
    "aggOrgId": "401671138175104",
    "sbid": "eeb7a72e00aa44cda94ae4fdfb24b427",
    "nsrid": "8204f8a0f7834eb799fb53ece6bf89b1",
    "gqzrsblx": "2",
    "gqzrsj": "2022-05-30",
    "grgqzrmxes": [
        {
            "zrhtbh": "123",
            "gqzrfe": "12",
            "zrgqzzgbz": "30",
            "gqzrhtxyjg": "123",
            "gqyz": "123",
            "xghlsf": "12",
            "sffqns": "否",
            "srflx": "自然人",
            "srfsf": "成都",
            "srfnsrsbh": "12",
            "srfnsrmc": "12",
            "ycrfgx": "非直系亲属",
            "babh": "备案编号"
        }
    ]
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "eee1badbfcb347abb7ed793cbfc209a7",
        "success": true,
        "time": 198,
        "timestamp": 1655705978416
    },
    "value": {
        "code": "SUCCESS",
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

税收协定附表接口

1、接口描述

该接口用于税收协定附表接口 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/fjmssxd      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
sbid String 申报id
nsrid String 纳税人ID
jmgdq String 居民国地区(在居民国地区代码,默认出生地)
jmgmc String 在居民国名称
jmgnsrsbh String 在居民国纳税识别号
ssxd Sting 享受协定名称
syxdtk String 适用协定条款名称
sfqdsszm String 非居民纳税是否取得缔约对方税务主管当局得证明(是、否)
fjmsyrzctk String 适用股息、利息、特殊权使用费条款时、非居民纳税人为受益人政策
syxdtk 选择特殊权使用费、股息、利息时必填
sm String 说明
nsrfbid String 纳税人附表ID
zzglxfs String 在中国联系方式(默认纳税人基础信息手机号码)
  • 示例参数
{
    "aggOrgId": "401671138175104",
    "sbid": "eeb7a72e00aa44cda94ae4fdfb24b427",
    "nsrid": "8204f8a0f7834eb799fb53ece6bf89b1",
    "jmgdq": "33",
    "jmgmc": "居民国名称",
    "jmgnsrsbh": "居民国纳税识别号",
    "ssxd": "享受协定名称",
    "syxdtk": "适用协定条款名称",
    "sfqdsszm": "否"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "fb77460d647c4f2ba221fbc6fa2618a0",
        "success": true,
        "time": 175,
        "timestamp": 1655691587359
    },
    "value": {
        "code": "SUCCESS",
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

重新获取累计数接口

1、接口描述

该接口用于重新获取客户端累计数。 异步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/getKhdSblj      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号
kjsqq String 申报属期起
jcfygx Boolean 减除费用更新(是/否,不传则默认为否)
  • 示例参数
{
    "aggOrgId": "428233065*****28",
    "nsrsbh": "91130322M*****W2L",
    "kjsqq": "2022-10-01"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "d51cf07b9fff41ab84877fffbd7419b1",
        "success": true,
        "time": 211,
        "timestamp": 1665985397865
    },
    "value": {
        "code": "SUCCESS",
        "data": {
            "msg": "已发送获取累计预缴请求"
        },
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

申报表税款计算

1、接口描述

该接口用于个税申报表税款计算 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/alculationcNsrfb      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号
nsrmc String 纳税人名称
kjsqq String 申报属期起
kjsqz String 申报属期止
bblx String 报表类型
  • 示例参数
{
    "aggOrgId": "401671138175104",
    "nsrsbh": "91510116MA7LG*****",
    "nsrmc": "成都******设备有限公司",
    "kjsqq": "2022-03-01",
    "kjsqz": "2022-03-31",
    "bblx": "1"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "9c1f7471ab744e78aebcd3ded3534be2",
        "success": true,
        "time": 104,
        "timestamp": 1654500924910
    },
    "value": {
        "code": "SUCCESS",
        "data": null,
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

申报发送

1、接口描述

该接口用于个税申报数据的发送。 异步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/apiSendSbb      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
param List 传入批量的申报企业信息
nsrsbh String 纳税人识别号
nsrmc String 纳税人名称
kjsqq Date 申报属期起
kjsqz Date 申报属期止
bblx String 报表类型
  • 示例参数
{    
    "aggOrgId": 401671138175104,
    "param": [
        {
            "nsrsbh": "91510116****REC7Q",
            "nsrmc": "成都******设备有限公司",
            "kjsqq": "2022-04-01",
            "kjsqz": "2022-04-30",
            "bblx": "1"
        }
    ]
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "287e974f42654fe784098a89613c5a47",
        "success": true,
        "time": 548,
        "timestamp": 1665986513378
    },
    "value": {
        "code": "SUCCESS",
        "data": [
            {
                "msg": "申报发送成功",
                "nsrsbh": "91510116****REC7Q",
                "nsrmc": "成都******设备有限公司",
                "fssbCode": "1"
            }
        ],
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明
nsrsbh String 纳税人识别号
bblx String 申报种类
kjsqq String 申报属期
fssbCode String 申报发送状态1已发送 0 发送失败
msg String 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

批量申报发送

1、接口描述

该接口用于批量个税申报数据的发送。

2、接口地址

POST /v1/GS/dkdj/sbxx/batchApiSendSbb      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
param List 传入批量的申报企业信息
nsrsbh String 纳税人识别号
nsrmc String 纳税人名称
kjsqq Date 申报属期起
kjsqz Date 申报属期止
bblx String 报表类型
  • 示例参数
[
    {
        "aggOrgId":401671138175104,
        "param":[
            {
                "nsrsbh":"9151xxxMA7LGREC7Q",
                "nsrmc":"成都******设备有限公司",
                "kjsqq":"2022-04-01",
                "kjsqz":"2022-04-30",
                "bblx":"1"
            }
        ]
    },
    {
        "aggOrgId":401671138175105,
        "param":[
            {
                "nsrsbh":"9151yyyyUY8HGREC6E",
                "nsrmc":"四川******有限公司",
                "kjsqq":"2022-04-01",
                "kjsqz":"2022-04-30",
                "bblx":"1"
            }
        ]
    }
]

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result":{
        "req_id":"4d56e5e59ccb4a1087f601980ebe281c",
        "success":true,
        "time":887,
        "timestamp":1653449463671
    },
    "value":[
        {
            "code":"SUCCESS",
            "aggOrgId":401671138175104,
            "data":[
                {
                    "msg":"纳税人:[91510116MA7LG*****]存在待反馈的人员信息,请等待人员报送完后再进行申报",
                    "nsrsbh":"91510116MA7LG*****",
                    "nsrmc":"成都******设备有限公司",
                    "fssbCode":"0"
                }
            ],
            "success":true,
            "message":"成功!"
        },
        {
            "code":"BUSINESS_ERROR",
            "success":false,
            "aggOrgId":401671138175105,
            "message":"没有找到对应的企业!"
        }
    ]
}
  • 字段说明
字段名 字段类型 说明
nsrsbh String 纳税人识别号
bblx String 申报种类
kjsqq String 申报属期
fssbCode String 申报发送状态1已发送 0 发送失败
msg String 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

申报更正

1、接口描述

该接口用于个税申报更正接口。申报成功的人员才能更正。 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/gzSbb      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号
nsrmc String 纳税人名称
kjsqq Date 申报属期起
kjsqz Date 申报属期止
bblx String 报表类型
  • 示例参数
{
    "aggOrgId": 401671138175104,
    "nsrsbh": "91510116MA7LG*****",
    "nsrmc": "成都******设备有限公司",
    "kjsqq": "2022-04-01",
    "kjsqz": "2022-04-30",
    "bblx": "1"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "3fb62938abc94754b5aee80192bc9867",
        "success": true,
        "time": 91,
        "timestamp": 1655273551396
    },
    "value": {
        "code": "SUCCESS",
        "data": null,
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200
BUSINESS_ERROR 该纳税人申报属期:2022-04-01申报状态为[已填写未申报],不允许进行申报更正操作!

撤销更正

1、接口描述

该接口用于个税撤销更正。 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/cxGzSbb    HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号
nsrmc String 纳税人名称
kjsqq Date 申报属期起
kjsqz Date 申报属期止
bblx String 报表类型
  • 示例参数
{
    "aggOrgId": 401671138175104,
    "nsrsbh": "91510116MA7LG*****",
    "nsrmc": "成都******设备有限公司",
    "kjsqq": "2022-04-01",
    "kjsqz": "2022-04-30",
    "bblx": "1"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "0c60455593574f2ca864ea8ae43c0f92",
        "success": true,
        "time": 73,
        "timestamp": 1655273830692
    },
    "value": {
        "code": "SUCCESS",
        "data": null,
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200
BUSINESS_ERROR 该纳税人数据未进行更正,无法撤销更正

税款缴纳

1、接口描述

该接口用于个税批量税款缴纳。支持三方协议缴款和银行端缴税凭证下载。 异步接口

2、接口地址

POST /v1/GS/dkdj/sbjs/plskjn      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrList List 扣缴义务人识别号List
kjsqq String 申报属期起
bblx String 申报报表类型
jkfs String 缴款方式(1、三方协议缴款 2、银行端缴税凭证下载)
sfxyh String 三方协议号
  • 示例参数
{    
    "aggOrgId":"401671138175104",
    "nsrList":["91510116MA7LG*****"],
    "kjsqq":"2022-04-01",
    "bblx":"1",
    "jkfs":"1",
    "sfxyh":"三方协议号"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "f54d8ecc490b4dac826d856c3aeb8e86",
        "success": true,
        "time": 496,
        "timestamp": 1653457373639
    },
    "value": {
        "code": "SUCCESS",
        "data": [
            {
                "nsrsbh": "91510116MA7LG*****",
                "jkCode": "1"
            }
        ],
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明
nsrsbh String 纳税人识别号
kjsqq String 申报属期
jkCode String 申报缴款发送状态1、已发送 0 发送失败
msg String 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200
BUSINESS_ERROR 请求纳税人集合不存在

作废银行端缴款凭证

1、接口描述

该接口用于个税作废银行端缴款凭证接口 异步接口

2、接口地址

POST /v1/GS/dkdj/sbjs/zfYhdcxjs      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
sbid String 申报主表ID
  • 示例参数
{
    "aggOrgId": 401671138175104,
    "sbid": "7d331d04fbd04078bf971e534572780f"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "503ad38688f6463da2fb57c8b51e34c5",
        "success": true,
        "time": 303,
        "timestamp": 1653462544687
    },
    "value": {
        "code": "BUSINESS_ERROR",
        "success": false,
        "message": "缴款凭证状态不为[获取成功]或[作废失败]时不能作废"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业 200
BUSINESS_ERROR 缴款凭证状态不为[获取成功]或[作废失败]时不能作废

获取银行端查询缴税PDFurl

1、接口描述

该接口用于个税获取银行端查询缴税PDFurl 同步接口

2、接口地址

POST /v1/GS/dkdj/sbjs/getYhdjkpzUrl      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
sbid String 申报主表ID
  • 示例参数
{
    "aggOrgId": 401671138175104,
    "sbid": "7d331d04fbd04078bf971e534572780f"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "41487946a7664e54be27916488df1bfd",
        "success": true,
        "time": 398,
        "timestamp": 1653457907021
    },
    "value": {
        "code": "BUSINESS_ERROR",
        "success": false,
        "message": "91510116MA7LG*****的申报信息不存在,请传入有效申报ID"
    }
}
  • 字段说明
字段名 字段类型 说明
url String 银行端查询缴税地址

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200
BUSINESS_ERROR 纳税人*公司未成功获取银行端查询缴税凭证,请重新获取银行端查询缴税

申报作废

1、接口描述

该接口用于个税申报作废,申报成功,未缴款的人员才能作废。 异步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/zfSbb      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号
nsrmc String 纳税人名称
kjsqq Date 申报属期起
kjsqz Date 申报属期止
bblx String 报表类型
  • 示例参数
{
    "aggOrgId": 401671138175104,
    "nsrsbh": "91510116MA7LG*****",
    "nsrmc": "成都******设备有限公司",
    "kjsqq": "2022-04-01",
    "kjsqz": "2022-04-30",
    "bblx": "1"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "085b1d099b994d5d97745737c0ff765c",
        "success": true,
        "time": 101,
        "timestamp": 1665988140202
    },
    "value": {
        "code": "SUCCESS",
        "data": null,
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

个税申报情况查询

1、接口描述

该接口用于企业个税申报情况查询 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/getSbxx      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号
nsrmc String 纳税人名称
kjsqq Date 申报属期起
bblx String 申报表类型(不传默认查所有)
  • 示例参数
{
    "aggOrgId": 401671138175104,
    "nsrsbh": "91510116MA7LG*****",
    "nsrmc": "成都******设备有限公司",
    "kjsqq": "2022-04-01",
    "bblx": "1"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "a174f58ea523419792686998b19bf990",
        "success": true,
        "time": 428,
        "timestamp": 1653462125858
    },
    "value": {
        "code": "SUCCESS",
        "data": [
            {
                "kjsqq": "2022-03-31T16:00:00.000+00:00",
                "kjsqz": "2022-04-29T16:00:00.000+00:00",
                "ybtse": 0.0,
                "kjywrid": 13,
                "yxbz": "Y",
                "sbid": "7d331d04fbd04078bf971e534572780f",
                "ljsrze": 2000.0,
                "ynse": 0.0,
                "bblx": "1",
                "nsrmc": "成都******设备有限公司",
                "sre": 1000.0,
                "lrr": "czyId100001",
                "sblxZw": "正常申报",
                "sblx": "0",
                "lrsj": "2022-05-24T11:23:39.000+00:00",
                "nsrsbh": "91510116MA7LG*****",
                "sbrc": 1,
                "bblxZw": "综合所得预扣预缴表",
                "sbzt": "Y",
                "sbztZw": "已填写未申报"
            }
        ],
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明
kjywrid Integer 扣缴义务人ID
nsrsbh String 纳税人识别号
nsrmc String 纳税人名称
sbid String 申报主表ID
kjsqq Date 扣缴所属期起
kjsqz Date 扣缴所属期止
bblx String 申报表类型1、综合 2、分类 3、非居民
sbrc int 申报人次
sblx String 申报类型0 正常申报 1更正申报
sre float 收入额
ljsrze float 累计收入总额
ynse float 应纳税额
ynssde float 应纳税额所得额
ybtse float 应补退税额
sbzt String 申报状态包含了缴款状态
sbfkmsg String 申报状态说明
sbkhdjt String 申报客户端截图
sbsj Date 报送时间
jkkhdjt String 三方协议缴款客户端截图
jkfkmsg String 三方协议缴款msg
jksj Date 三方协议缴款发起时间
yhdjkpzzt Integer 银行端查询缴税状态
yhdjkpzurl String 银行端查询缴税打印成功pdf地址(银行端查询缴税状态成功才会存在该地址)

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

个税申报明细查询

1、接口描述

该接口用于个税申报明细查询 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/queryNsrfb      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号
bblx String 报表类型
kjsqq date 申报属期
zspmdm String 征收品目代码
sbid String 申报ID
nsrFbid String 附表ID
xm String 员工姓名
zjhm String 员工证件号码
zjlx String 员工证件类型
page
current Long 起始页
pageSize Long 当页显示条数
  • 示例参数
{
    "aggOrgId": 401671138175104,
    "nsrsbh": "91510116MA7LG*****",
    "bblx": "1",
    "kjsqq": "2022-04-01",
    "zspmdm": "0101",
    "page": {
        "current": 1,
        "pageSize": 10
    }
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "147b3040e416476fb8b9f9010397ae73",
        "success": true,
        "time": 510,
        "timestamp": 1653471584952
    },
    "value": {
        "code": "SUCCESS",
        "data": {
            "nsrfbList": [
                {
                    "kjsqq": "2022-03-31T16:00:00.000+00:00",
                    "ljjmse": 0.0,
                    "ssxdjmje": 0.0,
                    "sqkcxmqt": 0.0,
                    "kjsqz": "2022-04-29T16:00:00.000+00:00",
                    "ykjje": 0.0,
                    "jwzf": 0.0,
                    "zjhm": "41152*********891X",
                    "id": "1881b0c0e815420fa4c0175d60f8fb9b",
                    "ljfdkce": 20000.0,
                    "ynse": 0.0,
                    "sybxf": 0.0,
                    "zfdklxzc": 0.0,
                    "sskcs": 0.0,
                    "yftsre": 0.0,
                    "ljqtkchj": 0.0,
                    "jbybf": 0.0,
                    "jnzf": 0.0,
                    "fdkce": 5000.0,
                    "mssd": 0.0,
                    "yjynssde": 0.0,
                    "zspmdm": "0101",
                    "ywsjfe": 0.0,
                    "sl": 0.03,
                    "yyrzhfyzc": 0.0,
                    "xgr": "401671139713024",
                    "zxkchj": 0.0,
                    "ljynssde": 0.0,
                    "nsrid": "5287b760c7d446549cac54e0a5f4e718",
                    "dyqdjje": 0.0,
                    "lrsj": "2022-05-24T11:23:41.000+00:00",
                    "yxkcfye": 0.0,
                    "yikjse": 0.0,
                    "jbylf": 0.0,
                    "zfzjzc": 0.0,
                    "znjyzc": 0.0,
                    "zjlx": "201",
                    "ljsre": 2000.0,
                    "sylrzc": 0.0,
                    "jmje": 0.0,
                    "yxbz": "Y",
                    "dyxylbx": 0.0,
                    "kcjjcxmhj": 0.0,
                    "qtkchj": 0.0,
                    "ljkcxmhj": 0.0,
                    "zykcjze": 0.0,
                    "qbjfe": 0.0,
                    "sbid": "7d331d04fbd04078bf971e534572780f",
                    "ljmssd": 0.0,
                    "gzsr": 0.0,
                    "jxjyzc": 0.0,
                    "lrr": "czyId100001",
                    "ccyz": 0.0,
                    "tzdk": 0.0,
                    "nj": 0.0,
                    "syjkx": 0.0,
                    "jwts": 0.0,
                    "xgsj": "2022-05-25T06:15:11.000+00:00",
                    "ljzykcjze": 0.0,
                    "ynssde": 0.0,
                    "kjywrid": 13,
                    "fy": 0.0,
                    "sjjze": 0.0,
                    "ljzxkchj": 0.0,
                    "zfgjj": 0.0,
                    "sjse": 0.0,
                    "bblx": "1",
                    "ljfy": 0.0,
                    "sqkcxmhj": 0.0,
                    "sygs": "",
                    "sre": 1000.0,
                    "zycb": 0.0,
                    "ljykjse": 0.0,
                    "jnts": 0.0,
                    "xm": "万**",
                    "ljzxfjkchj": 0.0,
                    "sdxmdm": "",
                    "ljynse": 0.0,
                    "yyjse": 0.0,
                    "ycxbthjj": 0.0
                }
            ],
            "page": {
                "current": 1,
                "total": 1
            }
        },
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明
nsrfbList list 纳税人集合
id String 附表id
sbid String 申报ID
kjywrid int 扣缴义务人ID
bblx String 报表类型
nsrsbh String 纳税人识别号
zjhm String 证件号码
zjlx String 证照类型
kjsqq date 税款属期起
kjsqz date 扣缴属起止
zspmdm String 征收品目代码
sre Float 收入额
mssd Float 免税收入
jbylf Float 基本养老保险
jbybf Float 基本医疗保险
sybxf Float 失业保险费
zfgjj Float 住房公积金
ccyz Float 财产原值
nj Float 企业年金
syjkx Float 商业健康险
fdkce Float 减除费用
zykcjze Float 准予扣除捐赠额
ynssde Float 应纳税所得额
sl Float 税率
sskcs Float 速算扣除数
ynse Float 应纳税额
jmje Float 减免金额
ykjje Float 应扣缴税额
yikjse Float 已扣缴税额
sjse Float 应补税税额
ljsre Float 累计收入额
znjyzc Float 子女教育支出
zfdklxzc Float 住房贷款利息支出
zfzjzc Float 住房租金支出
sylrzc Float 赡养老人支出
jxjyzc Float 继续教育支出
ljmssd Float 累计免税收入
ljzxkchj Float 累计专项扣除合计
zxkchj Float 专项扣除合计
ljzxfjkchj Float 累计专项附加扣除合计
ljqtkchj Float 累计其他扣除合计
qtkchj Float 其他扣除合计
ljkcxmhj Float 累计扣除项目合计
ljgrylj Float 累计个人养老金
ljzykcjze Float 累计准予扣除捐赠额
ljfdkce Float 累计减除费用
ljynssde Float 累计应纳税所得额
ljynse Float 累计应纳税额
ljjmse Float 累计减免税额
ljykjse Float 累计应扣缴税额
yyjse Float 已预缴税额
sdxmdm Float 所得项目代 中的sdxmdm
fy Float 费用
ljfy Float 累计费用
zycb Float 展业成本
page 分页对象
current Int 当前页数
pageSize Int 每页显示条数
total Int 总条数

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

个税复制历史属期

1、接口描述

该接口用于个税复制历史属期,会复制往期的收入、和专项附加扣除。 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/fzlssqSb      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrList List 纳税人识别号集合
bblx String 报表类型
kjsqq String 申报属期起
fzkjsqq String 选择要复制的申报属期
  • 示例参数
{
    "aggOrgId": 401671138175104,
    "nsrList": ["91510116MA7LG*****"],
    "bblx": "1",
    "kjsqq": "2022-04-01",
    "fzkjsqq": "2022-04-01"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "3596fdb2ee0347609882976a7f5792f4",
        "success": true,
        "time": 161,
        "timestamp": 1655371454245
    },
    "value": {
        "code": "SUCCESS",
        "data": [
            {
                "nsrsbh": "91510116MA7LG*****",
                "fzCode": "1"
            }
        ],
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明
nsrsbh String 纳税人识别号
fzCode String 复制状态
msg String 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

个税扣缴明细查询

1、接口描述

该接口用于个税扣缴明细查询 同步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/grkjmxcx      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号
bblx String 报表类型
zspmdm String 征收品目代码
kjsqq Date 扣缴属期起
kjsqz Date 扣缴属期止
xm String 姓名
zjhm String 证件号码
zjlx String 证件号码
  • 示例参数
{
    "aggOrgId": 401671138175104,
    "nsrsbh": "9131********K87",
    "bblx": "1",
    "kjsqq": "2023-04-01",
    "kjsqz": "2023-04-30",
    "xm": "徐**",
    "zjhm": "34242*********7894",
    "zjlx": "201",
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "success": true,
        "req_id": "21176ad6f4ba4c51b4df21de43181a26",
        "timestamp": 1684997446463,
        "time": 110
    },
    "value": {
        "code": "SUCCESS",
        "success": true,
        "message": "成功!",
        "data": [
            {
                "kjsqq": "2023-04-01 00:00:00",
                "ljjmse": 0.0,
                "ssxdjmje": 0.0,
                "sqkcxmqt": 0.0,
                "kjsqz": "2023-04-30 00:00:00",
                "ykjje": 0.0,
                "jwzf": 0.0,
                "zjhm": "34242*********7894",
                "id": "a701f5ed3b794463839a8e31db492dc2",
                "ljfdkce": 20000.0,
                "ynse": 0.0,
                "sybxf": 40.0,
                "zfdklxzc": 0.0,
                "sskcs": 0.0,
                "yftsre": 0.0,
                "ljqtkchj": 0.0,
                "jbybf": 160.0,
                "jnzf": 0.0,
                "fdkce": 5000.0,
                "mssd": 0.0,
                "yjynssde": 0.0,
                "zspmdm": "0101",
                "ywsjfe": 0.0,
                "sl": 0.03,
                "yyrzhfyzc": 0.0,
                "xgr": "464699211088384",
                "zxkchj": 840.0,
                "ljynssde": 640.0,
                "ftyf": 0,
                "nsrid": "072030a5*******02624448d1854",
                "dyqdjje": 0.0,
                "lrsj": "2023-05-16 17:30:11",
                "yxkcfye": 0.0,
                "yikjse": 0.0,
                "jbylf": 640.0,
                "zfzjzc": 0.0,
                "znjyzc": 0.0,
                "zjlx": "201",
                "ljsre": 24000.0,
                "sylrzc": 0.0,
                "jmje": 0.0,
                "yxbz": "Y",
                "dyxylbx": 0.0,
                "kcjjcxmhj": 0.0,
                "qtkchj": 0.0,
                "ljkcxmhj": 3360.0,
                "zykcjze": 0.0,
                "qbjfe": 0.0,
                "sbid": "2b9103cc2f61486bbb69dfd71d490d1e",
                "ljmssd": 0.0,
                "gzsr": 0.0,
                "jxjyzc": 0.0,
                "lrr": "464699211088384",
                "ccyz": 0.0,
                "nsrsbh": "9131********K87",
                "tzdk": 0.0,
                "nj": 0.0,
                "syjkx": 0.0,
                "jwts": 0.0,
                "xgsj": "2023-05-18 16:47:36",
                "ljzykcjze": 0.0,
                "ynssde": 1000.0,
                "kjywrid": 13505,
                "fy": 0.0,
                "sjjze": 0.0,
                "ljzxkchj": 3360.0,
                "zfgjj": 0.0,
                "sjse": 4.8,
                "gh": "001",
                "bblx": "1",
                "ljfy": 0.0,
                "sqkcxmhj": 840.0,
                "sygs": "",
                "nsrmc": "上海*****有限公司",
                "sre": 6000.0,
                "zycb": 0.0,
                "ljykjse": 19.2,
                "jnts": 0.0,
                "xm": "徐**",
                "ljzxfjkchj": 0.0,
                "sdxmdm": "",
                "ljynse": 19.2,
                "yyjse": 14.4

            }
        ]
    }
}
  • 字段说明 data是个数组结构
字段名 字段类型 说明
gh String 工号
xm String 姓名
xb String 姓名。0男1女
nsrsbh String 纳税人识别号
zjhm String 证件号码
zjlx String 证照类型
zspmdm String 征收品目代码
sre Float 收入额
mssd Float 免税收入
jbylf Float 基本养老保险
jbybf Float 基本医疗保险
sybxf Float 失业保险费
zfgjj Float 住房公积金
ccyz Float 财产原值
nj Float 企业年金
syjkx Float 商业健康险
fdkce Float 减除费用
zykcjze Float 准予扣除捐赠额
ynssde Float 应纳税所得额
sl Float 税率
sskcs Float 速算扣除数
ynse Float 应纳税额
jmje Float 减免金额
ykjje Float 应扣缴税额
yikjse Float 已扣缴税额
sjse Float 应补税税额
ljsre Float 累计收入额
znjyzc Float 子女教育支出
zfdklxzc Float 住房贷款利息支出
zfzjzc Float 住房租金支出
sylrzc Float 赡养老人支出
jxjyzc Float 继续教育支出
ljmssd Float 累计免税收入
ljzxkchj Float 累计专项扣除合计
zxkchj Float 专项扣除合计
ljzxfjkchj Float 累计专项附加扣除合计
ljqtkchj Float 累计其他扣除合计
qtkchj Float 其他扣除合计
ljkcxmhj Float 累计扣除项目合计
ljzykcjze Float 累计准予扣除捐赠额
ljfdkce Float 累计减除费用
ljynssde Float 累计应纳税所得额
ljynse Float 累计应纳税额
ljjmse Float 累计减免税额
ljykjse Float 累计应扣缴税额
yyjse Float 已预缴税额
sdxmdm Float 所得项目代 中的sdxmdm
fy Float 费用
ljfy Float 累计费用
zycb Float 展业成本

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

完税证明开具

1、接口描述

该接口用于个税批量完税证明开具。只有缴纳税款的人员,才需要开具完税证明。 异步接口

2、接口地址

POST /v1/GS/com/dkdj/kjwszm          HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrList List 纳税人识别号集合
bblx String 报表类型
kjsqq String 扣缴属期起
  • 示例参数
{
    "aggOrgId": 401671138175104,
    "nsrList": ["91510116MA7LG*****"],
    "bblx": "1",
    "kjsqq": "2022-04-01"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

//开具成功
{
    "result": {
        "req_id": "bfc89cef9ab74946bc104cf36ec0bf62",
        "success": true,
        "time": 77,
        "timestamp": 1655370490986
    },
    "value": {
        "code": "SUCCESS",
        "data": [
            {
                "kjCode": "1",
                "nsrsbh": "91510116MA7LG*****"
            }
        ],
        "success": true,
        "message": "成功!"
    }
}
//开具失败
{
    "result": {
        "req_id": "d5eafb09fa244f5c9f3a4fdc7e03b38a",
        "success": true,
        "time": 537,
        "timestamp": 1653550110431
    },
    "value": {
        "code": "SUCCESS",
        "data": [
            {
                "kjCode": "0",
                "msg": "当前完税证明开具中,请稍后!",
                "nsrsbh": "91510116MA7LG*****"
            }
        ],
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明
nsrsbh String 纳税人识别号
kjCode String 开具发送状态
msg String 说明1、已发送 0 发送失败

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

批量完税证明开具

1、接口描述

该接口用于个税批量完税证明开具。只有缴纳税款的人员,才需要开具完税证明。 异步接口

2、接口地址

POST /v1/GS/com/dkdj/batchKjwszm          HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrList List 纳税人识别号集合
bblx String 报表类型
kjsqq String 扣缴属期起
  • 示例参数
[
    {
        "aggOrgId":401671138175104,
        "nsrList":[
            "91510116MA7LG*****"
        ],
        "bblx":"1",
        "kjsqq":"2022-04-01"
    },
    {
        "aggOrgId":401671138175105,
        "nsrList":[
            "91510145FR6HY*****"
        ],
        "bblx":"1",
        "kjsqq":"2022-04-01"
    }
]

4、返回结果

  • 返回结果

返回结果为JSON格式。

//开具成功
{
    "result":{
        "req_id":"bfc89cef9ab74946bc104cf36ec0bf62",
        "success":true,
        "time":77,
        "timestamp":1655370490986
    },
    "value":[
        {
            "code":"SUCCESS",
            "aggOrgId":401671138175104,
            "data":[
                {
                    "kjCode":"1",
                    "nsrsbh":"91510116MA7LG*****"
                }
            ],
            "success":true,
            "message":"成功!"
        },
        {
            "code":"SUCCESS",
            "aggOrgId":401671138175105,
            "data":[
                {
                    "kjCode":"1",
                    "nsrsbh":"91510145FR6HY*****"
                }
            ],
            "success":true,
            "message":"成功!"
        }
    ]
}
//开具失败
{
    "result":{
        "req_id":"d5eafb09fa244f5c9f3a4fdc7e03b38a",
        "success":true,
        "time":537,
        "timestamp":1653550110431
    },
    "value":[
        {
            "code":"SUCCESS",
            "aggOrgId":401671138175104,
            "data":[
                {
                    "kjCode":"0",
                    "msg":"该申报未完成,无法开具完税证明",
                    "nsrsbh":"91510116MA7LG*****"
                }
            ],
            "success":true,
            "message":"成功!"
        },
        {
            "code":"SUCCESS",
            "aggOrgId":401671138175105,
            "data":[
                {
                    "kjCode":"0",
                    "msg":"该申报未完成,无法开具完税证明",
                    "nsrsbh":"91510145FR6HY*****"
                }
            ],
            "success":true,
            "message":"成功!"
        }
    ]
}
  • 字段说明
字段名 字段类型 说明
nsrsbh String 纳税人识别号
kjCode String 开具发送状态
msg String 说明1、已发送 0 发送失败

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

完税证明地址下载

1、接口描述

该接口用于个税批量完税证明地址下载。 同步接口

2、接口地址

POST /v1/GS/com/dkdj/getWszmUrl      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrList List 纳税人识别号集合
bblx String 报表类型
kjsqq String 扣缴属期起
  • 示例参数
{
    "aggOrgId": 401671138175104,
    "nsrList": ["91510116MA7LG*****"],
    "bblx": "1",
    "kjsqq": "2022-04-01"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "d1de3c8f1b4a47d5a55fa530026c69d4",
        "success": true,
        "time": 2260,
        "timestamp": 1655370663769
    },
    "value": {
        "code": "SUCCESS",
        "data": [
            {
                "wszmkjzt": "1",
                "nsrsbh": "91510116MA7LG*****",
                "wszmUrl": "feedback_files\/kjwszm\/2022\/06\/16\/4403\/91510116MA7LG*****\/10773\/wszm.zip"
            }
        ],
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明
字段名 字段类型 说明
nsrsbh String 纳税人识别号
wszmkjzt String 完税证明开具状态1、已开具 2、开具中 0、 开具失败 (null或者无该字段表示未开具)
wszmUrl String 完税证明开具地址(开具状态已开具才有地址)
msg String 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

批量完税证明地址下载

1、接口描述

该接口用于个税批量完税证明地址下载。 同步接口

2、接口地址

POST /v1/GS/com/dkdj/batchGetWszmUrl      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrList List 纳税人识别号集合
bblx String 报表类型
kjsqq String 申报属期起
  • 示例参数
[
    {
        "aggOrgId":401671138175104,
        "nsrList":[
            "91510116MA7LG*****"
        ],
        "bblx":"1",
        "kjsqq":"2022-04-01"
    },
    {
        "aggOrgId":401671138175105,
        "nsrList":[
            "9151231MgYTR*****"
        ],
        "bblx":"1",
        "kjsqq":"2022-04-01"
    }
]

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result":{
        "req_id":"d1de3c8f1b4a47d5a55fa530026c69d4",
        "success":true,
        "time":2260,
        "timestamp":1655370663769
    },
    "value":[
        {
            "code":"SUCCESS",
            "aggOrgId":401671138175104,
            "data":[
                {
                    "wszmkjzt":"1",
                    "nsrsbh":"91510116MA7LG*****",
                    "wszmUrl":"feedback_files\/kjwszm\/2022\/06\/16\/4403\/91510116MA7LG*****\/10773\/wszm.zip"
                }
            ],
            "success":true,
            "message":"成功!"
        },
        {
            "code":"SUCCESS",
            "aggOrgId":401671138175105,
            "data":[
                {
                    "wszmkjzt":"1",
                    "nsrsbh":"9151231MgYTR*****",
                    "wszmUrl":"feedback_files\/kjwszm\/2022\/06\/16\/4403\/9151231MgYTR*****\/10773\/wszm.zip"
                }
            ],
            "success":true,
            "message":"成功!"
        }
    ]
}
  • 字段说明
字段名 字段类型 说明
nsrsbh String 纳税人识别号
wszmkjzt String 完税证明开具状态1、已开具 2、开具中 0、 开具失败 (null或者无该字段表示未开具)
wszmUrl String 完税证明开具地址(开具状态已开具才有地址)
msg String 说明

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

发起单位申报记录查询接口

1、接口描述

单位申报记录查询接口,用于查询局端单位申报记录

异步接口

2、接口地址

POST /v1/GS/dkdj/sbxx/dwsbcx      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号集合
kjsqq String 申报属期起(YYYY-mm)
kjsqz Sting 申报属期止(YYYY-mm)
  • 示例参数
{
    "aggOrgId": 473739231680704,
    "nsrsbh": "91370212*****WN66",
    "kjsqq": "2023-05",
    "kjsqz": "2023-06"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result": {
        "req_id": "6dabf3dfefce40caa4602b663b432852",
        "success": true,
        "time": 751,
        "timestamp": 1688104012455
    },
    "value": {
        "code": "SUCCESS",
        "data": {
            "msg": "已发送单位申报记录查询请求"
        },
        "success": true,
        "message": "成功!"
    }
}
错误返回报文:
{
    "result": {
        "req_id": "e5c89c8d722c4c8dbd9cf265511e8e5d",
        "success": true,
        "time": 73,
        "timestamp": 1688104103202
    },
    "value": {
        "code": "BUSINESS_ERROR",
        "success": false,
        "message": "请求参数[kjsqq]格式不正确!"
    }
}
错误返回报文:
{
    "result": {
        "req_id": "ffeccc9720734f74885ceb082284765b",
        "success": true,
        "time": 100,
        "timestamp": 1688104063090
    },
    "value": {
        "code": "SUCCESS",
        "data": {
            "msg": "单位申报记录查询中"
        },
        "success": true,
        "message": "成功!"
    }
}
  • 字段说明

    该接口由于是异步接口,通过查询流程任务状态接口获取结果。

    查询流程任务状态返回业务报文:
    {
        "result": {
            "req_id": "359125e1d1c94172b98c240436a7b13b",
            "success": true,
            "time": 280,
            "timestamp": 1688104374859
        },
        "value": {
            "code": "SUCCESS",
            "data": {
                "traceId": "3b444401a7b649cf95eb29a65548a072",
                "msg": "",
                "creattime": "2023-06-30T05:46:52.000+00:00",
                "khdjturl": "http://gsy-testbucket.oss-cn-beijing.aliyuncs.com/process_fe*****3702/91370212MA7N64WN66/66596_1688104123.png?OSSAccessKeyId=LTAI5tPteLVsqzJK5W9uDvGr&Expires=1719640123&Signature=oqhlCc6KXGJy16Iy3sE43MHzLmc%3D",
                "realmsg": "",
                "type": "dwsbcx",
                "params": "{\"nsrsbh\":\"91370******N66\",\"param\":{\"kjsqq\":\"2023-01\",\"nsrmc\":\"青岛*****有限公司\",\"kjsqz\":\"2023-06\",\"type\":\"dwsbcx\",\"kjywrid\":13596,\"smdlmm\":\"\",\"nsrsbh\":\"9137*******66\",\"xzqhdm\":\"3702\",\"sbmm\":\"05B68418*****10FBB101B55DC\",\"smdlzh\":\"\"},\"nsrmc\":\"青岛百泰源****公司\",\"processDefinitionCode\":\"dwsbcx\"}",
                "result": "{\"result\":[{\"dqsr\":\"0.00\",\"ybse\":\"0.00\",\"sbsj\":\"2023-06-06\",\"sbrc\":\"1\",\"sbqd\":\"客户端(非本通道)\",\"sbbmc\":\"综合所得预扣预缴表\",\"sblx\":\"正常申报\",\"skssq\":\"2023年05月\"},{\"dqsr\":\"0.00\",\"ybse\":\"0.00\",\"sbsj\":\"2023-05-09\",\"sbrc\":\"1\",\"sbqd\":\"客户端(非本通道)\",\"sbbmc\":\"综合所得预扣预缴表\",\"sblx\":\"正常申报\",\"skssq\":\"2023年04月\"},{\"dqsr\":\"0.00\",\"ybse\":\"0.00\",\"sbsj\":\"2023-04-13\",\"sbrc\":\"1\",\"sbqd\":\"客户端(非本通道)\",\"sbbmc\":\"综合所得预扣预缴表\",\"sblx\":\"正常申报\",\"skssq\":\"2023年03月\"},{\"dqsr\":\"0.00\",\"ybse\":\"0.00\",\"sbsj\":\"2023-03-08\",\"sbrc\":\"1\",\"sbqd\":\"客户端(非本通道)\",\"sbbmc\":\"综合所得预扣预缴表\",\"sblx\":\"正常申报\",\"skssq\":\"2023年02月\"},{\"dqsr\":\"0.00\",\"ybse\":\"0.00\",\"sbsj\":\"2023-03-08\",\"sbrc\":\"1\",\"sbqd\":\"客户端(非本通道)\",\"sbbmc\":\"综合所得预扣预缴表\",\"sblx\":\"正常申报\",\"skssq\":\"2023年01月\"}],\"xzqhdm\":\"3702\",\"nsrsbh\":\"91*******4WN66\"}",
                "resulttime": "2023-06-30T05:48:48.000+00:00",
                "nsrsbh": "913702*****N66",
                "processId": 66596,
                "zt": "1"
            },
            "success": true,
            "message": "成功!"
        }
    }
    

    result返回业务报文字段说明:

字段名 字段类型 说明
skssq String 税款所属期
sbbmc String 申报表名称
sbrc String 申报人次
dqsr String 当期收入
ybse String 应补(退)税额
sblx String 申报类型
sbqd String 申报渠道
sbsj String 申报时间

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

查询流程任务状态

1、接口描述

该接口用于查询任务的进度详情 同步接口

2、接口地址

POST /v1/GS/com/getTask      HTTP/1.1

3、请求参数

  • 参数说明

请求参数为JSON格式。

参数名称 参数类型 是否必填 说明
aggOrgId Long 企业信息的 aggOrgId
nsrsbh String 纳税人识别号集合
type String 流程类型,参考个税流程类型
sbid Sting 申报等任务ID
zt Sting 任务状态 0 执行失败 1、执行成功 2 执行中
rpakssj Date 任务开始时间
rpajssj Date 任务结束时间
  • 示例参数
{
    "aggOrgId": 401671138175104,
    "nsrsbh": "91510116MA7LG*****",
    "type": "scjyzfsb"
}

4、返回结果

  • 返回结果

返回结果为JSON格式。

{
    "result":{
        "req_id":"d1de3c8f1b4a47d5a55fa530026c69d4",
        "success":true,
        "time":2260,
        "timestamp":1655370663769
    },
    "value":{
        "code":"SUCCESS",
        "data":{
            "traceId":"d53398c3e58c44fc8630040bbfbeb847",
            "nsrsbh":"91350200X121254172",
            "sbid":"c00ed67db73c49bea00336bbe09414e2",
            "processId":10834,
            "type":"scjyzfsb",
            "params":"",
            "creattime":"2022-08-14T09:17:16.000+00:00",
            "resulttime":"2022-08-14T09:18:49.000+00:00",
            "zt":"1",
            "khdjturl":"http://gsy-testbucket.oss-cn-beijing.aliyuncs.com/process_feedback/2022/08/14/3502/91350200X121254172/10834_1660468725.png?OSSAccessKeyId=LTAI5tPteLVsqzJK5W9uDvGr&Expires=1692004726&Signature=yJMnLvffGseP%2FXd2EKlv3thUy5g%3D",
            "msg":"",
            "realmsg":"",
            "result":"",
            "typename":"作废申报"
        },
        "success":true,
        "message":"成功!"
    }
}
  • 字段说明
字段名 字段类型 说明
traceId String 流程流水号
nsrsbh String 纳税人识别号
sbid String 申报ID
processId String 流程ID
type String 流程类型
params String 请求业务报文
creattime Date 流程创建时间
resulttime Date 流程返回时间
zt String 流程状态
khdjturl String 客户端截图地址
msg String 流程说明
realmsg String 真实流程说明
result String 返回业务报文
typename String 流程名称

5、错误码

错误代码 错误信息 说明
PARAMETER_ERROR 没有找到对应的企业! 200

results matching ""

    No results matching ""