Operação do Serviço GetBillingDocuments – Faturação do Cliente

Artigo
12/21/2023

Obtém os documentos de faturação especificados.

Elementos do Pedido

O objeto GetBillingDocumentsRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.

Nota

Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.

Elementos do Corpo do Pedido

Elemento	Descrição	Tipo de Dados
BillingDocumentsInfo	Identifica a lista de documentos de faturação que pretende obter. Cada objeto BillingDocumentInfo na lista tem de conter CustomerId e DocumentId. As outras propriedades são ignoradas. Pode incluir até 25 itens na lista.	Matriz BillingDocumentInfo
Tipo	O formato a utilizar para gerar o documento de faturação. Por exemplo, pode gerar o documento de faturação no formato PDF ou XML.	Tipo de Dados

Elementos do Cabeçalho do Pedido

Elemento	Descrição	Tipo de Dados
AuthenticationToken	O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth).	cadeia
DeveloperToken	O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador.	cadeia
Palavra-passe	Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador.	cadeia
Nome de Utilizador	Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador.	cadeia

Elementos de Resposta

O objeto GetBillingDocumentsResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.

Elementos do Corpo da Resposta

Elemento	Descrição	Tipo de Dados
FaturaçãoDocumentos	A lista de documentos de faturação que foram obtidos.	Matriz BillingDocument

Elementos do Cabeçalho de Resposta

Elemento	Descrição	Tipo de Dados
TrackingId	O identificador da entrada de registo que contém os detalhes da chamada à API.	cadeia

Pedir SOAP

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.

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

Soap de Resposta

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta 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>
    <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>

Sintaxe de Código

A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.

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)

Requisitos

Serviço: CustomerBillingService.svc v13
Espaço de nomes: https://bingads.microsoft.com/Billing/v13

Partilhar via