Muokkaa

Jaa

GetBillingDocumentsInfo Service Operation - Customer Billing

  • Artikkeli

Gets a list of objects that contains billing document identification information, for example the billing document identifier, amount, and account identifier.

Request Elements

The GetBillingDocumentsInfoRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element Description Data Type
AccountIds A list of identifiers of the accounts whose billing document information you want to get. long array
EndDate The end date to use for specifying the billing documents to get.

To specify today's date as the end date, set EndDate to NULL.

The end date cannot be earlier than the start date. You must specify the date in Coordinated Universal Time (UTC).		 dateTime
ReturnInvoiceNumber Include the invoice number with the request. boolean
StartDate The start date to use for specifying the billing documents to get.

The start date cannot be later than the end date. You must specify the date in Coordinated Universal Time (UTC).		 dateTime

Request Header Elements

Element Description Data Type
AuthenticationToken The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts.

For more information see Authentication with OAuth.		 string
DeveloperToken The developer token used to access the Bing Ads API.

For more information see Get a Developer Token.		 string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Response Elements

The GetBillingDocumentsInfoResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element Description Data Type
BillingDocumentsInfo The list of billing document information objects that were retrieved. BillingDocumentInfo array

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<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>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<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:e17="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e17:BillingDocumentInfo>
          <e17:AccountId>ValueHere</e17:AccountId>
          <e17:AccountName d4p1:nil="false">ValueHere</e17:AccountName>
          <e17:AccountNumber d4p1:nil="false">ValueHere</e17:AccountNumber>
          <e17:Amount>ValueHere</e17:Amount>
          <e17:CurrencyCode d4p1:nil="false">ValueHere</e17:CurrencyCode>
          <e17:DocumentDate d4p1:nil="false">ValueHere</e17:DocumentDate>
          <e17:DocumentId d4p1:nil="false">ValueHere</e17:DocumentId>
          <e17:CustomerId d4p1:nil="false">ValueHere</e17:CustomerId>
          <e17:CampaignId d4p1:nil="false">ValueHere</e17:CampaignId>
          <e17:DocumentNumber d4p1:nil="false">ValueHere</e17:DocumentNumber>
        </e17:BillingDocumentInfo>
      </BillingDocumentsInfo>
    </GetBillingDocumentsInfoResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

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)

Requirements

Service: CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Billing/v13

Request Url

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

Request Elements

The GetBillingDocumentsInfoRequest object defines the body and header elements of the service operation request.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element Description Data Type
AccountIds A list of identifiers of the accounts whose billing document information you want to get. long array
EndDate The end date to use for specifying the billing documents to get.

To specify today's date as the end date, set EndDate to NULL.

The end date cannot be earlier than the start date. You must specify the date in Coordinated Universal Time (UTC).		 dateTime
ReturnInvoiceNumber Include the invoice number with the request. boolean
StartDate The start date to use for specifying the billing documents to get.

The start date cannot be later than the end date. You must specify the date in Coordinated Universal Time (UTC).		 dateTime

Request Header Elements

Element Description Data Type
Authorization The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication.

For more information see Authentication with OAuth.		 string
DeveloperToken The developer token used to access the Bing Ads API.

For more information see Get a Developer Token.		 string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Response Elements

The GetBillingDocumentsInfoResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.

Response Body Elements

Element Description Data Type
BillingDocumentsInfo The list of billing document information objects that were retrieved. BillingDocumentInfo array

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request JSON

This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

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

Response JSON

This template was generated by a tool to show the body and header elements for the JSON response.

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

Code Syntax

To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

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)