Faktureringsrapporter
Partners kan använda följande API:er för grossistfakturering för att generera faktureringsrapporter som hjälper dem att validera användnings- och provisioneringsnoggrannhet. API:erna för grossistfakturering är tillgängliga via developer.webex.com.
-
Avstämning — Visar användningsförbrukning per partner, kund eller användare. Partners kan använda den här anpassade faktureringsrap portinformationen för att avstämma sin månatliga faktura så att de kan fakturera sina kunder och användare enligt deras användningsförbrukning.
-
Point-In-Time — Visar aktuella paketallokeringar per kund- eller användarnivå. Point-in-Time-rapporten ger en realtidsräkning av paketallokeringar. Partners kan använda denna information för att validera noggrannheten i provisioneringen och säkerställa anpassning till kundorder.
Partners kan också generera anpassade faktureringsrapporter för underpartner med parametern SubpartnerOrgID.
Det finns fyra API:er som är tillgängliga för partneradministratörer som uppfyller minimik raven för åtkomst.
|
Fakturerings-API |
Syftet med API |
Krav på partneradministratörsåtkomst |
|---|---|---|
|
Skapa en grossistfaktureringsrapport |
Används för att generera en faktureringsrapport. |
Läs/skriv |
|
Få en grossistfaktureringsrapport |
Används för att få en genererad faktureringsrapport för nedladdning. |
Läs |
|
Lista grossistfaktureringsrapporter |
Används för att lista de faktureringsrapporter som finns för den partnern. |
Läs |
|
Ta bort en grossistfaktureringsrapport |
Används för att ta bort en befintlig faktureringsrapport. |
Läs/skriv |
Datakälla
Data för faktureringsrapporterna hämtas från pakettilldelningar och användningsdata som Webex spårar för varje partner. Webex aggregerar kund- och användarpaketdata dagligen för att generera partnerns månatliga faktura. Fakturerings-API:er använder dessa data, vilket gör det möjligt för partneradministratörer att generera anpassade rapporter. Dessa rapporter hjälper partners att av stämma användningsförbrukningen från sin månatliga faktura på partner-, kund- och användarnivå.
Mer detaljerad information om hur Webex fakturerar partners finns i Tjänstel everantörsfakturering.
Skapa en grossistfaktureringsrapport
| 1 |
Från developer.webex.com går du till Skapa en API för grossistfaktureringsrapport. |
| 2 |
Välj någon av följande rapportkategorier:
Om du vill skapa en Avstämningsrapport behöver du inte ändra något eftersom Avstämning är markerat som standard, så att du kan gå vidare till nästa steg. Om du vill skapa en Point-i-Time-rapport ändrar du markeringen till Point-i- Time. |
| 3 |
Ange BillingStartDate och BillingEndDate i det format som API anger. Du kan ange vilket datum som helst från de senaste fem åren, men inte den aktuella dagen. För Point-in-Time-rapporten krävs inte fälten BillingStartDate och BillingEndDate och ignoreras om de anges. Rapporten återspeglar alltid de nuvarande paketans lagen. |
| 4 |
Ange typ av rapport:
|
| 5 |
I fältet Inklu dera anger du ytterligare eller valfria kolumner som du vill se i rapporterna. Varje rapporttyp har en uppsättning obligatoriska attribut och en uppsättning valfria attribut. Du kan bestämma vilka av de valfria attributen som ska visas för varje rapport. Om du inte inkluderar de valfria attributen visas endast de obligatoriska attributen i rapporten. Följande kolumner är de valfria attribut som du kan begära att inkludera i rapporten Kund och användare:
Du måste inkludera CUSTOMER_GROUP_ID och CUSTOMER_GROUP_NAME tillsammans om du vill se dessa attribut i din rapport. När du väljer valfria kolumner ändras kolumnordningen i rapporterna Kund- och Användaravstämning. Partners måste uppdatera sin API-integration för att acceptera det nya csv-formatet. Kolumnordningen för Point-In-Time-rapporter förblir oförändrad. För närvarande har de befintliga funktionsinställningarna företräde framför parametern Inkludera när kolumnordningen bestäms. Om en viss funktionsinställning till exempel är aktiverad för en kund visas funktionskolumnen enligt det gamla rapportformatet även om du lägger till dem i parametern Inkludera. Vi tar bort dessa inställningar snart. När de har tagits bort kan du bara begära de valfria kolumnerna via parametern Inkludera. |
| 6 |
Klicka på Kör för att generera rapporten. |
| 7 |
Kopiera rapport -id från API-utdata. Du kan använda det här värdet med Get API för att hämta den genererade faktureringsrapporten. |
Vad du ska göra härnäst
Gå till avsnittet Hämta en grossistfaktureringsrapport för att ladda ner en kopia av rapporten.
Få en grossistfaktureringsrapport
När en faktureringsrapport har genererats, använd detta API för att få en specifik faktureringsrapport. Rapporten matas ut till en URL där den är tillgänglig för nedladdning i 30 minuter efter att GET -begäran har slutförts.
| 1 |
Från developer.webex.com går du till G et a Wholesale Billing Report API. |
| 2 |
Ange det unika id- värdet för rapporten och klicka på Kör. API:et matar ut rapportstatus. Utdata innehåller parametern tempDownloadURL, som ger en URL från vilken du kan ladda ner rapporten. |
| 3 |
Kopiera TempDownloadURL till en webbläsare för att komma åt och ladda ner rapporten. |
Lista grossistfaktureringsrapporter
Använd det här API:et för att få en lista över genererade faktureringsrapporter för partnerorganisationen. Du kan lista alla befintliga rapporter eller begränsa listan till de rapporter som uppfyller de angivna parametrarna, till exempel faktureringsperiod och faktureringstyp (partner, kund, användare).
Om du anger valfria parametrar returnerar API:et endast de rapporter som match ar exakt de parametrar som du anger. Om du till exempel anger en fakturerings period returneras endast rapporter som använder den specifika faktureringsperioden. Rapporter som faller inom perioden, men som inte exakt matchar datumen returneras inte.
| 1 |
Från developer.webex.com går du till List Wholes ale Billing Report API. |
| 2 |
Under Frågeparametrar anger du de sökparametrar som du vill använda (till exempel startdatum, slutdatum, typ, sortBy på). |
| 3 |
Klicka på Kör. API:et matar ut listan över rapporter tillsammans med det unika rapport -id och status (SLUTFÖRD,IN_PROGRESS).
|
Vad du ska göra härnäst
Ta en lista över id för alla rapporter som du vill ladda ner. Gå till Hämta en grossistfaktureringsrapport för att ladda ner rapporten.
Ta bort en grossistfaktureringsrapport
Använd den här proceduren för att ta bort en genererad faktureringsrapport baserad på rapport-id. Några exempel där du kanske vill ta bort en rapport är:
-
Om du vill skapa en befintlig avstämningsfaktureringsrapport måste du först ta bort den befintliga rapporten. När du har tagit bort den befintliga rapporten kan du skapa en ny rapport för den perioden. Du kan inte ta bort en rapport om dess generering har misslyckats eller fortfarande pågår.
För en Point-In-Time-rapport behöver du inte ta bort en befintlig rapport, eftersom systemet inte genererar dessa rapporter. Varje rapport återspeglar alltid data från och med den aktuella tidsstämpeln.
-
Om du skickar en genererad rapport-URL till fel person kan du ta bort rapporten så att de inte kan komma åt den.
| 1 |
Från developer.webex.com går du till Ta bort API för grossistfaktureringsrapport. |
| 2 |
Ange rapport- ID och klicka på Kör. |
Faktureringsrapportfält
Faktureringsrapporter innehåller följande fält:
|
Fält |
Beskrivning |
Rapporttyp som stöds |
Rapportkategori som stöds |
Obligatoriskt eller valfritt attribut |
|---|---|---|---|---|
|
PARTNER_NAME |
Namn på partner |
PARTNER, CUSTOMER, USER |
Avstämning, Point-i-Time |
Obligatorisk |
|
PARTNER_ORG_ID |
Unik partneridentifierare |
PARTNER, CUSTOMER, USER |
Avstämning, Point-i-Time |
Obligatorisk |
|
SUBSCRIPTION_ID |
Unik prenumerationsidentifierare |
PARTNER, CUSTOMER, USER |
Avstämning, Point-i-Time |
Obligatorisk |
|
CUSTOMER_GROUP_ID | Den unika identifieraren för den grupp kunden tillhör. Om kunden flyttas mellan grupper under faktureringsperioden delas användningen upp baserat på de grupper kunden tillhörde under den perioden. |
CUSTOMER, USER |
Avstämning, Point-i-Time |
Valfritt |
|
CUSTOMER_GROUP_NAME | Kundgruppens visningsnamn. Om gruppnamnet ändras under faktureringsperioden används det senaste namnet. |
CUSTOMER, USER |
Avstämning, Point-i-Time |
Valfritt |
|
CUSTOMER_ORG_ID |
Intern unik identifierare för kunden |
CUSTOMER, USER |
Avstämning, Point-i-Time |
Obligatorisk |
|
CUSTOMER_EXTERNAL_ID |
Kundens unika identifierare som tillhandahålls av en partner |
CUSTOMER, USER |
Avstämning, Point-i-Time |
Obligatorisk |
|
TYPE |
Typ av användare eller arbetsyta |
CUSTOMER, USER |
Punkt i tid |
Obligatorisk |
|
SUBSCRIBER_ID |
Unik identifierare för abonnenten |
USER |
Avstämning, Point-i-Time |
Obligatorisk |
|
USER_ID |
Abonnentens Webex-användar-ID |
USER |
Avstämning, Point-i-Time |
Obligatorisk |
|
WORKSPACE_ID |
Unik arbetsyteidentifierare |
USER |
Avstämning, Point-i-Time |
Obligatorisk |
|
SERVICE_NAME |
Tjänstens namn (t.ex.COMMON_AREA_CALLING,WEBEX_CALLING,WEBEX_SUITE,WEBEX_MEETINGS) |
PARTNER, CUSTOMER, USER |
Avstämning, Point-i-Time |
Obligatorisk |
|
SKU |
Sku för tjänsten |
PARTNER, CUSTOMER, USER |
Avstämning, Point-i-Time |
Obligatorisk |
|
DESCRIPTION |
Beskrivning av tjänsten |
PARTNER, CUSTOMER, USER |
Avstämning, Point-i-Time |
Obligatorisk |
|
CONSUMPTION_START_DATE |
Start av tjänstekonsumtionen. Tillsammans med följande fält definierar detta värde användningsperioden. |
PARTNER, CUSTOMER, USER |
Försoning |
Obligatorisk |
|
CONSUMPTION_END_DATE |
Slutet på tjänsteförbrukningen. Tillsammans med föregående fält definierar detta värde användningsförbrukningsperioden. |
PARTNER, CUSTOMER, USER |
Försoning |
Obligatorisk |
|
REPORT_DATE |
Datum och tid då rapporten genereras. |
CUSTOMER, USER |
Punkt i tid |
Obligatorisk |
|
QUANTITY |
Representerar den aggregerade användarförbrukningen per partner, per kund eller per användare (beroende på rapporten och nivån där du visar data). Beräkning: Systemet beräknar mängden per dag för varje användare på en proportionell basis för den dagen. Användning för en hel dag = 1 Användning för en halv dag = 0,5 Sedan summerar den summan per dag för alla dagar inom faktureringsperioden för att beräkna den totala kvantiteten för den användaren inom den faktureringsperioden. För rapporter på kund- och partnernivå aggregeras summan för alla användare för att ge en total kvantitet för den kunden eller partnern. Point-In-Time: Kundrapporten visar paketallokeringar per kund. Varje rad representerar den totala mängden av ett specifikt paket som tilldelats användare eller arbetsytor inom en viss kundorganisation. Kvantiteten visar ”0” om det inte finns några paket tilldelade. Användarrapporten visar de paket som tilldelats användare eller arbetsytor. Varje rad visar en kvantitet på 1, som representerar en användare eller arbetsyta och deras individuella paket eller tillägg. Om flera paket eller tillägg tilldelas en användare eller arbetsyta, då visar rapporten flera poster, var och en med en kvantitet på 1. |
PARTNER, CUSTOMER, USER |
Avstämning, Point-i-Time |
Obligatorisk |
|
LOCATION_ID |
Unik platsidentifierare |
CUSTOMER, USER |
Avstämning, Point-i-Time Kundens punkt-i-tid-rapport innehåller inte plats-ID |
Valfritt |
|
LICENSE_ID |
Licensidentifierare Det här fältet är endast synligt för grossistpaket För Avstämningsrapport License_ID är det tomt för licenser som tilldelats före införandet av det här fältet. Faktureringsrapporten visar flera rader för samma grossistpaket om det är associerat med olika kombinationer av LOCATION_ID ochLICENSE_ID. |
CUSTOMER, USER |
Avstämning, Point-i-Time |
Valfritt |
Om du väljer valfria kolumner ändras kolumnordningen för rapporter om kund- och användaravstämning. Följande ordning gäller för partners med endast grossist-SKU:er i sin prenumeration:
Användarnivårapport—PARTNER_NAME,PARTNER_ORG_ID,,SUBSCRIPTION_ID,CUSTOMER_GROUP_ID,CUSTOMER_GROUP_NAME,CUSTOMER_ORG_ID,CUSTOMER_EXTERNAL_ID,LOCATION_ID,LICENSE_ID,SUBSCRIBER_ID,USER_ID, SKU WORKSPACE_IDSERVICE_NAME, BESKRIVNING,, CONSUMPTION_START_DATECONSUMPTION_END_DATE, KVANTITET
Kundnivårapport—PARTNER_NAME,,PARTNER_ORG_ID,SUBSCRIPTION_ID,CUSTOMER_GROUP_ID,CUSTOMER_GROUP_NAME,CUSTOMER_ORG_ID,CUSTOMER_EXTERNAL_ID,LOCATION_ID, SKU LICENSE_IDSERVICE_NAME, BESKRIVNING,, CONSUMPTION_START_DATECONSUMPTION_END_DATE, KVANTITET
Att tillhandahålla ett paket till en användare utlöser Webex grossistfakturering, medan borttagning av pakettilldelningen stoppar det.
En kundorganisation kan tillhöra endast en kundgrupp vid varje given tidpunkt. Stöd för flera kundgrupper per organisation är för närvarande inte tillgängligt.