获取商务中心交易记录

您可以使用本接口获取商务中心下的交易记录（转入及转出记录）。

代理商商务中心和直客商务中心都能执行资金管理相关操作。

注意
只有拥有财务经理或财务分析师权限的用户才能在商务中心执行资金管理和发票的相关操作。您可以使用/bc/member/invite/ 和 /bc/member/update/设置或更改成员权限。

v1.2与v1.3版本对比

以下表格概括了 v1.2与v1.3接口的变化。

|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/bc/transaction/get/| /v1.3/bc/transaction/get/|
|请求参数类型|`bc_id`: number |`bc_id`: string |
|返回参数名称|`invoice_serial`<br>`total_transfer`<br>` deposit_amount`<br>` transfer_amount` |`invoice_serial_number` <br>` transaction_summary `<br>` amount_charged`<br>` amount_paid`|
|返回参数类型|`page_info`: number|`page_info`: object|
|新增返回参数|/|`page` : number<br>`page_size`: number<br>`total_number`: number<br>`total_page `: number |

请求

地址

https://business-api.tiktok.com/open_api/v1.3/bc/transaction/get/

方法 GET

Header

|字段|类型|描述|
|---|---|---|
|Access-Token{必填}|string|授权访问令牌，可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。  |

参数

|字段|类型|描述|
|---|---|---|
|bc_id {必填}|string| 商务中心ID。|
|filtering |object| 筛选条件 |
#| funds_type | string[] | 资金类型。若您没有指定该字段，那么系统将返回两种资金类型。枚举值：`FUNDS_TYPE_CASH` (现金), `FUNDS_TYPE_GRANT` (非现金)。|
| start_date | string | 交易记录的开始日期，格式为 "YYYY-MM-DD"。默认值为90天前。|
| end_date | string |交易记录的结束日期，格式为"YYYY-MM-DD"。默认值为今天。 |
| page | number | 页码。|
| page_size | number |页面大小。取值范围: 1-50。|

示例

(code Java java)
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import okhttp3.*;
import org.apache.http.client.utils.URIBuilder;

import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

public class Demo {
    private static final String ACCESS_TOKEN = "xxx";
    private static final String PATH = "/open_api/v1.3/bc/transaction/get/";
    private static final ObjectMapper mapper = new ObjectMapper();

    /**
     * Build request URL
     *
     * @param path Request path
     * @return Request URL
     */
    private static String buildUrl(String path) throws URISyntaxException {
        URI uri = new URI("https", "business-api.tiktok.com", path, "", "");
        return uri.toString();
    }

    /**
     * Send GET request
     *
     * @param jsonStr:Args in JSON format
     * @return Response in JSON format
     */
    private static String get(String jsonStr) throws IOException, URISyntaxException {
        OkHttpClient client = new OkHttpClient().newBuilder().build();
        URIBuilder ub = new URIBuilder(buildUrl(PATH));
        Map< String, Object > map = mapper.readValue(jsonStr, Map.class);
        map.forEach((k, v) -> {
            try {
                ub.addParameter(k, v instanceof String ? (String) v : mapper.writeValueAsString(v));
            } catch (JsonProcessingException e) {
                e.printStackTrace();
            }
        });
        URL url = ub.build().toURL();

        Request request = new Request.Builder()
                .url(url)
                .method("GET", null)
                .addHeader("Access-Token", ACCESS_TOKEN)
                .build();
        Response response = client.newCall(request).execute();
        return response.body().string();
    }

    public static void main(String[] args) throws IOException, URISyntaxException {
        Long bc_id = BC_ID;
        String funds_type = FUNDS_TYPE;
        String start_date = START_DATE;
        String end_date = END_DATE;
        Long page = PAGE;
        Long page_size = PAGE_SIZE;

        // Args in JSON format
        String myArgs = String.format("{\"bc_id\": \"%s\", \"filtering\": {\"funds_type\": \"%s\"}, \"start_date\": \"%s\", \"end_date\": \"%s\", \"page\": \"%s\", \"page_size\": \"%s\"}",bc_id, funds_type, start_date, end_date, page, page_size);
        System.out.println(get(myArgs));
    }
}
(/code)

(code Python python)
# coding=utf-8
import json
import requests

from six import string_types
from six.moves.urllib.parse import urlencode, urlunparse  # noqa

ACCESS_TOKEN = "xxx"
PATH = "/open_api/v1.3/bc/transaction/get/"

def build_url(path, query=""):
    # type: (str, str) -> str
    """
    Build request URL
    :param path: Request path
    :param query: Querystring
    :return: Request URL
    """
    scheme, netloc = "https", "business-api.tiktok.com"
    return urlunparse((scheme, netloc, path, "", query, ""))

def get(json_str):
    # type: (str) -> dict
    """
    Send GET request
    :param json_str: Args in JSON format
    :return: Response in JSON format
    """
    args = json.loads(json_str)
    query_string = urlencode({k: v if isinstance(v, string_types) else json.dumps(v) for k, v in args.items()})
    url = build_url(PATH, query_string)
    headers = {
        "Access-Token": ACCESS_TOKEN,
    }
    rsp = requests.get(url, headers=headers)
    return rsp.json()

if __name__ == '__main__':
    bc_id = BC_ID
    funds_type = FUNDS_TYPE
    start_date = START_DATE
    end_date = END_DATE
    page = PAGE
    page_size = PAGE_SIZE

    # Args in JSON format
    my_args = "{\"bc_id\": \"%s\", \"filtering\": {\"funds_type\": \"%s\"}, \"start_date\": \"%s\", \"end_date\": \"%s\", \"page\": \"%s\", \"page_size\": \"%s\"}" % (bc_id, funds_type, start_date, end_date, page, page_size)
    print(get(my_args))
(/code)

(code PHP php)

$ACCESS_TOKEN = "xxx";
$PATH = "/open_api/v1.3/bc/transaction/get/";

/**
 * Build request URL
 * @param $path : Request path
 * @return string
 */
function build_url($path)
{
    return "https://business-api.tiktok.com" . $path;
}

/**
 * Send GET request
 * @param $json_str : Args in JSON format
 * @return bool|string : Response in JSON format
 */
function get($json_str)
{
    global $ACCESS_TOKEN, $PATH;
    $curl = curl_init();

    $args = json_decode($json_str, true);

    /* Values of querystring is also in JSON format */
    foreach ($args as $key => $value) {
        $args[$key] = is_string($value) ? $value : json_encode($value);
    }

    $url = build_url($PATH) . "?" . http_build_query(
            $args
        );

    curl_setopt_array($curl, array(
        CURLOPT_URL => $url,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 0,
        CURLOPT_FOLLOWLOCATION => true,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_HTTPHEADER => array(
            "Access-Token: " . $ACCESS_TOKEN,
        ),
    ));

    $response = curl_exec($curl);
    curl_close($curl);
    return $response;
}

$bc_id = BC_ID;
$funds_type = FUNDS_TYPE;
$start_date = START_DATE;
$end_date = END_DATE;
$page = PAGE;
$page_size = PAGE_SIZE;

/* Args in JSON format */
$my_args = sprintf("{\"bc_id\": \"%s\", \"filtering\": {\"funds_type\": \"%s\"}, \"start_date\": \"%s\", \"end_date\": \"%s\", \"page\": \"%s\", \"page_size\": \"%s\"}", $bc_id, $funds_type, $start_date, $end_date, $page, $page_size);
echo get($my_args);
(/code)

(code curl http)
curl --get -H "Access-Token:xxx" \
--data-urlencode "bc_id=BC_ID" \
--data-urlencode "filtering={\"funds_type\": \"FUNDS_TYPE\"}" \
--data-urlencode "start_date=START_DATE" \
--data-urlencode "end_date=END_DATE" \
--data-urlencode "page=PAGE" \
--data-urlencode "page_size=PAGE_SIZE" \
https://business-api.tiktok.com/open_api/v1.3/bc/transaction/get/
(/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|返回数据  |
#| page_info | object |分页信息|
##|page|number|当前页数 |
##|total_number|number|结果总数|
##|page_size|number|分页大小|
##|total_page|number| 总页数 |
#| list | object[] | 交易记录列表|
##| date | number | 交易日期|
##| amount | number | 交易金额|
##| timezone | string | 时区|
##| currency | string | 交易所用币种 |
##| funds_type | string | 资金类型 |
##| invoice_id | string | 发票ID |
##| invoice_serial_number | string |发票序列号|
#| transaction_summary | object | 交易总额 |
##| amount_charged | number | 总转入额 |
##| amount_paid | number |总转出额 |
##| currency | string |币种|
|request_id|string|请求的日志id，唯一标识一个请求|

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "message": "OK",
    "code": 0,
    "data": {}
}
(/code)