2.1.12 红字确认单下载 - 发票云(旗舰版)API文档

请求参数

Query 参数

access_token

string

必需

{access_token}

Header 参数

access_token

string

可选

默认值:

Body 参数application/json

requestId

string

时间戳

必需

当前13位毫秒级时间戳加3位随机数字(总共16位)

interfaceCode

enum<string>

接口编码

必需

固定值：ALLE.REDCONFIRMBILL.QUERY

枚举值:

ALLE.REDCONFIRMBILL.QUERY

businessSystemCode

string

来源系统

必需

对接业务系统来源编码，用于区分不同业务系统的回调接口.例如ERP系统，你可以传入ERP

data

object

必需

taxpayerId

string

授权对应的企业税号

可选

组织编码和授权对应税号二者必填其一

<= 20 字符

orgCode

string

组织编码

可选

组织编码和授权对应税号二者必填其一

<= 20 字符

identity

enum<string>

购销身份

必需

枚举值:

01

默认值:

0

startDate

string

开始时间

必需

格式为:YYYY-MM-DD

endDate

string

结束时间

必需

格式为:YYYY-MM-DD

otherSideName

string

对方纳税人名称

可选

redInfoBillNo

string

红字确认单编号

可选

支持乐企。如需支持rpa，需先将本红字确认单下载至发票云，再通过本接口可获取该确认单最新信息，如确认单状态。

<= 30 字符

redConfirmBillStatus

enum<string>

红字确认单状态

可选

红字确认单状态。发票云版本5.0.024支持

枚举值:

01020304050607080910

invoiceOpenState

enum<string>

开具状态

可选

枚举值:

YN

默认值:

Y

page

integer

当前分页

必需

pageSize

integer

分页大小

必需

最大不能超过50

示例

{
    "requestId": "string",
    "interfaceCode": "ALLE.REDCONFIRMBILL.QUERY",
    "businessSystemCode": "string",
    "data": {
        "taxpayerId": "string",
        "orgCode": "string",
        "identity": "0",
        "startDate": "string",
        "endDate": "string",
        "otherSideName": "string",
        "redInfoBillNo": "string",
        "redConfirmBillStatus": "01",
        "invoiceOpenState": "Y",
        "page": 0,
        "pageSize": 0
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://cosmic-sandbox.piaozone.com/jdpjykjyxgs/kapi/app/sim/openApi?access_token=' \
--header 'access_token: {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "string",
    "interfaceCode": "ALLE.REDCONFIRMBILL.QUERY",
    "businessSystemCode": "string",
    "data": {
        "taxpayerId": "string",
        "orgCode": "string",
        "identity": "0",
        "startDate": "string",
        "endDate": "string",
        "otherSideName": "string",
        "redInfoBillNo": "string",
        "redConfirmBillStatus": "01",
        "invoiceOpenState": "Y",
        "page": 0,
        "pageSize": 0
    }
}'

返回响应

🟢200成功

application/json

Body

errorCode

string

响应码

必需

成功-0

message

string

响应说明

可选

data

object

返回数据

必需

dataList

array [object {21}]

必需

下载的红字确认单数据

pageNo

integer

当前分页

必需

pageSize

integer

分页大小

必需

totalElement

integer

总条数

必需

示例

{
    "errorCode": "string",
    "message": "string",
    "data": {
        "dataList": [
            {
                "govRedConfirmBillUuid": "string",
                "redInfoBillNo": "string",
                "redConfirmBillStatus": "01",
                "enterIdentity": "string",
                "redConfirmEnterDate": "string",
                "redReason": "string",
                "buyerName": "string",
                "buyerTaxpayerId": "string",
                "sellerName": "string",
                "sellerTaxpayerId": "string",
                "invoiceNo": "string",
                "totalAmount": 0,
                "totalTaxAmount": 0,
                "invoiceDate": "string",
                "originalInvoiceType": "26",
                "originalInvoiceCode": "string",
                "originalInvoiceNumber": "string",
                "originalInvoiceAmount": 0,
                "originalTotalTaxAmount": 0,
                "originalIssueTime": "string",
                "invoiceDetail": [
                    {
                        "index": "string",
                        "blueInvoiceItemIndex": "string",
                        "revenueCode": "string",
                        "goodsName": "string",
                        "specification": "string",
                        "units": "string",
                        "quantity": "string",
                        "price": "string",
                        "amount": 0,
                        "taxAmount": 0,
                        "taxRate": 0
                    }
                ]
            }
        ],
        "pageNo": 0,
        "pageSize": 0,
        "totalElement": 0
    }
}