GetBillingDocumentsInfo 服务操作 - 客户计费

获取包含计费文档标识信息的对象列表，例如计费文档标识符、金额和帐户标识符。

请求元素

GetBillingDocumentsInfoRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素	说明	数据类型
AccountIds	要获取其计费文档信息的帐户的标识符列表。	long 数组
EndDate	用于指定要获取的计费文档的结束日期。 若要将今天的日期指定为结束日期，请将 EndDate 设置为 NULL。 结束日期不能早于开始日期。 必须在协调世界时 (UTC) 中指定日期。	dateTime
ReturnInvoiceNumber	在请求中包含发票编号。	boolean
StartDate	用于指定要获取的计费文档的开始日期。 开始日期不能晚于结束日期。 必须在协调世界时 (UTC) 中指定日期。	dateTime

请求标头元素

元素	说明	数据类型
AuthenticationToken	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

GetBillingDocumentsInfoResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。

响应正文元素

元素	说明	数据类型
BillingDocumentsInfo	检索到的计费文档信息对象列表。	BillingDocumentInfo 数组

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 API 调用详细信息的日志条目的标识符。	string

请求 SOAP

此模板由一个工具生成，用于显示 SOAP 请求的正文和标头元素的顺序。 有关可用于此服务操作的支持类型，请参阅上面的 请求正文元素 参考。

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Billing/v13">
    <Action mustUnderstand="1">GetBillingDocumentsInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetBillingDocumentsInfoRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <AccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </AccountIds>
      <StartDate>ValueHere</StartDate>
      <EndDate i:nil="false">ValueHere</EndDate>
      <ReturnInvoiceNumber i:nil="false">ValueHere</ReturnInvoiceNumber>
    </GetBillingDocumentsInfoRequest>
  </s:Body>
</s:Envelope>

响应 SOAP

此模板由一个工具生成，用于显示 SOAP 响应的 正文 和 标头 元素的顺序。

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Billing/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetBillingDocumentsInfoResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <BillingDocumentsInfo xmlns:e163="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e163:BillingDocumentInfo>
          <e163:AccountId>ValueHere</e163:AccountId>
          <e163:AccountName d4p1:nil="false">ValueHere</e163:AccountName>
          <e163:AccountNumber d4p1:nil="false">ValueHere</e163:AccountNumber>
          <e163:Amount>ValueHere</e163:Amount>
          <e163:CurrencyCode d4p1:nil="false">ValueHere</e163:CurrencyCode>
          <e163:DocumentDate d4p1:nil="false">ValueHere</e163:DocumentDate>
          <e163:DocumentId d4p1:nil="false">ValueHere</e163:DocumentId>
          <e163:CustomerId d4p1:nil="false">ValueHere</e163:CustomerId>
          <e163:CampaignId d4p1:nil="false">ValueHere</e163:CampaignId>
          <e163:DocumentNumber d4p1:nil="false">ValueHere</e163:DocumentNumber>
        </e163:BillingDocumentInfo>
      </BillingDocumentsInfo>
    </GetBillingDocumentsInfoResponse>
  </s:Body>
</s:Envelope>

代码语法

示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

public async Task<GetBillingDocumentsInfoResponse> GetBillingDocumentsInfoAsync(
	IList<long> accountIds,
	DateTime startDate,
	DateTime? endDate,
	bool? returnInvoiceNumber)
{
	var request = new GetBillingDocumentsInfoRequest
	{
		AccountIds = accountIds,
		StartDate = startDate,
		EndDate = endDate,
		ReturnInvoiceNumber = returnInvoiceNumber
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.GetBillingDocumentsInfoAsync(r), request));
}

static GetBillingDocumentsInfoResponse getBillingDocumentsInfo(
	ArrayOflong accountIds,
	Calendar startDate,
	Calendar endDate,
	boolean returnInvoiceNumber) throws RemoteException, Exception
{
	GetBillingDocumentsInfoRequest request = new GetBillingDocumentsInfoRequest();

	request.setAccountIds(accountIds);
	request.setStartDate(startDate);
	request.setEndDate(endDate);
	request.setReturnInvoiceNumber(returnInvoiceNumber);

	return CustomerBillingService.getService().getBillingDocumentsInfo(request);
}

static function GetBillingDocumentsInfo(
	$accountIds,
	$startDate,
	$endDate,
	$returnInvoiceNumber)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];

	$request = new GetBillingDocumentsInfoRequest();

	$request->AccountIds = $accountIds;
	$request->StartDate = $startDate;
	$request->EndDate = $endDate;
	$request->ReturnInvoiceNumber = $returnInvoiceNumber;

	return $GLOBALS['CustomerBillingProxy']->GetService()->GetBillingDocumentsInfo($request);
}

response=customerbilling_service.GetBillingDocumentsInfo(
	AccountIds=AccountIds,
	StartDate=StartDate,
	EndDate=EndDate,
	ReturnInvoiceNumber=ReturnInvoiceNumber)

要求

服务： CustomerBillingService.svc v13
命名空间： https://bingads.microsoft.com/Billing/v13

请求 URL

生产 URL

https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/BillingDocumentsInfo/Query

沙盒 URL

https://clientcenter.api.sandbox.bingads.microsoft.com/CustomerBilling/v13/BillingDocumentsInfo/Query

请求元素

GetBillingDocumentsInfoRequest 对象定义服务操作请求的正文和标头元素。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素	说明	数据类型
AccountIds	要获取其计费文档信息的帐户的标识符列表。	long 数组
EndDate	用于指定要获取的计费文档的结束日期。 若要将今天的日期指定为结束日期，请将 EndDate 设置为 NULL。 结束日期不能早于开始日期。 必须在协调世界时 (UTC) 中指定日期。	dateTime
ReturnInvoiceNumber	在请求中包含发票编号。	boolean
StartDate	用于指定要获取的计费文档的开始日期。 开始日期不能晚于结束日期。 必须在协调世界时 (UTC) 中指定日期。	dateTime

请求标头元素

元素	说明	数据类型
Authorization	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

GetBillingDocumentsInfoResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。

响应正文元素

元素	说明	数据类型
BillingDocumentsInfo	检索到的计费文档信息对象列表。	BillingDocumentInfo 数组

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 API 调用详细信息的日志条目的标识符。	string

请求 JSON

此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型，请参阅上面的 请求正文元素 参考。

{
  "AccountIds": [
    "LongValueHere"
  ],
  "StartDate": "ValueHere",
  "EndDate": "ValueHere",
  "ReturnInvoiceNumber": "ValueHere"
}

响应 JSON

此模板由一个工具生成，用于显示 JSON 响应的 正文 和 标头 元素。

{
  "BillingDocumentsInfo": [
    {
      "AccountId": "LongValueHere",
      "AccountName": "ValueHere",
      "AccountNumber": "ValueHere",
      "Amount": DoubleValueHere,
      "CampaignId": "LongValueHere",
      "CurrencyCode": "ValueHere",
      "CustomerId": IntValueHere,
      "DocumentDate": "ValueHere",
      "DocumentId": "LongValueHere",
      "DocumentNumber": "ValueHere"
    }
  ]
}

代码语法

若要通过 SDK 调用 REST API，需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

public async Task<GetBillingDocumentsInfoResponse> GetBillingDocumentsInfoAsync(
	IList<long> accountIds,
	DateTime startDate,
	DateTime? endDate,
	bool? returnInvoiceNumber)
{
	var request = new GetBillingDocumentsInfoRequest
	{
		AccountIds = accountIds,
		StartDate = startDate,
		EndDate = endDate,
		ReturnInvoiceNumber = returnInvoiceNumber
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.GetBillingDocumentsInfoAsync(r), request));
}

static GetBillingDocumentsInfoResponse getBillingDocumentsInfo(
	ArrayOflong accountIds,
	Calendar startDate,
	Calendar endDate,
	boolean returnInvoiceNumber) throws RemoteException, Exception
{
	GetBillingDocumentsInfoRequest request = new GetBillingDocumentsInfoRequest();

	request.setAccountIds(accountIds);
	request.setStartDate(startDate);
	request.setEndDate(endDate);
	request.setReturnInvoiceNumber(returnInvoiceNumber);

	return CustomerBillingService.getService().getBillingDocumentsInfo(request);
}

static function GetBillingDocumentsInfo(
	$accountIds,
	$startDate,
	$endDate,
	$returnInvoiceNumber)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];

	$request = new GetBillingDocumentsInfoRequest();

	$request->AccountIds = $accountIds;
	$request->StartDate = $startDate;
	$request->EndDate = $endDate;
	$request->ReturnInvoiceNumber = $returnInvoiceNumber;

	return $GLOBALS['CustomerBillingProxy']->GetService()->GetBillingDocumentsInfo($request);
}

response=customerbilling_service.GetBillingDocumentsInfo(
	AccountIds=AccountIds,
	StartDate=StartDate,
	EndDate=EndDate,
	ReturnInvoiceNumber=ReturnInvoiceNumber)