Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

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

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

Request | Response

Error Codes

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

GetBillingDocumentsInfoRequest Message

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

Element

Description

Data Type

AccountIds

A list of identifiers of the accounts whose billing document information you want to get.

long array

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

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

Request Header

For information about the values you set the DeveloperToken, Password, and UserName elements to, see Getting Started With the Bing Ads API.

Element

Description

Data Type

ApplicationToken

The application-access token. This header element is not used and should be null.

string

AuthenticationToken

The OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account. For more information, see Managing User Authentication with OAuth.

string

DeveloperToken

The client application's developer access token.

string

Password

The Bing Ads user's sign-in password.

string

UserName

The Bing Ads user's sign-in user name. You may not set this element to a Microsoft account.

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/v9">
    <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/v9">
      <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>

GetBillingDocumentsInfoResponse Message

Response Body

Element

Description

Data Type

BillingDocumentsInfo

The list of billing document information objects that were retrieved.

BillingDocumentInfo array

Response Header

Element

Description

Data Type

TrackingId

The 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/v9">
    <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/v9">
      <BillingDocumentsInfo xmlns:e3="https://bingads.microsoft.com/Customer/v9/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>

Error Codes

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

Community Additions

ADD
Show:
© 2015 Microsoft