GetBillingDocuments Service Operation - Customer Billing

Article
03/20/2023

Gets the specified billing documents.

Request Elements

The GetBillingDocumentsRequest 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
BillingDocumentsInfo	Identifies the list of billing documents that you want to get. Each BillingDocumentInfo object in the list must contain the CustomerId and DocumentId. The other properties are ignored. You can include up to 25 items in the list.	BillingDocumentInfo array
Type	The format to use to generate the billing document. For example, you can generate the billing document in PDF or XML format.	DataType

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 GetBillingDocumentsResponse 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
BillingDocuments	The list of billing documents that were retrieved.	BillingDocument 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">GetBillingDocuments</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetBillingDocumentsRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <BillingDocumentsInfo xmlns:e7="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e7:BillingDocumentInfo>
          <e7:AccountId>ValueHere</e7:AccountId>
          <e7:AccountName i:nil="false">ValueHere</e7:AccountName>
          <e7:AccountNumber i:nil="false">ValueHere</e7:AccountNumber>
          <e7:Amount>ValueHere</e7:Amount>
          <e7:CurrencyCode i:nil="false">ValueHere</e7:CurrencyCode>
          <e7:DocumentDate i:nil="false">ValueHere</e7:DocumentDate>
          <e7:DocumentId i:nil="false">ValueHere</e7:DocumentId>
          <e7:CustomerId i:nil="false">ValueHere</e7:CustomerId>
          <e7:CampaignId i:nil="false">ValueHere</e7:CampaignId>
          <e7:DocumentNumber i:nil="false">ValueHere</e7:DocumentNumber>
        </e7:BillingDocumentInfo>
      </BillingDocumentsInfo>
      <Type>ValueHere</Type>
    </GetBillingDocumentsRequest>
  </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>
    <GetBillingDocumentsResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <BillingDocuments xmlns:e8="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e8:BillingDocument>
          <e8:Data d4p1:nil="false">ValueHere</e8:Data>
          <e8:Id>ValueHere</e8:Id>
          <e8:Type>ValueHere</e8:Type>
          <e8:Number d4p1:nil="false">ValueHere</e8:Number>
        </e8:BillingDocument>
      </BillingDocuments>
    </GetBillingDocumentsResponse>
  </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<GetBillingDocumentsResponse> GetBillingDocumentsAsync(
	IList<BillingDocumentInfo> billingDocumentsInfo,
	DataType type)
{
	var request = new GetBillingDocumentsRequest
	{
		BillingDocumentsInfo = billingDocumentsInfo,
		Type = type
	};

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

static GetBillingDocumentsResponse getBillingDocuments(
	ArrayOfBillingDocumentInfo billingDocumentsInfo,
	DataType type) throws RemoteException, Exception
{
	GetBillingDocumentsRequest request = new GetBillingDocumentsRequest();

	request.setBillingDocumentsInfo(billingDocumentsInfo);
	request.setType(type);

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

static function GetBillingDocuments(
	$billingDocumentsInfo,
	$type)
{

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

	$request = new GetBillingDocumentsRequest();

	$request->BillingDocumentsInfo = $billingDocumentsInfo;
	$request->Type = $type;

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

response=customerbilling_service.GetBillingDocuments(
	BillingDocumentsInfo=BillingDocumentsInfo,
	Type=Type)

Requirements

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

Share via