Rapporti di fatturazione
I partner possono utilizzare le seguenti API di fatturazione all'ingrosso per generare i report di fatturazione che li aiutano a verificare l'utilizzo e l'accuratezza del provisioning. Le API di fatturazione all'ingrosso sono accessibili tramite developer.webex.com.
-
Riconciliazione: visualizza il consumo di utilizzo a livello di partner, cliente o utente. I partner possono utilizzare queste informazioni personalizzate del report di fatturazione per riconciliare la fattura mensile e fatturare così ai propri clienti e utenti in base al consumo effettivo.
-
Punto nel tempo: visualizza le allocazioni di pacchetti correnti a livello di cliente o di utente. Il report Point-In-Time fornisce un conteggio in tempo reale delle assegnazioni dei pacchetti. I partner possono utilizzare queste informazioni per verificare l'accuratezza del provisioning e garantire la conformità con gli ordini dei clienti.
I partner possono anche generare report di fatturazione personalizzati per i subpartner utilizzando il parametro subPartnerOrgId.
Sono disponibili quattro API per gli amministratori partner che soddisfano i requisiti minimi di accesso.
|
API di fatturazione |
Scopo dell'API |
Requisito di accesso amministrativo per i partner |
|---|---|---|
|
Crea un report di fatturazione all'ingrosso |
Utilizzato per generare un report di fatturazione. |
Read/write |
|
Ottieni un report di fatturazione all'ingrosso |
Utilizzato per ottenere un report di fatturazione generato e scaricabile. |
Leggi |
|
Elenco dei report di fatturazione all'ingrosso |
Utilizzato per elencare i report di fatturazione esistenti per quel partner. |
Leggi |
|
Elimina un report di fatturazione all'ingrosso |
Utilizzato per eliminare un report di fatturazione esistente. |
Read/write |
Fonte dei dati
I dati per i report di fatturazione vengono ricavati dalle assegnazioni dei pacchetti e dai dati di utilizzo che Webex traccia per ciascun partner. Webex aggrega quotidianamente i dati relativi ai clienti e ai pacchetti utente per generare la fattura mensile del partner. Le API di fatturazione utilizzano questi dati, consentendo agli amministratori dei partner di generare report personalizzati. Questi report aiutano i partner a riconciliare i consumi rilevati nella fattura mensile a livello di partner, cliente e utente.
Per informazioni più dettagliate su come Webex fattura ai partner, consultare Fatturazione del fornitore di servizi.
Crea un report di fatturazione all'ingrosso
| 1 |
Da developer.webex.com, vai a Crea un'API per il report di fatturazione all'ingrosso. |
| 2 |
Seleziona una delle seguenti categorie di report:
Se desideri generare un report di riconciliazione, non è necessario modificare nulla perché la riconciliazione è selezionata per impostazione predefinita, quindi puoi procedere al passaggio successivo. Se si desidera generare un report Point-In-Time, modificare la selezione in Point-In-Time. |
| 3 |
Inserisci billingStartDate e billingEndDate nel formato specificato dall'API. È possibile inserire una data qualsiasi degli ultimi cinque anni, ma non la data odierna. Per il report Point-In-Time, i campi billingStartDatee billingEndDatenon sono obbligatori e vengono ignorati se inseriti. Il report riflette sempre l'attuale allocazione dei pacchetti. |
| 4 |
Inserisci il tipo di report:
|
| 5 |
Nel campo Includi, inserisci le colonne aggiuntive o facoltative che desideri visualizzare nei report. Ogni tipo di report ha una serie di attributi obbligatori e una serie di attributi facoltativi. È possibile decidere quali attributi opzionali visualizzare per ciascun report. Se non si includono gli attributi facoltativi, il report visualizzerà solo gli attributi obbligatori. Le colonne seguenti rappresentano gli attributi opzionali che è possibile richiedere di includere nel report Clienti e Utenti:
Se vuoi visualizzare questi attributi nel tuo report, devi includere insieme CUSTOMER_GROUP_ID e CUSTOMER_GROUP_NAME. Quando si selezionano le colonne facoltative, l'ordine delle colonne nei report di riconciliazione clienti e utenti cambia. I partner devono aggiornare la propria integrazione API per accettare il nuovo formato CSV. L'ordine delle colonne nei report Point-In-Time rimane invariato. Attualmente, le impostazioni delle funzionalità esistenti hanno la precedenza sul parametro Includi nel determinare l'ordine delle colonne. Ad esempio, se una particolare impostazione di funzionalità è abilitata per un cliente, la colonna relativa a tale funzionalità verrà visualizzata secondo il vecchio formato del report, anche se la si aggiunge nel parametro Includi. Rimuoveremo presto queste impostazioni. Una volta rimosse, è possibile richiedere le colonne opzionali solo tramite il parametro Include. |
| 6 |
Fai clic su Esegui per generare il report. |
| 7 |
Copia il report id dall'output dell'API. È possibile utilizzare questo valore con l'API Get per ottenere il report di fatturazione generato. |
Operazioni successive
Vai alla sezione Ottieni un report di fatturazione all'ingrosso per scaricare una copia del report.
Ottieni un report di fatturazione all'ingrosso
Una volta generato un report di fatturazione, utilizzare questa API per ottenere un report di fatturazione specifico. Il report viene generato e inviato a un URL dove è disponibile per il download per 30 minuti dopo il completamento della richiesta GET.
| 1 |
Da developer.webex.com, vai a Ottieni un'API per il report di fatturazione all'ingrosso. |
| 2 |
Inserisci il valore ID univoco per il report e fai clic su Esegui. L'API restituisce lo stato del report. L'output include il parametro tempDownloadURL, che fornisce un URL da cui è possibile scaricare il report. |
| 3 |
Copia tempDownloadURL in un browser per accedere e scaricare il report. |
Elenco dei report di fatturazione all'ingrosso
Utilizza questa API per ottenere un elenco dei report di fatturazione generati per l'organizzazione partner. È possibile visualizzare tutti i report esistenti oppure limitare l'elenco ai report che soddisfano i parametri specificati, come il periodo di fatturazione e il tipo di fatturazione (Partner, cliente, utente).
Se si inseriscono parametri facoltativi, l'API restituisce solo i report che corrispondono esattamente ai parametri specificati. Ad esempio, se si specifica un periodo di fatturazione, verranno restituiti solo i report che utilizzano quello specifico periodo. I report che rientrano nel periodo di riferimento, ma che non corrispondono esattamente alle date, non vengono restituiti.
| 1 |
Da developer.webex.com, vai a Elenco API del report di fatturazione all'ingrosso. |
| 2 |
In Parametri di query, inserisci i parametri di ricerca che desideri utilizzare (ad esempio, startDate, endDate, Type, sortBy on). |
| 3 |
Fare clic su Correre. L'API restituisce l'elenco dei report insieme all'ID univoco del report e allo stato (COMPLETED, IN_PROGRESS).
|
Operazioni successive
Annota l'ID di tutti i report che desideri scaricare. Vai a Ottieni un report di fatturazione all'ingrosso per scaricare il report.
Elimina un report di fatturazione all'ingrosso
Utilizzare questa procedura per eliminare un report di fatturazione generato in base all'ID del report. Ecco alcuni esempi di situazioni in cui potresti voler eliminare un report:
-
Se si desidera rigenerare un report di fatturazione di riconciliazione esistente, è necessario prima eliminare il report esistente. Dopo aver eliminato il report esistente, è possibile crearne uno nuovo per quel periodo. Non è possibile eliminare un report se la sua generazione non è riuscita o è ancora in corso.
Per un report "Point-In-Time", non è necessario eliminare un report esistente, poiché il sistema non rigenera questi report. Ogni report riflette sempre i dati alla data e all'ora attuali.
-
Se invii l'URL di un report generato alla persona sbagliata, puoi eliminare il report in modo che non possa più accedervi.
| 1 |
Da developer.webex.com, vai a Elimina API del report di fatturazione all'ingrosso. |
| 2 |
Inserisci l'ID del report e fai clic su Esegui. |
Campi del report di fatturazione
I report di fatturazione contengono i seguenti campi:
|
Campo |
Descrizione |
Tipo di report supportato |
Categoria di report supportata |
Attributo obbligatorio o facoltativo |
|---|---|---|---|---|
|
PARTNER_NOME |
Nome del partner |
PARTNER, CLIENTE, UTENTE |
Riconciliazione, punto nel tempo |
Obbligatorio |
|
PARTNER_ORG_ID |
Identificativo univoco del partner |
PARTNER, CLIENTE, UTENTE |
Riconciliazione, punto nel tempo |
Obbligatorio |
|
ABBONAMENTO_ID |
Identificativo univoco dell'abbonamento |
PARTNER, CLIENTE, UTENTE |
Riconciliazione, punto nel tempo |
Obbligatorio |
|
CLIENTE_GRUPPO_ID | L'identificativo univoco del gruppo a cui appartiene il cliente. Se il cliente viene spostato tra i gruppi durante il periodo di fatturazione, l'utilizzo viene suddiviso in base ai gruppi a cui il cliente apparteneva durante tale periodo. |
CLIENTE, UTENTE |
Riconciliazione, punto nel tempo |
Opzionale |
|
CLIENTE_GRUPPO_NOME | Nome visualizzato del gruppo di clienti. Se il nome del gruppo è cambiato durante il periodo di fatturazione, verrà utilizzato il nome più recente. |
CLIENTE, UTENTE |
Riconciliazione, punto nel tempo |
Opzionale |
|
CLIENTE_ORGANIZZAZIONE_ID |
identificativo univoco interno del cliente |
CLIENTE, UTENTE |
Riconciliazione, punto nel tempo |
Obbligatorio |
|
CLIENTE_ESTERNO_ID |
Identificativo univoco del cliente fornito da un partner |
CLIENTE, UTENTE |
Riconciliazione, punto nel tempo |
Obbligatorio |
|
TYPE |
Tipo di utente o di spazio di lavoro |
CLIENTE, UTENTE |
Punto nel tempo |
Obbligatorio |
|
ID ABBONATO_ |
Identificativo univoco per l'abbonato |
UTENTE |
Riconciliazione, punto nel tempo |
Obbligatorio |
|
USERID_ |
ID utente Webex dell'abbonato |
UTENTE |
Riconciliazione, punto nel tempo |
Obbligatorio |
|
ID AREA DI LAVORO_ |
Identificatore univoco dello spazio di lavoro |
UTENTE |
Riconciliazione, punto nel tempo |
Obbligatorio |
|
SERVIZIO_NOME |
Nome del servizio (es. CHIAMATA COMUNE_AREA_, CHIAMATA WEBEX_, SUITE WEBEX_, RIUNIONI WEBEX_) |
PARTNER, CLIENTE, UTENTE |
Riconciliazione, punto nel tempo |
Obbligatorio |
|
SKU |
Codice prodotto (SKU) per il servizio |
PARTNER, CLIENTE, UTENTE |
Riconciliazione, punto nel tempo |
Obbligatorio |
|
DESCRIZIONE |
Descrizione del servizio |
PARTNER, CLIENTE, UTENTE |
Riconciliazione, punto nel tempo |
Obbligatorio |
|
CONSUMO_DATA DI INIZIO_ |
Inizio del consumo del servizio. Insieme al campo seguente, questo valore definisce il periodo di utilizzo. |
PARTNER, CLIENTE, UTENTE |
Riconciliazione |
Obbligatorio |
|
CONSUMO_FINE_DATA |
Fine del consumo del servizio. Insieme al campo precedente, questo valore definisce il periodo di consumo. |
PARTNER, CLIENTE, UTENTE |
Riconciliazione |
Obbligatorio |
|
RAPPORTO_DATA |
La data e l'ora in cui viene generato il report. |
CLIENTE, UTENTE |
Punto nel tempo |
Obbligatorio |
|
QUANTITÀ |
Rappresenta il consumo aggregato di utilizzo da parte degli utenti per partner, per cliente o per utente (a seconda del report e del livello di dettaglio con cui si visualizzano i dati). Calcolo: Il sistema calcola la quantità giornaliera per ciascun utente in proporzione al giorno di utilizzo. Utilizzo per un'intera giornata = 1 Utilizzo per mezza giornata = 0,5 Successivamente, somma i totali giornalieri per tutti i giorni del periodo di fatturazione per calcolare la quantità totale per quell'utente in quel periodo di fatturazione. Per i report a livello di cliente e partner, i totali di tutti gli utenti vengono aggregati per fornire una quantità totale per quel cliente o partner. Esatto momento: Il report clienti elenca le assegnazioni dei pacchetti per ciascun cliente. Ogni riga rappresenta la quantità totale di uno specifico pacchetto assegnato agli utenti o agli spazi di lavoro all'interno di una particolare organizzazione cliente. La quantità mostra "0" se non sono stati assegnati pacchetti. Il report utente elenca i pacchetti assegnati agli utenti o agli spazi di lavoro. Ogni riga mostra una quantità pari a 1, che rappresenta un utente o uno spazio di lavoro e il relativo pacchetto o componente aggiuntivo. Se a un utente o a un'area di lavoro sono assegnati più pacchetti o componenti aggiuntivi, il report mostrerà più voci, ciascuna con una quantità pari a 1. |
PARTNER, CLIENTE, UTENTE |
Riconciliazione, punto nel tempo |
Obbligatorio |
|
POSIZIONE_ID |
Identificatore univoco della posizione |
CLIENTE, UTENTE |
Riconciliazione, punto nel tempo Il report Point-In-Time del cliente non include l'ID della posizione |
Opzionale |
|
LICENZA_ID |
Identificativo della licenza Questo campo è visibile solo per i pacchetti all'ingrosso. Nel report di riconciliazione, il campo License_ID è vuoto per le licenze assegnate prima dell'introduzione di questo campo. Il report di fatturazione mostra più righe per lo stesso pacchetto all'ingrosso se è associato a diverse combinazioni di ID SEDE_e ID LICENZA_. |
CLIENTE, UTENTE |
Riconciliazione, punto nel tempo |
Opzionale |
La selezione delle colonne opzionali modifica l'ordine delle colonne nei report di riconciliazione clienti e utenti. Il seguente ordine si applica ai partner che hanno solo SKU all'ingrosso nel loro abbonamento:
Report a livello utente—PARTNER_NOME, PARTNER_ORG_ID, ABBONAMENTO_ID, CLIENTE_GRUPPO_ID, CLIENTE_GRUPPO_NOME, CLIENTE_ORG_ID, CLIENTE_ESTERNO_ID, POSIZIONE_ID, LICENZA_ID, ABBONATO_ID, UTENTE_ID, SPAZIO DI LAVORO_ID, SERVIZIO_NOME, SKU, DESCRIZIONE, CONSUMO_DATA INIZIO_DATA CONSUMO_DATA FINE_DATA, QUANTITÀ
Report a livello cliente—PARTNER_NOME, PARTNER_ORG_ID, ABBONAMENTO_ID, CLIENTE_GRUPPO_ID, CLIENTE_GRUPPO_NOME, CLIENTE_ORG_ID, CLIENTE_ESTERNO_ID, SEDE_ID, LICENZA_ID, SERVIZIO_NOME, SKU, DESCRIZIONE, CONSUMO_DATA INIZIO_, CONSUMO_DATA FINE_, QUANTITÀ
L'assegnazione di un pacchetto a un utente attiva la fatturazione Webex Wholesale, mentre la rimozione dell'assegnazione del pacchetto la interrompe.
Un'organizzazione cliente può appartenere a un solo gruppo di clienti alla volta. Al momento non è disponibile il supporto per più gruppi di clienti per organizzazione.