4.05 发票勾选&撤销勾选 - 发票云(旗舰版)API文档

请求参数

Query 参数

access_token

string

必需

access_token

Header 参数

access_token

string

可选

默认值:

Body 参数application/json

businessSystemCode

string

必需

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

interfaceCode

enum<string>

必需

接口编码，定义本接口的操作种类，传固定字符串值：invoiceSelect

枚举值:

invoiceSelect

requestId

string

可选

定义本次接口的请求ID码，可用当前13位毫秒级时间戳加3位随机数字(总共16位)生成的字符串

data

object

必需

详细的请求参数，需要把data的值加密成字符串，默认为base64

taxNo

string

必需

本次进行勾选或者撤销勾选操作的纳税人识别号（税号）

<= 20 字符

billType

enum<string>

必需

发票单据类型，系统管理员在收票管理下单据类型中维护（涉及增值税发票和海关缴款书时，需要分开调用本接口）

<= 50 字符

枚举值:

01

默认值:

0

authenticateFlag

number

必需

勾选标志，1：勾选，0：撤销勾选

deductionPurpose

enum<string>

必需

抵扣用途，1：抵扣，2：不抵扣，3：退税

枚举值:

123

asyncFlag

string

可选

异步标志，0：同步（默认），1：异步，定义本次接口请求的任务是同步进行还是异步进行，如是异步进行，会返回异步任务号，后续可使用异步任务号调4.06接口查询相关结果

invoices

array [object {11}]

必需

待勾选或者撤销勾选的发票数组

示例

{
    "businessSystemCode": "string",
    "interfaceCode": "invoiceSelect",
    "requestId": "string",
    "data": {
        "taxNo": "string",
        "billType": "0",
        "authenticateFlag": 0,
        "deductionPurpose": "1",
        "asyncFlag": "string",
        "invoices": [
            {
                "salerName": "string",
                "salerTaxNo": "string",
                "invoiceType": "4",
                "invoiceCode": "string",
                "invoiceNo": "string",
                "etaxInvoiceNo": "string",
                "invoiceDate": "2022-06-11",
                "invoiceAmount": "string",
                "effectiveTaxAmount": "string",
                "totalTaxAmount": "string",
                "notDeductibleType": "1"
            }
        ]
    }
}

示例代码

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/rim/deduction?access_token=' \
--header 'access_token: {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "businessSystemCode": "string",
    "interfaceCode": "invoiceSelect",
    "requestId": "string",
    "data": {
        "taxNo": "string",
        "billType": "0",
        "authenticateFlag": 0,
        "deductionPurpose": "1",
        "asyncFlag": "string",
        "invoices": [
            {
                "salerName": "string",
                "salerTaxNo": "string",
                "invoiceType": "4",
                "invoiceCode": "string",
                "invoiceNo": "string",
                "etaxInvoiceNo": "string",
                "invoiceDate": "2022-06-11",
                "invoiceAmount": "string",
                "effectiveTaxAmount": "string",
                "totalTaxAmount": "string",
                "notDeductibleType": "1"
            }
        ]
    }
}'

返回响应

🟢200成功

application/json

Body

errorCode

string

必需

返回响应码，0000即为成功

message

string

返回响应描述

必需

success

boolean

必需

请求是否成功，布尔值

data

object

必需

返回内容data，需要解密，默认为base64

asyncFlag

string

可选

异步标志：0：同步（默认），1：异步

taskNo

string

可选

异步任务号（asyncFlag=1时会返回异步任务号），如是异步进行，，后续可使用异步任务号调4.06接口查询相关结果

success

array [object {9}]

必需

勾选或撤销勾选成功的发票数组

fail

array [object {5}]

必需

勾选或者撤销勾选失败发票数组

示例

{
    "errorCode": "string",
    "message": "string",
    "success": true,
    "data": {
        "asyncFlag": "string",
        "taskNo": "string",
        "success": [
            {
                "selectResult": "1",
                "description": "string",
                "invoiceCode": "string",
                "invoiceNo": "string",
                "invoiceDate": "string",
                "selectDate": "string",
                "taxPeriod": "string",
                "effectiveTaxAmount": "string",
                "notDeductibleType": "1"
            }
        ],
        "fail": [
            {
                "invoiceCode": "string",
                "invoiceNo": "string",
                "invoiceDate": "string",
                "description": "string",
                "selectResult": "1"
            }
        ]
    }
}