Condividi tramite

Operazione del servizio GetBillingDocumentsInfo - Fatturazione del cliente

  • Articolo

Ottiene un elenco di oggetti che contiene informazioni di identificazione del documento di fatturazione, ad esempio l'identificatore del documento di fatturazione, l'importo e l'identificatore dell'account.

Elementi della richiesta

L'oggetto GetBillingDocumentsInfoRequest definisce il corpo e gli elementi dell'intestazione della richiesta di operazione del servizio. Gli elementi devono essere nello stesso ordine indicato nella richiesta SOAP.

Nota

Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.

Elementi del corpo della richiesta

Elemento Descrizione Tipo di dati
AccountIds Elenco di identificatori degli account di cui si desidera ottenere le informazioni del documento di fatturazione. matrice long
EndDate Data di fine da utilizzare per specificare i documenti di fatturazione da ottenere.

Per specificare la data odierna come data di fine, impostare EndDate su NULL.

La data di fine non può essere precedente alla data di inizio. È necessario specificare la data nell'ora UTC (Coordinated Universal Time).		 dateTime
ReturnInvoiceNumber Includere il numero di fattura con la richiesta. booleano
StartDate Data di inizio da usare per specificare i documenti di fatturazione da ottenere.

La data di inizio non può essere successiva alla data di fine. È necessario specificare la data nell'ora UTC (Coordinated Universal Time).		 dateTime

Elementi dell'intestazione della richiesta

Elemento Descrizione Tipo di dati
AuthenticationToken Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising.

Per altre informazioni, vedere Autenticazione con OAuth.		 corda
DeveloperToken Token di sviluppo usato per accedere all'API Bing Ads.

Per altre informazioni, vedere Ottenere un token per sviluppatori.		 corda
Password Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda
UserName Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda

Elementi di risposta

L'oggetto GetBillingDocumentsInfoResponse definisce il corpo e gli elementi dell'intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nella soap di risposta.

Elementi del corpo della risposta

Elemento Descrizione Tipo di dati
BillingDocumentsInfo Elenco di oggetti informazioni sui documenti di fatturazione recuperati. Matrice BillingDocumentInfo

Elementi dell'intestazione della risposta

Elemento Descrizione Tipo di dati
TrackingId Identificatore della voce di log che contiene i dettagli della chiamata API. corda

Richiedi SOAP

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi corpo e intestazione per la richiesta SOAP. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.

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

SOAP della risposta

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi del corpo e dell'intestazione per la risposta 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>
    <GetBillingDocumentsInfoResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <BillingDocumentsInfo xmlns:e163="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e163:BillingDocumentInfo>
          <e163:AccountId>ValueHere</e163:AccountId>
          <e163:AccountName d4p1:nil="false">ValueHere</e163:AccountName>
          <e163:AccountNumber d4p1:nil="false">ValueHere</e163:AccountNumber>
          <e163:Amount>ValueHere</e163:Amount>
          <e163:CurrencyCode d4p1:nil="false">ValueHere</e163:CurrencyCode>
          <e163:DocumentDate d4p1:nil="false">ValueHere</e163:DocumentDate>
          <e163:DocumentId d4p1:nil="false">ValueHere</e163:DocumentId>
          <e163:CustomerId d4p1:nil="false">ValueHere</e163:CustomerId>
          <e163:CampaignId d4p1:nil="false">ValueHere</e163:CampaignId>
          <e163:DocumentNumber d4p1:nil="false">ValueHere</e163:DocumentNumber>
        </e163:BillingDocumentInfo>
      </BillingDocumentsInfo>
    </GetBillingDocumentsInfoResponse>
  </s:Body>
</s:Envelope>

Sintassi del codice

La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .

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)

Requisiti

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

URL richiesta

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

Elementi della richiesta

L'oggetto GetBillingDocumentsInfoRequest definisce il corpo e gli elementi dell'intestazione della richiesta di operazione del servizio.

Nota

Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.

Elementi del corpo della richiesta

Elemento Descrizione Tipo di dati
AccountIds Elenco di identificatori degli account di cui si desidera ottenere le informazioni del documento di fatturazione. matrice long
EndDate Data di fine da utilizzare per specificare i documenti di fatturazione da ottenere.

Per specificare la data odierna come data di fine, impostare EndDate su NULL.

La data di fine non può essere precedente alla data di inizio. È necessario specificare la data nell'ora UTC (Coordinated Universal Time).		 dateTime
ReturnInvoiceNumber Includere il numero di fattura con la richiesta. booleano
StartDate Data di inizio da usare per specificare i documenti di fatturazione da ottenere.

La data di inizio non può essere successiva alla data di fine. È necessario specificare la data nell'ora UTC (Coordinated Universal Time).		 dateTime

Elementi dell'intestazione della richiesta

Elemento Descrizione Tipo di dati
Autorizzazione Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising. Assicurarsi che il token sia preceduto da "Bearer", necessario per l'autenticazione corretta.

Per altre informazioni, vedere Autenticazione con OAuth.		 corda
DeveloperToken Token di sviluppo usato per accedere all'API Bing Ads.

Per altre informazioni, vedere Ottenere un token per sviluppatori.		 corda
Password Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda
UserName Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda

Elementi di risposta

L'oggetto GetBillingDocumentsInfoResponse definisce il corpo e gli elementi dell'intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nel codice JSON della risposta.

Elementi del corpo della risposta

Elemento Descrizione Tipo di dati
BillingDocumentsInfo Elenco di oggetti informazioni sui documenti di fatturazione recuperati. Matrice BillingDocumentInfo

Elementi dell'intestazione della risposta

Elemento Descrizione Tipo di dati
TrackingId Identificatore della voce di log che contiene i dettagli della chiamata API. corda

Richiedere JSON

Questo modello è stato generato da uno strumento per visualizzare il corpo e gli elementi di intestazione per la richiesta JSON. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.

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

Risposta JSON

Questo modello è stato generato da uno strumento per mostrare il corpo e gli elementi dell'intestazione per la risposta JSON.

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

Sintassi del codice

Per chiamare l'API REST tramite SDK, è necessario aggiornare l'SDK a una determinata versione e configurare i parametri di sistema. La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .

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)