Factureringsrapporten
Partners kunnen de volgende API's voor groothandelsfacturering gebruiken om factureringsrapporten te genereren waarmee ze het gebruik en de nauwkeurigheid van de provisioning kunnen controleren. De API's voor groothandelsfacturering zijn toegankelijk via developer.webex.com.
-
Afstemming—Toont het verbruik per partner, per klant of per gebruiker. Partners kunnen deze aangepaste factuurgegevens gebruiken om hun maandelijkse factuur te controleren, zodat ze hun klanten en gebruikers kunnen factureren op basis van hun verbruik.
-
Momentopname—Toont de huidige pakkettoewijzingen per klant of per gebruiker. Het Point-In-Time-rapport geeft een realtime overzicht van de pakkettoewijzingen. Partners kunnen deze informatie gebruiken om de nauwkeurigheid van de levering te controleren en ervoor te zorgen dat deze overeenkomt met de klantbestellingen.
Partners kunnen ook aangepaste factuurrapporten genereren voor subpartners met behulp van de parameter subPartnerOrgId.
Er zijn vier API's beschikbaar voor partnerbeheerders die voldoen aan de minimale toegangseisen.
|
Facturerings-API |
Doel van de API |
Toegangseisen voor partnerbeheerder |
|---|---|---|
|
Maak een factuurrapport voor de groothandel |
Wordt gebruikt om een factuurrapport te genereren. |
Read/write |
|
Ontvang een groothandelsfactuurrapport |
Wordt gebruikt om een gegenereerd factuurrapport te downloaden. |
Lezen |
|
Lijst met groothandelsfactuurrapporten |
Wordt gebruikt om de bestaande factuurrapporten voor die partner weer te geven. |
Lezen |
|
Een groothandelsfactuurrapport verwijderen |
Wordt gebruikt om een bestaand factuurrapport te verwijderen. |
Read/write |
Gegevensbron
De gegevens voor de facturatieverslagen zijn afkomstig van pakkettoewijzingen en gebruiksgegevens die Webex voor elke partner bijhoudt. Webex verzamelt dagelijks de klant- en gebruikerspakketgegevens om de maandelijkse factuur voor de partner te genereren. Facturerings-API's gebruiken deze gegevens, waardoor partnerbeheerders aangepaste rapporten kunnen genereren. Deze rapporten helpen partners het verbruik uit hun maandelijkse factuur af te stemmen op partner-, klant- en gebruikersniveau.
Voor meer gedetailleerde informatie over hoe Webex partners factureert, zie Facturering serviceproviders.
Maak een factuurrapport voor de groothandel
| 1 |
Ga vanafdeveloper.webex.com naar een API voor het maken van een groothandelsfactuurrapport. |
| 2 |
Selecteer een van de volgende rapportcategorieën:
Als u een afstemmingsrapport wilt genereren, hoeft u niets te wijzigen, aangezien afstemming standaard is geselecteerd. U kunt dus doorgaan naar de volgende stap. Als u een momentopname wilt genereren, wijzig dan de selectie naar 'Momentopname'. |
| 3 |
Voer de billingStartDate en billingEndDate in volgens het formaat dat de API voorschrijft. Je kunt elke datum van de afgelopen vijf jaar invoeren, behalve de huidige dag. Voor het Point-In-Time-rapport zijn de velden billingStartDate en billingEndDate niet verplicht en worden ze genegeerd als ze worden ingevuld. Het rapport weerspiegelt altijd de actuele pakkettoewijzingen. |
| 4 |
Voer het type rapport in:
|
| 5 |
Voer in het veld Inclusief de extra of optionele kolommen in die u in de rapporten wilt zien. Elk rapporttype heeft een set verplichte kenmerken en een set optionele kenmerken. U kunt zelf bepalen welke van de optionele kenmerken u voor elk rapport wilt weergeven. Als u de optionele kenmerken niet opneemt, worden in het rapport alleen de verplichte kenmerken weergegeven. De volgende kolommen bevatten de optionele kenmerken die u kunt aanvragen om in het klant- en gebruikersrapport op te nemen:
U moet CUSTOMER_GROUP_ID en CUSTOMER_GROUP_NAME samen opnemen als u deze kenmerken in uw rapport wilt zien. Wanneer u optionele kolommen selecteert, verandert de kolomvolgorde in de klant- en gebruikersafstemmingsrapporten. Partners moeten hun API-integratie bijwerken 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 'Inclusief' bij het bepalen van de kolomvolgorde. Als bijvoorbeeld een bepaalde functie-instelling voor een klant is ingeschakeld, wordt die functiekolom weergegeven volgens de oude rapportindeling, zelfs als u deze toevoegt in de parameter 'Inclusief'. We zullen deze instellingen binnenkort verwijderen. Nadat ze zijn verwijderd, kunt u de optionele kolommen alleen nog opvragen via de parameter Include. |
| 6 |
Klik op Uitvoeren om het rapport te genereren. |
| 7 |
Kopieer het rapport id uit de API-output. Je kunt deze waarde gebruiken met de Get API om het gegenereerde factuurrapport op te vragen. |
De volgende stappen
Ga naar de sectie Een groothandelsfactuurrapport ophalen om een kopie van het rapport te downloaden.
Ontvang een factuurrapport voor de groothandel
Zodra een factuurrapport is gegenereerd, kunt u deze API gebruiken om een specifiek factuurrapport op te vragen. Het rapport wordt naar een URL gestuurd waar het gedurende 30 minuten na voltooiing van het GET-verzoek kan worden gedownload.
| 1 |
Ga vanafdeveloper.webex.com naar de API voor het verkrijgen van een groothandelsfactuurrapport. |
| 2 |
Voer de unieke id waarde voor het rapport in en klik op Uitvoeren. De API geeft de rapportstatus weer. De uitvoer bevat de parameter tempDownloadURL, die een URL bevat waarmee u het rapport kunt downloaden. |
| 3 |
Kopieer de tempDownloadURL in een browser om het rapport te openen en te downloaden. |
Lijst met groothandelsfactuurrapporten
Gebruik deze API om een lijst te verkrijgen van gegenereerde factuurrapporten voor de partnerorganisatie. U kunt alle bestaande rapporten weergeven of de lijst beperken tot rapporten die voldoen aan de opgegeven parameters, zoals uw factureringsperiode en factureringstype (partner, klant, gebruiker).
Als u optionele parameters invoert, retourneert de API alleen de rapporten die exact overeenkomen met de parameters die u opgeeft. Als u bijvoorbeeld een factureringsperiode opgeeft, worden alleen rapporten weergegeven die betrekking hebben op die specifieke factureringsperiode. Rapporten die binnen de aangegeven periode vallen, maar waarvan de datums niet exact overeenkomen, worden niet geretourneerd.
| 1 |
Ga vanafdeveloper.webex.com naar de API voor groothandelsfactureringsrapporten. |
| 2 |
Voer onder Query Parametersde zoekparameters in die u wilt gebruiken (bijvoorbeeld 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_BEHANDELING ).
|
De volgende stappen
Noteer de id voor alle rapporten die u wilt downloaden. Ga naar Een groothandelsfactuurrapport ophalen om het rapport te downloaden.
Een factuurrapport voor de groothandel verwijderen
Gebruik deze procedure om een gegenereerd factuurrapport te verwijderen op basis van het rapport-ID. Enkele voorbeelden van situaties waarin u een rapport mogelijk wilt verwijderen zijn:
-
Als u een bestaand afstemmingsrapport opnieuw wilt genereren, moet u het bestaande rapport eerst verwijderen. Nadat je het bestaande rapport hebt verwijderd, kun je een nieuw rapport voor die periode aanmaken. Je kunt een rapport niet verwijderen als het genereren ervan is mislukt of nog bezig is.
Voor een momentopnamerapport hoeft u een bestaand rapport niet te verwijderen, aangezien het systeem deze rapporten niet opnieuw genereert. Elk rapport geeft altijd de gegevens weer zoals die op het huidige tijdstempel beschikbaar zijn.
-
Als je een URL van een gegenereerd rapport naar de verkeerde persoon stuurt, kun je het rapport verwijderen zodat die persoon er geen toegang meer toe heeft.
| 1 |
Ga vanafdeveloper.webex.com naar Delete Wholesale Billing Report API. |
| 2 |
Voerde rapport - ID in en klik op Uitvoeren . |
Factureringsrapportvelden
Factureringsrapporten bevatten de volgende velden:
|
Veld |
Beschrijving |
Ondersteunde rapporttypen |
Ondersteunde rapportcategorie |
Verplicht of optioneel kenmerk |
|---|---|---|---|---|
|
PARTNER_NAAM |
Naam van de partner |
PARTNER, KLANT, GEBRUIKER |
Verzoening, op een bepaald moment |
Verplicht |
|
PARTNER_ORG_ID |
Unieke partneridentificatie |
PARTNER, KLANT, GEBRUIKER |
Verzoening, op een bepaald moment |
Verplicht |
|
ABONNEMENT_ID |
Unieke abonnementsidentificatie |
PARTNER, KLANT, GEBRUIKER |
Verzoening, op een bepaald moment |
Verplicht |
|
KLANT_GROEP_ID | De unieke identificatiecode van de groep waartoe de klant behoort. Als een klant tijdens de factureringsperiode tussen groepen wordt verplaatst, wordt het verbruik verdeeld op basis van de groepen waartoe de klant in die periode behoorde. |
KLANT, GEBRUIKER |
Verzoening, op een bepaald moment |
Optioneel |
|
KLANT_GROEP_NAAM | Weergavenaam van de klantengroep. Als de groepsnaam tijdens de factureringsperiode is gewijzigd, wordt de meest recente naam gebruikt. |
KLANT, GEBRUIKER |
Verzoening, op een bepaald moment |
Optioneel |
|
KLANT_ORG_ID |
Unieke interne klantidentificatiecode |
KLANT, GEBRUIKER |
Verzoening, op een bepaald moment |
Verplicht |
|
KLANT_EXTERNE_ID |
Unieke klantidentificatiecode zoals verstrekt door een partner |
KLANT, GEBRUIKER |
Verzoening, op een bepaald moment |
Verplicht |
|
Type |
Gebruikers- of werkruimtetype |
KLANT, GEBRUIKER |
Tijdstip |
Verplicht |
|
ABONNEE_ID |
Unieke identificatiecode voor de abonnee |
GEBRUIKER |
Verzoening, op een bepaald moment |
Verplicht |
|
GEBRUIKERS-ID_ |
De Webex-gebruikers-ID van de abonnee |
GEBRUIKER |
Verzoening, op een bepaald moment |
Verplicht |
|
WERKRUIMTE_ID |
Unieke werkplek-identificatie |
GEBRUIKER |
Verzoening, op een bepaald moment |
Verplicht |
|
SERVICE_NAAM |
Naam van de dienst (bijv. COMMON_AREA_CALLING, WEBEX_CALLING, WEBEX_SUITE, WEBEX_MEETINGS) |
PARTNER, KLANT, GEBRUIKER |
Verzoening, op een bepaald moment |
Verplicht |
|
SKU |
SKU voor de service |
PARTNER, KLANT, GEBRUIKER |
Verzoening, op een bepaald moment |
Verplicht |
|
BESCHRIJVING |
Beschrijving van de dienst |
PARTNER, KLANT, GEBRUIKER |
Verzoening, op een bepaald moment |
Verplicht |
|
VERBRUIK_START_DATUM |
Start van het gebruik van de dienst. Samen met het volgende veld definieert deze waarde de gebruiksperiode. |
PARTNER, KLANT, GEBRUIKER |
Afstemming |
Verplicht |
|
VERBRUIK_EINDE_DATUM |
Einde van het gebruik van de dienst. Samen met het voorgaande veld definieert deze waarde de gebruiksperiode. |
PARTNER, KLANT, GEBRUIKER |
Afstemming |
Verplicht |
|
RAPPORT_DATUM |
De datum en tijd waarop het rapport is gegenereerd. |
KLANT, GEBRUIKER |
Tijdstip |
Verplicht |
|
HOEVEELHEID |
Geeft het totale verbruik per gebruiker 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 dagelijkse hoeveelheid voor elke gebruiker naar rato voor die dag. Gebruik gedurende een hele dag = 1 Gebruik gedurende een halve dag = 0,5 Vervolgens worden de dagelijkse totalen voor alle dagen binnen de factureringsperiode bij elkaar opgeteld om de totale hoeveelheid voor die gebruiker binnen die factureringsperiode te berekenen. Voor rapporten op klant- en partnerniveau worden de totalen van alle gebruikers samengevoegd om een totaalhoeveelheid voor die klant of partner te verkrijgen. Op een bepaald moment: Het klantrapport geeft een overzicht van de pakkettoewijzingen per klant. Elke rij vertegenwoordigt de totale hoeveelheid van een specifiek pakket dat is toegewezen aan gebruikers of werkplekken binnen een bepaalde klantorganisatie. De hoeveelheid geeft "0" weer als er geen pakketten zijn toegewezen. Het gebruikersrapport toont een overzicht van de pakketten die aan gebruikers of werkruimtes zijn toegewezen. Elke rij toont een hoeveelheid van 1, wat staat voor een gebruiker of werkruimte en het bijbehorende pakket of add-on. Als er meerdere pakketten of add-ons aan een gebruiker of werkruimte zijn toegewezen, toont het rapport meerdere vermeldingen, elk met een aantal van 1. |
PARTNER, KLANT, GEBRUIKER |
Verzoening, op een bepaald moment |
Verplicht |
|
LOCATIE_ID |
Unieke locatie-identificatie |
KLANT, GEBRUIKER |
Verzoening, op een bepaald moment Het klantlocatierapport bevat geen locatie-ID. |
Optioneel |
|
LICENTIE_ID |
Licentie-identificatie Dit veld is alleen zichtbaar voor groothandelspakketten. Voor het reconciliatierapport is de License_ID leeg voor licenties die zijn toegekend vóór de introductie van dit veld. Het factureringsrapport toont meerdere rijen voor hetzelfde groothandelspakket als dit is gekoppeld aan verschillende combinaties van LOCATIE_ID en LICENTIE_ID. |
KLANT, GEBRUIKER |
Verzoening, op een bepaald moment |
Optioneel |
Door optionele kolommen te selecteren, wordt de kolomvolgorde van de klant- en gebruikersafstemmingsrapporten gewijzigd. De volgende volgorde is van toepassing op partners met uitsluitend groothandelsproducten in hun abonnement:
_Rapport op gebruikersniveau—PARTNERNAAM_, PARTNERORGANISATIE-ID__, ABONNEMENTS-ID_, KLANTGROEP-ID__, KLANTGROEP-NAAM_, KLANTORGANISATIE-ID_, EXTERNE KLANT-ID__, LOCATIE-ID__, LICENTIE-ID_, ABONNEMENTS-ID [], GEBRUIKER-ID__, WORKSPACE-ID_], SERVICENAAM_, SKU, OMSCHRIJVING, STARTDATUM VERBRUIK__, EINDDATUM VERBRUIK__, HOEVEELHEID
_Rapport op klantniveau—PARTNERNAAM_, PARTNERORGANISATIE-ID__, ABONNEMENTS-ID_, KLANTGROEP-ID__, KLANTGROEP-NAAM_, KLANTORGANISATIE-ID_, EXTERNE KLANT-ID__, LOCATIE-ID__, LICENTIE-ID_, SERVICENAAM_, SKU, OMSCHRIJVING, STARTDATUM VERBRUIK__, EINDDATUM VERBRUIK__, HOEVEELHEID
Het toewijzen van een pakket aan een gebruiker activeert de Webex Wholesale-facturering, terwijl het verwijderen van de pakkettoewijzing deze stopt.
Een klantorganisatie kan op elk gegeven moment slechts tot één klantengroep behoren. Ondersteuning voor meerdere klantgroepen per organisatie is momenteel niet beschikbaar.