Factureringsrapporten
Partners kunnen de volgende API's voor groothandelsfacturering gebruiken om de factureringsrapporten te genereren die hen helpen het gebruik en de nauwkeurigheid van de levering te valideren. De API's voor groothandelsfacturering zijn toegankelijk via developer.webex.com.
-
Reconciliatie — Toont het verbruik per partner, per klant of per gebruiker. Partners kunnen deze aangepaste factuurgegevens gebruiken om hun maandelijkse factuur op elkaar af te stemmen, zodat ze hun klanten en gebruikers kunnen factureren op basis van hun verbruik.
-
Point-In-Time — Toont de huidige pakkettoewijzingen per klant of per gebruiker. Het Point-In-Time-rapport geeft een realtime telling van de pakkettoewijzingen. Partners kunnen deze informatie gebruiken om de nauwkeurigheid van de levering te valideren en ervoor te zorgen dat ze worden afgestemd op de bestellingen van klanten.
Partners kunnen ook aangepaste factureringsrapporten genereren voor subpartners met behulp van de parameter subpartnerOrgID.
Er zijn vier API's beschikbaar voor partnerbeheerders die voldoen aan de minimale toegangsvereisten.
|
API voor facturering |
Doel van de API |
Vereiste toegang tot de beheerder van de partner |
|---|---|---|
|
Maak een factureringsrapport voor de groothandel |
Wordt gebruikt om een factureringsrapport te genereren. |
Lezen/schrijven |
|
Een rapport over de facturering voor de groothandel aanvragen |
Wordt gebruikt om een gegenereerd factureringsrapport op te halen om te downloaden. |
Lezen |
|
Lijst van factureringsrapporten voor de groothandel |
Wordt gebruikt om de factureringsrapporten op te sommen die voor die partner bestaan. |
Lezen |
|
Een rapport over groothandelsfacturering verwijderen |
Wordt gebruikt om een bestaand factureringsrapport te verwijderen. |
Lezen/schrijven |
Gegevensbron
De gegevens voor de factureringsrapporten zijn afkomstig van pakkettoewijzingen en gebruiksgegevens die Webex voor elke partner bijhoudt. Webex verzamelt de gegevens van klanten en gebruikerspakketten dagelijks om de maandelijkse factuur van de partner te genereren. De API's voor facturering gebruiken deze gegevens, zodat partnerbeheerders aangepaste rapporten kunnen genereren. Deze rapporten helpen partners om het verbruik te vergelijken met hun maandelijkse factuur op partner-, klant- en gebruikersniveau.
Zie Facturering van serviceproviders voor meer gedetailleerde informatie over de manier waarop Webex partners factureert.
Maak een factureringsrapport voor de groothandel
| 1 |
Ga op developer.webex.com naar Create a Wholesale Billing Report API. |
| 2 |
Selecteer een van de volgende rapportcategorieën:
Als u een afstemmingsrapport wilt genereren, hoeft u niets te wijzigen omdat Reconciliatie standaard is geselecteerd, zodat u naar de volgende stap kunt gaan. Als u een Point-In-Time-rapport wilt genereren, wijzigt u de selectie naar Point-In-Time. |
| 3 |
Voer de BillingStartDate en BillingEndDate in het formaat in dat de API specificeert. U kunt elke datum van de afgelopen vijf jaar invoeren, maar niet de huidige dag. Voor het Point-In-Time-rapport zijn de velden BillingStartDate en BillingEndDate niet vereist en worden ze genegeerd als ze worden ingevoerd. Het rapport geeft altijd de huidige pakkettoewijzingen weer. |
| 4 |
Voer het soort rapport in:
|
| 5 |
Voer in het veld Inclusief de aanvullende of optionele kolommen in die u in de rapporten wilt zien. Elk rapporttype heeft een reeks verplichte kenmerken en een reeks optionele kenmerken. U kunt beslissen welke van de optionele kenmerken u voor elk rapport wilt weergeven. Als u de optionele kenmerken niet opgeeft, worden in het rapport alleen de verplichte kenmerken weergegeven. De volgende kolommen zijn de optionele kenmerken die u kunt aanvragen om op te nemen in het rapport Klanten en Gebruikers:
Als u deze kenmerken in uw rapport wilt zien, moet u ze CUSTOMER_GROUP_NAME samen opnemenCUSTOMER_GROUP_ID. Wanneer u optionele kolommen selecteert, verandert de volgorde van de kolommen in de rapporten Klanten- en Gebruikersafstemming. Partners moeten hun API-integratie updaten om het nieuwe csv-formaat te accepteren. De kolomvolgorde van Point-In-Time-rapporten blijft ongewijzigd. Momenteel hebben de bestaande functie-instellingen voorrang op de parameter Include bij het bepalen van de kolomvolgorde. Als een bepaalde functie-instelling bijvoorbeeld is ingeschakeld voor een klant, dan verschijnt die functiekolom volgens het oude rapportformaat, zelfs als u ze toevoegt in de parameter Include. We zullen deze instellingen binnenkort verwijderen. Zodra ze zijn verwijderd, kunt u de optionele kolommen alleen opvragen via de parameter Include. |
| 6 |
Klik op Uitvoeren om het rapport te genereren. |
| 7 |
Kopieer de rapport-id van de API-uitvoer. U kunt deze waarde gebruiken met de Get API om het gegenereerde factureringsrapport op te halen. |
Wat nu te doen
Ga naar de sectie Een rapport voor groothandelsfacturering aanvragen om een exemplaar van het rapport te downloaden.
Een rapport over de facturering voor de groothandel aanvragen
Zodra een factureringsrapport is gegenereerd, kunt u deze API gebruiken om een specifiek factureringsrapport te verkrijgen. Het rapport wordt uitgevoerd naar een URL waar het gedurende 30 minuten na de voltooiing van de GET-aanvraag kan worden gedownload.
| 1 |
Ga op developer.webex.com naar Get a Wholesale Billing Report API. |
| 2 |
Voer de unieke ID-waarde voor het rapport in en klik op Uitvoeren. De API geeft de status van het rapport weer. De uitvoer bevat de parameter TempDownloadURL, die een URL bevat van waaruit u het rapport kunt downloaden. |
| 3 |
Kopieer de TempDownloadURL naar een browser om het rapport te openen en te downloaden. |
Lijst van factureringsrapporten voor de groothandel
Gebruik deze API om een lijst op te vragen van de gegenereerde factureringsrapporten voor de partnerorganisatie. U kunt een lijst maken van alle bestaande rapporten, of de lijst beperken tot die rapporten die voldoen aan de gespecificeerde parameters, zoals uw factureringsperiode en factureringstype (partner, klant, gebruiker).
Als u optionele parameters invoert, retourneert de API alleen die rapporten die exact overeenkomen met de parameters die u opgeeft. Als u bijvoorbeeld een factureringsperiode opgeeft, worden alleen rapporten geretourneerd waarin die specifieke factureringsperiode wordt gebruikt. Rapporten die binnen de periode vallen, maar die niet exact overeenkomen met de datums, worden niet teruggestuurd.
| 1 |
Ga op developer.webex.com naar List Wholesale Billing Report API. |
| 2 |
Voer onder Query-parameters alle zoekparameters in die u wilt gebruiken (bijvoorbeeld de StartDate, EndDate, Type, SortBy on). |
| 3 |
Klik op Uitvoeren. De API geeft de lijst met rapporten weer, samen met de unieke rapport-id en -status (VOLTOOID,IN_PROGRESS).
|
Wat nu te doen
Noteer het identiteitsbewijs voor alle rapporten die u wilt downloaden. Ga naar Een rapport voor groothandelsfacturering aanvragen om het rapport te downloaden.
Een rapport over groothandelsfacturering verwijderen
Gebruik deze procedure om een gegenereerd factureringsrapport te verwijderen op basis van de rapport-id. Enkele voorbeelden waarbij u misschien een rapport wilt verwijderen, zijn onder andere:
-
Als u een bestaand factureringsrapport opnieuw wilt genereren, moet u eerst het bestaande rapport verwijderen. Nadat u het bestaande rapport hebt verwijderd, kunt u een nieuw rapport aanmaken voor die periode. U kunt een rapport niet verwijderen als het genereren ervan is mislukt of nog bezig is.
Voor een Point-In-Time-rapport hoeft u geen bestaand rapport te verwijderen, aangezien het systeem deze rapporten niet opnieuw genereert. Elk rapport geeft altijd de gegevens weer op basis van het huidige tijdstempel.
-
Als u een gegenereerde rapport-URL naar de verkeerde persoon stuurt, kunt u het rapport verwijderen zodat ze er geen toegang toe hebben.
| 1 |
Ga op developer.webex.com naar Delete Wholesale Billing Report API. |
| 2 |
Voer de rapport-id in en klik op Uitvoeren. |
Velden voor het factureringsrapport
Factureringsrapporten bevatten de volgende velden:
|
Veld |
Beschrijving |
Ondersteunde rapportsoort |
Ondersteunde rapportcategorie |
Verplicht of optioneel kenmerk |
|---|---|---|---|---|
|
PARTNER_NAME |
Naam van de partner |
PARTNER, CUSTOMER, USER |
Reconciliatie, op het juiste moment |
Verplicht |
|
PARTNER_ORG_ID |
Unieke identificatiecode van de partner |
PARTNER, CUSTOMER, USER |
Reconciliatie, op het juiste moment |
Verplicht |
|
SUBSCRIPTION_ID |
Unieke abonnementsidentificatie |
PARTNER, CUSTOMER, USER |
Reconciliatie, op het juiste moment |
Verplicht |
|
CUSTOMER_GROUP_ID | De unieke identificatiecode van de groep waartoe de klant behoort. Als de klant tijdens de factureringsperiode naar een andere groep wordt verplaatst, wordt het gebruik opgesplitst op basis van de groepen waartoe de klant in die periode behoorde. |
CUSTOMER, USER |
Reconciliatie, op het juiste moment |
Optioneel |
|
CUSTOMER_GROUP_NAME | Displaynaam van de klantengroep. Als de groepsnaam tijdens de factureringsperiode is gewijzigd, wordt de laatste naam gebruikt. |
CUSTOMER, USER |
Reconciliatie, op het juiste moment |
Optioneel |
|
CUSTOMER_ORG_ID |
Unieke identificatiecode voor interne klanten |
CUSTOMER, USER |
Reconciliatie, op het juiste moment |
Verplicht |
|
CUSTOMER_EXTERNAL_ID |
Unieke identificatiecode van de klant, verstrekt door een partner |
CUSTOMER, USER |
Reconciliatie, op het juiste moment |
Verplicht |
|
TYPE |
Soort gebruiker of werkruimte |
CUSTOMER, USER |
Punt op tijd |
Verplicht |
|
SUBSCRIBER_ID |
Unieke identificatiecode voor de abonnee |
USER |
Reconciliatie, op het juiste moment |
Verplicht |
|
USER_ID |
De Webex-gebruikersnaam van de abonnee |
USER |
Reconciliatie, op het juiste moment |
Verplicht |
|
WORKSPACE_ID |
Unieke identificatie van de werkruimte |
USER |
Reconciliatie, op het juiste moment |
Verplicht |
|
SERVICE_NAME |
Naam van de dienst (bijvoorbeeldCOMMON_AREA_CALLING, WEBEX_CALLINGWEBEX_SUITE,WEBEX_MEETINGS) |
PARTNER, CUSTOMER, USER |
Reconciliatie, op het juiste moment |
Verplicht |
|
SKU |
SKU voor de service |
PARTNER, CUSTOMER, USER |
Reconciliatie, op het juiste moment |
Verplicht |
|
DESCRIPTION |
Beschrijving van de dienst |
PARTNER, CUSTOMER, USER |
Reconciliatie, op het juiste moment |
Verplicht |
|
CONSUMPTION_START_DATE |
Begin van het serviceverbruik. Samen met het volgende veld bepaalt deze waarde de gebruiksperiode. |
PARTNER, CUSTOMER, USER |
Verzoening |
Verplicht |
|
CONSUMPTION_END_DATE |
Einde van het serviceverbruik. Samen met het voorgaande veld bepaalt deze waarde de gebruiksperiode van het verbruik. |
PARTNER, CUSTOMER, USER |
Verzoening |
Verplicht |
|
REPORT_DATE |
De datum en tijd waarop het rapport is gegenereerd. |
CUSTOMER, USER |
Punt op tijd |
Verplicht |
|
QUANTITY |
Geeft het geaggregeerde verbruik van gebruikers weer per partner, per klant of per gebruiker (afhankelijk van het rapport en het niveau waarop u de gegevens bekijkt). Berekening: Het systeem berekent de hoeveelheid per dag voor elke gebruiker naar rato voor die dag. Gebruik gedurende een hele dag = 1 Gebruik gedurende een halve dag = 0,5 Vervolgens worden de totalen per dag voor alle dagen binnen de factureringsperiode opgeteld om de totale hoeveelheid voor die gebruiker binnen die factureringsperiode te berekenen. Voor rapporten op klant- en partnerniveau worden de totalen voor alle gebruikers samengevoegd tot een totale hoeveelheid voor die klant of partner. Point-In-Time: In het klantenrapport worden de pakkettoewijzingen per klant vermeld. Elke rij vertegenwoordigt de totale hoeveelheid van een specifiek pakket dat is toegewezen aan gebruikers of werkruimten binnen een bepaalde klantorganisatie. De hoeveelheid geeft „0” aan als er geen pakketten zijn toegewezen. Het gebruikersrapport bevat de pakketten die zijn toegewezen aan gebruikers of werkruimten. Elke rij toont een hoeveelheid van 1, wat staat voor een gebruiker of werkruimte en hun individuele pakket of add-on. Als er meerdere pakketten of add-ons zijn toegewezen aan een gebruiker of werkruimte, dan bevat het rapport meerdere items, elk met een aantal van 1. |
PARTNER, CUSTOMER, USER |
Reconciliatie, op het juiste moment |
Verplicht |
|
LOCATION_ID |
Unieke locatie-ID |
CUSTOMER, USER |
Reconciliatie, op het juiste moment Het Point-In-Time-rapport van de klant bevat geen locatie-ID |
Optioneel |
|
LICENSE_ID |
Licentie-ID Dit veld is alleen zichtbaar voor groothandelspakketten Voor het verzoeningsrapport License_ID is dit leeg voor licenties die zijn toegewezen vóór de introductie van dit veld. Het factureringsrapport bevat meerdere rijen voor hetzelfde groothandelspakket als dat gekoppeld is aan verschillende combinaties van LOCATION_ID enLICENSE_ID. |
CUSTOMER, USER |
Reconciliatie, op het juiste moment |
Optioneel |
Als u optionele kolommen selecteert, wordt de kolomvolgorde van de afstemmingsrapporten van klanten en gebruikers gewijzigd. De volgende volgorde is van toepassing op partners met alleen groothandels-SKU's in hun abonnement:
Rapport op gebruikersniveau— PARTNER_NAME PARTNER_ORG_IDSUBSCRIPTION_ID,CUSTOMER_GROUP_ID,CUSTOMER_GROUP_NAME,CUSTOMER_ORG_ID,CUSTOMER_EXTERNAL_ID,LOCATION_ID,LICENSE_ID,SUBSCRIBER_ID,USER_ID, WORKSPACE_IDSERVICE_NAME, SKU, BESCHRIJVING,CONSUMPTION_START_DATE,CONSUMPTION_END_DATE, HOEVEELHEID
Rapport op klantniveau— PARTNER_NAME PARTNER_ORG_IDSUBSCRIPTION_ID,CUSTOMER_GROUP_ID,CUSTOMER_GROUP_NAME,CUSTOMER_ORG_ID,,CUSTOMER_EXTERNAL_ID,LOCATION_ID, LICENSE_IDSERVICE_NAME, SKU, BESCHRIJVING,CONSUMPTION_START_DATE,CONSUMPTION_END_DATE, HOEVEELHEID
Als u een pakket aan een gebruiker levert, wordt Webex Wholesale-facturering geactiveerd, terwijl het verwijderen van de pakkettoewijzing stopt.
Een klantenorganisatie kan op elk moment tot slechts één klantengroep behoren. Ondersteuning voor meerdere klantengroepen per organisatie is momenteel niet beschikbaar.