GetBillingDocumentsInfo Service Operation

 

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

System_CAPS_ICON_note.jpg Note

This operation will not return billing documents associated with Yahoo!-managed accounts.

Request | Response

Request Body

The GetBillingDocumentsInfoRequest object defines the elements of the request’s body. The elements must be in the same order as shown in the SOAP Request SOAP.

ElementDescriptionData Type
AccountIdsA list of identifiers of the accounts whose billing document information you want to get.long array
StartDateThe 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
EndDateThe 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

Request Headers

Set the required header elements for each service request. New customers are required to sign up for Bing Ads with a Microsoft Account, and to manage those accounts you must use OAuth. Existing users with legacy Bing Ads credentials may continue to specify the UserName and Password header elements. In future versions of the API, Bing Ads will transition exclusively to Microsoft Account authentication. For more information, see Getting Started With the Bing Ads API.

OAuth Authentication

These request headers are required for Authentication with OAuth.

ElementDescriptionData Type
AuthenticationTokenThe OAuth access token that represents a Microsoft Account user who has permissions to Bing Ads accounts.string
DeveloperTokenThe developer token used to access the Bing Ads API.string

Password Authentication

These request headers are required for legacy username and password authentication.

ElementDescriptionData Type
DeveloperTokenThe developer token used to access the Bing Ads API.string
PasswordThe Bing Ads user's sign-in password.string
UserNameThe Bing Ads user's sign-in user name. You must not set this element to a Microsoft account or email address. To authenticate a Microsoft account, use the AuthenticationToken header instead of UserName and Password.string

Request SOAP

The following example shows the complete request envelope.

<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/v11">
    <Action mustUnderstand="1">GetBillingDocumentsInfo</Action>
    <ApplicationToken i:nil="false"></ApplicationToken>
    <AuthenticationToken i:nil="false"></AuthenticationToken>
    <DeveloperToken i:nil="false"></DeveloperToken>
    <Password i:nil="false"></Password>
    <UserName i:nil="false"></UserName>
  </s:Header>
  <s:Body>
    <GetBillingDocumentsInfoRequest xmlns="https://bingads.microsoft.com/Billing/v11">
      <AccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long></a1:long>
      </AccountIds>
      <StartDate></StartDate>
      <EndDate i:nil="false"></EndDate>
    </GetBillingDocumentsInfoRequest>
  </s:Body>
</s:Envelope>

Response Body

ElementDescriptionData Type
BillingDocumentsInfoThe list of billing document information objects that were retrieved.BillingDocumentInfo array

Response Header

ElementDescriptionData Type
TrackingIdThe identifier of the log entry that contains the details of the API call.string

Response SOAP

The following example shows the complete response envelope.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Billing/v11">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetBillingDocumentsInfoResponse xmlns="https://bingads.microsoft.com/Billing/v11">
      <BillingDocumentsInfo xmlns:e3="https://bingads.microsoft.com/Customer/v11/Entities" p5:nil="false" xmlns:p5="http://www.w3.org/2001/XMLSchema-instance">
        <e3:BillingDocumentInfo>
          <e3:AccountId></e3:AccountId>
          <e3:AccountName p5:nil="false"></e3:AccountName>
          <e3:AccountNumber p5:nil="false"></e3:AccountNumber>
          <e3:Amount></e3:Amount>
          <e3:CurrencyCode p5:nil="false"></e3:CurrencyCode>
          <e3:DocumentDate p5:nil="false"></e3:DocumentDate>
          <e3:DocumentId p5:nil="false"></e3:DocumentId>
        </e3:BillingDocumentInfo>
      </BillingDocumentsInfo>
    </GetBillingDocumentsInfoResponse>
  </s:Body>
</s:Envelope>

If the service operation fails, it throws a FaultException exception, which contains one or more of the Bing Ads API error data objects. For information about the fault detail objects, see Customer Billing Error Data Objects and Handling Service Errors and Exceptions.The following are example error codes that the error objects can include when using this service operation. For all documented error codes, please see Bing Ads Operation Error Codes.

Error Code
InvalidCredentials

GetBillingDocuments

Show: