Fakturační zprávy
Partneři mohou pomocí následujících rozhraní API pro velkoobchodní fakturaci vygenerovat fakturační přehledy , které jim pomohou ověřit využití a přesnost zřizování. Rozhraní API pro velkoobchodní fakturaci jsou přístupné na developer.webex.com.
-
Sesouhlasení — Zobrazuje spotřebu využití na úrovni partnera, zákazníka nebo uživatele. Partneři mohou použít tyto vlastní informace o fakturačním přehledu k sesouhlasení své měsíční faktury, aby mohli účtovat svým zákazníkům a uživatelům podle jejich spotřeby využití.
-
Point-In-Time — Zobrazuje aktuální alokace balíčků na úrovni zákazníka nebo uživatele. Zpráva Point-In-Time poskytuje počet alokací balíků v reálném čase. Partneři mohou tyto informace použít k ověření přesnosti zřizování a zajištění souladu s objednávkami zákazníků.
Partneři mohou také generovat vlastní fakturační zprávy pro subpartnery pomocí parametru SubpartnerOrgID.
Správci partnerů, kteří splňují minimální požadavky na přístup, jsou k dispozici čtyři rozhraní API.
|
Fakturační API |
Účel API |
Požadavek na přístup administrátora partnera |
|---|---|---|
|
Vytvoření přehledu velkoobchodní fakturace |
Používá se ke generování fakturačního přehledu. |
Čtení/zápis |
|
Získejte zprávu o velkoobchodní fakturaci |
Používá se k získání vygenerovaného fakturačního přehledu ke stažení. |
Číst |
|
Seznam velkoobchodních fakturačních zpráv |
Používá se k výpisu fakturačních přehledů, které existují pro daného partnera. |
Číst |
|
Odstranění přehledu velkoobchodní fakturace |
Používá se k odstranění existujícího fakturačního přehledu. |
Čtení/zápis |
Zdroj dat
Data pro fakturační zprávy jsou získávána z přiřazení balíčků a dat o využití, která Webex sleduje pro každého partnera. Webex denně agreguje data zákaznického a uživatelského balíčku a vygeneruje měsíční fakturu partnera. Tato data používají rozhraní API pro fakturaci a umožňují správcům partnerů generovat vlastní sestavy. Tyto přehledy pomáhají partner ům sladit spotřebu využití s měsíční fakturou na úrovni partnerů, zákazníků a uživatelů.
Podrobnější informace o tom, jak Webex fakturuje partnery, najdete v části Fakturace poskytovatele služeb.
Vytvoření přehledu velkoobchodní fakturace
| 1 |
Na developer.webex.com přejděte na stránku Vytvoření rozhraní API zprávy o velkoobchodní faktur aci. |
| 2 |
Vyberte některou z následujících kategorií sestav:
Pokud chcete vygenerovat sestavu odsouhlasení, není třeba nic měnit, protože ve výchozím nastavení je vybráno Odsouhlasení, takže můžete pokračovat dalším krokem. Pokud chcete vygenerovat sestavu Point-in-Time, změňte výběr na Point-in-Time. |
| 3 |
Zadejte BillingStartDate a BillingEndDate ve formátu, který určuje rozhraní API. Můžete zadat libovolné datum za posledních pět let, ale ne aktuální den. U sestavy Point-In-Time nejsou pole BillingStartDate a BillingEndDate povinná a při zadání jsou ignorována. Zpráva vždy odráží aktuální alokace balíčků. |
| 4 |
Zadejte typ zprávy:
|
| 5 |
Do pole Zahr nout zadejte další nebo volitelné sloupce, které chcete zobrazit v sestavách. Každý typ sestavy má sadu povinných atributů a sadu volitelných atributů. Můžete se rozhodnout, který z volitelných atributů se má zobrazit pro každou sestavu. Pokud nezahrnete volitelné atributy, sestava zobrazí pouze povinné atributy. Následující sloupce jsou volitelné atributy, které můžete požádat o zahrnutí do přehledu Zákazník a Uživatel:
Pokud chcete tyto atributy zobrazit v přehledu, musíte zahr CUSTOMER_GROUP_ID nout a CUSTOMER_GROUP_NAME společně. Když vyberete volitelné sloupce, změní se pořadí sloupců v přehledech Sesouhlasení zákazníků a uživatelů. Partneři musí aktualizovat integraci API, aby přijali nový formát csv. Pořadí sloupců sestav Point-In-Time zůstává nezměněno. V současné době mají stávající nastavení prvku při určování pořadí sloupců přednost před parametrem Zahrnout. Pokud je například pro zákazníka povoleno určité nastavení prvku, zobrazí se tento sloupec prvku podle starého formátu sestavy, i když je přidáte do parametru Zahrnout. Brzy tato nastavení odstraníme. Jakmile jsou odstraněny, můžete požadovat volitelné sloupce pouze pomocí parametru Zahrnout. |
| 6 |
Klepnutím na tlačítko Spustit vygenerujte sestavu. |
| 7 |
Zkopírujte id se stavy z výstupu API. Tuto hodnotu můžete použít s rozhraním Get API k získání vygenerovaného fakturačního přehledu. |
Co dělat dál
Chcete-li stáhnout kopii přehledu, přejděte do části Získat zprávu o velkoobchodní faktur aci.
Získání přehledu velkoobchodní fakturace
Po vygenerování fakturačního přehledu použijte toto rozhraní API k získání konkrétního fakturačního přehledu. Zpráva dostane výstup na adresu URL, kde je k dispozici ke stažení po dobu 30 minut po dokončení požadavku GET.
| 1 |
Na developer.webex.com přejděte na stránku Získat rozhraní API zprávy o velkoobchodní faktur aci. |
| 2 |
Zadejte jedinečnou hodnotu ID sestavy a klikněte na tlačítko Sp ustit. Výstupy API vykazují stav. Výstup obsahuje parametr tempDownloadURL, který poskytuje adresu URL, ze které si můžete sestavu stáhnout. |
| 3 |
Zkopírujte adresu TempDownloadURL do prohlížeče a otevřete zprávu a stá hněte ji. |
Seznam velkoobchodních fakturačních přehledů
Pomocí tohoto rozhraní API získáte seznam vygenerovaných fakturačních přehledů pro partnerskou organizaci. Můžete zobrazit seznam všech existujících sestav nebo omezit seznam na ty sestavy, které splňují zadané parametry, jako je fakturační období a typ fakturace (partner, zákazník, uživatel).
Pokud zadáte volitelné parametry, API vrátí pouze ty sestavy, které přesně odpovídají zadaným parametrům. Pokud například zadáte fakturační období, budou vráceny pouze sestavy, které používají toto konkrétní fakturační období. Zprávy, které spadají do daného období, ale které přesně neodpovídají datům, se nevrátí.
| 1 |
Na developer.webex.com přejděte na seznam rozhraní API zprávy o velkoobchodní fakturaci. |
| 2 |
V části Parametry dotazu zadejte všechny parametry vyhledávání, které chcete použít (například počáteční datum, datum ukončení, typ, řazení podle zapnuto). |
| 3 |
Klepněte na tlačítko Spustit. API vypíše seznam sestav spolu s jedinečným id a stavem sestavy (DOKONČENO,IN_PROGRESS).
|
Co dělat dál
Zaznamenejte ID všech sestav, které chcete stáhnout. Chcete-li stáhnout přehled o velkoobchodní fakturaci, přejděte na stránku Získat zprávu o velkoobchodní fakturaci.
Odstranění přehledu velkoobchodní fakturace
Tento postup slouží k odstranění vygenerovaného fakturačního přehledu založeného na ID sestavy. Několik příkladů, kdy můžete chtít zprávu odstranit, patří:
-
Pokud chcete obnovit stávající sestavu fakturace odsouhlasení, musíte nejprve odstranit stávající sestavu. Po odstranění existujícího přehledu můžete vytvořit novou sestavu pro dané období. Nelze odstranit sestavu, pokud se její generování nezdařilo nebo stále probíhá.
U sestavy Point-In-Time nemusíte odstraňovat existující sestavu, protože systém tyto sestavy neregeneruje. Každá zpráva vždy odráží data od aktuálního časového razítka.
-
Pokud odešlete generovanou adresu URL sestavy nesprávné osobě, můžete zprávu smazat, aby k němu neměla přístup.
| 1 |
Na developer.webex.com přejděte na Odstranit rozhraní API zprávy o velkoobchodní faktur aci. |
| 2 |
Zadejte ID sestavy a klepněte na tlačítko Spustit. |
Pole fakturačního přehledu
Fakturační přehledy obsahují následující pole:
|
Pole |
Popis |
Podporovaný typ zprávy |
Podporovaná kategorie zpráv |
Povinný nebo Volitelný atribut |
|---|---|---|---|---|
|
PARTNER_NAME |
Jméno partnera |
PARTNER, CUSTOMER, USER |
Sesouhlasení, bod v čase |
Povinné |
|
PARTNER_ORG_ID |
Jedinečný identifikátor partnera |
PARTNER, CUSTOMER, USER |
Sesouhlasení, bod v čase |
Povinné |
|
SUBSCRIPTION_ID |
Jedinečný identifikátor předplatného |
PARTNER, CUSTOMER, USER |
Sesouhlasení, bod v čase |
Povinné |
|
CUSTOMER_GROUP_ID | Jedinečný identifikátor skupiny, do které zákazník patří. Pokud je zákazník během fakturačního období přesunut mezi skupinami, využití je rozděleno na základě skupin, do kterých zákazník během daného období patřil. |
CUSTOMER, USER |
Sesouhlasení, bod v čase |
Volitelné |
|
CUSTOMER_GROUP_NAME | Zobrazovaný název skupiny zákazníků. Pokud se název skupiny během fakturačního období změnil, použije se nejnovější název. |
CUSTOMER, USER |
Sesouhlasení, bod v čase |
Volitelné |
|
CUSTOMER_ORG_ID |
Interní jedinečný identifikátor zákazníka |
CUSTOMER, USER |
Sesouhlasení, bod v čase |
Povinné |
|
CUSTOMER_EXTERNAL_ID |
Jedinečný identifikátor zákazníka poskytnutý partnerem |
CUSTOMER, USER |
Sesouhlasení, bod v čase |
Povinné |
|
TYPE |
Typ uživatele nebo pracovního prostoru |
CUSTOMER, USER |
Bod v čase |
Povinné |
|
SUBSCRIBER_ID |
Jedinečný identifikátor účastníka |
USER |
Sesouhlasení, bod v čase |
Povinné |
|
USER_ID |
Uživatelské ID Webex předplatitele |
USER |
Sesouhlasení, bod v čase |
Povinné |
|
WORKSPACE_ID |
Jedinečný identifikátor pracovního prostoru |
USER |
Sesouhlasení, bod v čase |
Povinné |
|
SERVICE_NAME |
Název služby (např.,COMMON_AREA_CALLING,WEBEX_CALLING,WEBEX_SUITE,WEBEX_MEETINGS) |
PARTNER, CUSTOMER, USER |
Sesouhlasení, bod v čase |
Povinné |
|
SKU |
Sku pro službu |
PARTNER, CUSTOMER, USER |
Sesouhlasení, bod v čase |
Povinné |
|
DESCRIPTION |
Popis služby |
PARTNER, CUSTOMER, USER |
Sesouhlasení, bod v čase |
Povinné |
|
CONSUMPTION_START_DATE |
Začátek spotřeby služby. Spolu s následujícím polem tato hodnota definuje dobu použití. |
PARTNER, CUSTOMER, USER |
Usmíření |
Povinné |
|
CONSUMPTION_END_DATE |
Konec spotřeby služby. Spolu s předchozím polem tato hodnota definuje dobu spotřeby využití. |
PARTNER, CUSTOMER, USER |
Usmíření |
Povinné |
|
REPORT_DATE |
Datum a čas, kdy je zpráva vygenerována. |
CUSTOMER, USER |
Bod v čase |
Povinné |
|
QUANTITY |
Představuje souhrnnou spotřebu využití uživatelů na partnera, zákazníka nebo uživatele (v závislosti na přehledu a úrovni, na které data prohlížíte). Výpočet: Systém vypočítá denní množství pro každého uživatele na poměrném základě pro daný den. Využití na celý den = 1 Využití za půl dne = 0,5 Poté sečte součty za den za všechny dny ve fakturačním období a vypočítá celkové množství pro daného uživatele v daném fakturačním období. U přehledů na úrovni zákazníků a partnerů jsou součty pro všechny uživatele agregovány, aby bylo poskytnuto celkové množství pro daného zákazníka nebo partnera. Point-In-Time: V přehledu zákazníka jsou uvedeny alokace balíků na zákazníka. Každý řádek představuje celkové množství konkrétního balíčku přiřazeného uživatelům nebo pracovním prostorům v rámci konkrétní organizace zákazníka. V položce Množství se zobrazí „0“, pokud nejsou přiděleny žádné balíčky. V přehledu uživatele jsou uvedeny balíčky přiřazené uživatelům nebo pracovním prostorům. Každý řádek zobrazuje množství 1, což představuje uživatele nebo pracovní prostor a jejich individuální balíček nebo doplněk. Pokud je uživateli nebo pracovnímu prostoru přiděleno více balíčků nebo doplňků, pak sestava zobrazí více položek, každý s množstvím 1. |
PARTNER, CUSTOMER, USER |
Sesouhlasení, bod v čase |
Povinné |
|
LOCATION_ID |
Jedinečný identifikátor polohy |
CUSTOMER, USER |
Sesouhlasení, bod v čase Přehled zákaznického bodu v čase neobsahuje ID polohy |
Volitelné |
|
LICENSE_ID |
Identifikátor licence Toto pole je viditelné pouze pro velkoobchodní balíčky U zprávy o odsouhlasení License_ID je prázdné pro licence přiřazené před zavedením tohoto pole. Fakturační přehled zobrazuje více řádků pro stejný velkoobchodní balíček, pokud je přidružen k různým kombinacím LOCATION_ID aLICENSE_ID. |
CUSTOMER, USER |
Sesouhlasení, bod v čase |
Volitelné |
Výběrem volitelných sloupců se změní pořadí sloupců sestav Odsouhlasení zákazníků a uživatelů. Následující objednávka se vztahuje na partnery, kteří mají v předplatném pouze velkoobchodní SKU:
Zpráva na úrovni uživatele— PARTNER_NAMEPARTNER_ORG_ID,SUBSCRIPTION_ID,CUSTOMER_GROUP_ID,CUSTOMER_GROUP_NAME,CUSTOMER_ORG_ID,CUSTOMER_EXTERNAL_ID,LOCATION_ID,,LICENSE_ID,SUBSCRIBER_ID, USER_IDWORKSPACE_ID, SKUSERVICE_NAME, DESCRIPTION, CONSUMPTION_START_DATECONSUMPTION_END_DATE, QUANTITY
Zpráva na úrovni zákazníka— PARTNER_NAMEPARTNER_ORG_ID,SUBSCRIPTION_ID,CUSTOMER_GROUP_ID,CUSTOMER_GROUP_NAME,CUSTOMER_ORG_ID,CUSTOMER_EXTERNAL_ID,LOCATION_ID,LICENSE_ID,SERVICE_NAME, SKU, POPIS,CONSUMPTION_START_DATE,CONSUMPTION_END_DATE, MNOŽSTVÍ
Zřízení balíčku uživateli spustí velkoobchodní fakturaci Webex, zatímco odebrání přiřazení balíčku jej zastaví.
Zákaznická organizace může v daném okamžiku patřit pouze do jedné skupiny zákazníků. Podpora pro více skupin zákazníků na organizaci není momentálně k dispozici.