创建异步下载任务
您可以使用本接口创建异步下载任务。
代理商商务中心和直客商务中心都能执行发票相关操作。
注意
只有拥有财务经理或财务分析师权限的用户才能在商务中心执行资金管理和发票的相关操作。您可以使用/bc/member/invite/ 和 /bc/member/update/设置或更改成员权限。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/bc/invoice/task/create/| /v1.3/bc/invoice/task/create/|
|请求参数类型|invoice_id: number<br>bc_id: number |invoice_id: string<br>bc_id: string |
|请求参数名称和类型|bg_id: number |billing_group_id: string |
|新增请求参数|/|campaign_id`|
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/bc/invoice/task/create/
**方法** POST
**Header**
``` xtable
|字段|类型|描述|
|---|---|---|
|Access-Token{必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
|Content-Type {必填}|string|请求消息类型<br>允许值: `application/json`。|
参数
|字段|类型|描述|
|---|---|---|
|bc_id {必填}|string| 商务中心 ID。|
| download_type {必填} | string | 下载类型。 <br><br>枚举值:<ul><li>`INVOICE_LIST`: Excel 格式的发票列表,最多包含 100 个发票。 </li><li>`INVOICE_BATCH`: ZIP 格式的批量下载发票。解压后发票为 PDF 格式。</li><li>`BILLING_REPORT`: Excel 格式的详细交易报告。</li></ul><br><p><span style="color:darkred"><b>注意</b></span>: 异步下载任务创建后,您可以使用[/bc/invoice/task/get/](1754000480307265.html) 获取`BILLING_REPORT`类型任务的 Excel 的文件流,或使用[/bc/invoice/task/list/](1754000504437762.html) 获取`BILLING_REPORT`、`INVOICE_LIST` 和`INVOICE_BATCH`类型任务的下载链接。 |
| invoice_id {+条件必填} | string |<ul><li> `download_type`为`BILLING_REPORT`时,本字段必填。</li><li> `download_type` 为 `INVOICE_LIST` 或`INVOICE_BATCH` 时,本字段为可选的筛选字段。</li></ul><br>发票 ID。<br><br>若想获取商务中心中的发票 ID 列表,可使用 [/bc/invoice/get/](1740295890332674.html)。 |
| filtering | object | 筛选条件。 |
#|invoice_title | string | 发票抬头。<br><br>若想获取商务中心中的发票的抬头,可使用 [/bc/invoice/get/](1740295890332674.html)。 |
#|serial_number | string | 发票编号。 |
#|billing_group_id | string | 账单组 ID。<br><br>若想获取商务中心中的账单组列表,可使用[/bc/billing_group/get/](1738944324279297.html)。 |
#|pay_statuses|string[]|发票还款状态。<br><br>枚举值:`UNPAID`, `PAID`, `PARTIAL_PAID`, `NO_NEED`。|
#|start_time | string | 发票发送日期的起始时间,格式为 `YYYY-MM-DD`( UTC+0)。 |
#|end_time | string | 发票发送日期的截止时间,格式为 `YYYY-MM-DD`( UTC+0)。 |
#|campaign_id | string | 仅当`download_type` 为 `INVOICE_LIST` 或 `INVOICE_BATCH` 时生效。<br><br>推广系列 ID。<br><br>若想获取广告账号中的推广系列列表,可使用 [/campaign/get/](1739315828649986.html)。 |
示例
(code curl http)
curl --location --request POST https://business-api.tiktok.com/open_api/v1.3/bc/invoice/task/create/
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"bc_id": "{{bc_id}}",
"download_type": "INVOICE_BATCH",
"invoice_id": "{{invoice_id}}"
}'
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097) |
|message |string|返回信息,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097) |
|data |object|返回数据 |
#|task_id|string|任务ID|
|request_id |string|请求的日志id,唯一标识一个请求 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"task_id": "{{task_id}}"
}
}
(/code)