进项全量发票采集-异步申请 - 发票云(标准版)API文档

请求参数

Query 参数

access_token

string

必需

访问token，获取方式请查阅《对接约定》

<= 255 字符

reqid

string

必需

当前13位毫秒级时间戳加3位随机数字，方便请求方跟踪异常

>= 16 字符<= 16 字符

示例值:

1624601109096123

Header 参数

Content-Type

string

必需

请求参数为json格式

示例值:

application/json

tid

string

必需

租户授权clientId

<= 30 字符

taxNo

string

当前企业税号

必需

<= 20 字符

method

string

必需

全量发票采集-异步申请，固定传值：full/apply

示例值:

full/apply

Body 参数application/json

account

string

电子税局账号

可选

选填，不传则使用配置的默认电子税局账号

invoiceTypes

array[number]

发票类型

必需

1.普通电子发票 2.电子发票专票 3.普通纸质发票 4.专用纸质发票 5.普通纸质卷票12.机动车 13.二手车 15.通行费 26.数电票（普通发票）27.数电票（增值税专用发票）28.数电票（航空运输电子客票行程单）29.数电票（铁路电子客票）

startTime

string

开票开始日期

必需

<= 10 字符

endTime

string

开票结束日期

必需

时间范围不能超过31天

<= 10 字符

invoiceStatus

number

发票状态

可选

默认全部状态，0.正常,1.失控,2.作废,3.红冲,4.异常,5.认证异常,7.部分红冲,8.全额红冲（电子税局新增）

applyFileFlag

boolean

是否需要申请数电发票的版式文件

必需

默认false不申请版式文件只下载数据, 会自动申请版式文件的invoiceType值有（26，27，28，29），其它发票类型不申请

fileTypes

array[integer]

申请版式文件的文件类型

可选

-1: 全部类型, 1: ofd, 2: pdf, 3: xml，当applyFileFlag为true时必传

枚举值:

-1123

示例

{
  "account": "",
  "dataType": 1,
  "invoiceTypes": [
    3,
    12
  ],
  "startTime": "2024-01-01",
  "endTime": "2024-01-31",
  "invoiceStatus": 0
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api-dev.piaozone.com/test/m2/bill/v1/invoice/collector?access_token=&reqid=1624601109096123' \
--header 'tid;' \
--header 'taxNo;' \
--header 'method: full/apply' \
--header 'Content-Type: application/json' \
--data-raw '{
    "account": "",
    "dataType": 1,
    "invoiceTypes": [
        3,
        12
    ],
    "startTime": "2024-01-01",
    "endTime": "2024-01-31",
    "invoiceStatus": 0
}'

返回响应

🟢200成功

application/json

Body

errcode

string

状态码

必需

0000标识成功，非0000都属于失败，失败原因见描述

description

string

描述

必需

操作结果描述

traceId

string

链路ID

必需

每个请求响应的唯一id，方便请求方跟踪异常

data

object

可选

batchNo

string

申请的批次号

可选

申请成功后会返回，后续可以通过该批次号去查询申请下载回来的发票数据

<= 256 字符

示例

{
  "errcode": "0000",
  "description": "操作成功",
  "traceId": "7r5r3355otygyur4",
  "data": {
    "batchNo": "21b8uh6rg0cql51nojw53k587t1lovxl"
  }
}