Informes de facturación
Los socios pueden usar las siguientes API de facturación mayorista para generar los informes de facturación que les ayuden a validar la precisión de uso y aprovisionamiento. Las API de facturación al por mayor son accesibles a través de developer.webex.com.
-
Conciliación: muestra el consumo de uso por socio, por cliente o por usuario. Los socios pueden usar esta información de informe de facturación personalizado para conciliar su factura mensual para que puedan facturar a sus clientes y usuarios de acuerdo con su consumo de uso.
-
Punto a tiempo: muestra las asignaciones actuales de paquetes por cliente o por usuario. El informe puntual proporciona un recuento en tiempo real de las asignaciones de paquetes. Los socios pueden usar esta información para validar la precisión del aprovisionamiento y garantizar la alineación con los pedidos de los clientes.
Los socios también pueden generar informes de facturación personalizados para los subsocios mediante el parámetro SubpartnerOrgID.
Hay cuatro API disponibles para los administradores asociados que cumplan con los requisitos mínimos de acceso.
|
API de facturación |
Propósito de la API |
Requisito de acceso de administrador del socio |
|---|---|---|
|
Crear un informe de facturación al por mayor |
Se utiliza para generar un informe de facturación. |
Lectura/escritura |
|
Obtenga un informe de facturación al por mayor |
Se utiliza para obtener un informe de facturación generado para su descarga. |
Leer |
|
Lista de informes de facturación al por mayor |
Solía enumerar los informes de facturación que existen para ese socio. |
Leer |
|
Eliminar un informe de facturación mayorista |
Se utiliza para eliminar un informe de facturación existente. |
Lectura/escritura |
Origen de datos
Los datos de los informes de facturación se extraen de las asignaciones de paquetes y los datos de uso que Webex rastrea para cada socio. Webex agrega los datos del paquete de clientes y usuarios diariamente para generar la factura mensual del socio. Las API de facturación utilizan estos datos, lo que permite a los administradores asociados generar informes personalizados. Estos informes ayudan a los socios a conciliar el consumo de uso de su factura mensual a nivel de socio, cliente y usuario.
Para obtener información más detallada sobre cómo Webex factura a los socios, consulte Facturación del proveedor de servicios.
Crear un informe de facturación al por mayor
| 1 |
Desde developer.webex.com, vaya a Crear una API de informe de facturación mayorista. |
| 2 |
Seleccione una de las siguientes categorías de informe:
Si desea generar un informe de reconciliación, no es necesario cambiar nada porque la reconciliación está seleccionada de forma predeterminada, por lo que puede continuar con el siguiente paso. Si desea generar un informe puntual, cambie la selección a Punto en el tiempo. |
| 3 |
Introduzca BillingStartDate y BillingEndDate en el formato que especifique la API. Puede ingresar cualquier fecha de los últimos cinco años, pero no el día actual. Para el informe puntual, los campos BillingStartDate y BillingEndDate no son obligatorios y se ignoran si se introducen. El informe siempre refleja las asignaciones de paquetes actuales. |
| 4 |
Introduzca el tipo de informe:
|
| 5 |
En el campo Incluir, escriba las columnas adicionales u opcionales que desea ver en los informes. Cada tipo de informe tiene un conjunto de atributos obligatorios y un conjunto de atributos opcionales. Puede decidir cuál de los atributos opcionales mostrar para cada informe. Si no incluye los atributos opcionales, el informe muestra solo los atributos obligatorios. Las siguientes columnas son los atributos opcionales que puede solicitar incluir en el informe Cliente y Usuario:
Debe incluir CUSTOMER_GROUP_ID y CUSTOMER_GROUP_NAME juntos si quiere ver estos atributos en su informe. Cuando selecciona columnas opcionales, cambia el orden de las columnas en los informes de Reconciliación de clientes y usuarios. Los socios deben actualizar su integración de API para aceptar el nuevo formato csv. El orden de las columnas de los informes puntuales permanece sin cambios. Actualmente, la configuración de característica existente tiene prioridad sobre el parámetro Include al determinar el orden de las columnas. Por ejemplo, si una configuración de característica determinada está habilitada para un cliente, esa columna de características aparecerá según el formato de informe anterior, incluso si las agrega en el parámetro Incluir. Vamos a eliminar esta configuración pronto. Una vez que se quitan, puede solicitar las columnas opcionales solo a través del parámetro Include. |
| 6 |
Haga clic en Ejecutar para generar el informe. |
| 7 |
Copie el ID del informe de la salida de la API. Puede usar este valor con la API Get para obtener el informe de facturación generado. |
Qué hacer a continuación
Vaya a la sección Obtener un informe de facturación mayorista para descargar una copia del informe.
Obtenga un informe de facturación al por mayor
Una vez que se genere un informe de facturación, utilice esta API para obtener un informe de facturación específico. El informe se envía a una URL donde está disponible para su descarga durante 30 minutos después de completar la solicitud GET.
| 1 |
Desde developer.webex.com, vaya a Obtener una API de informe de facturación mayorista. |
| 2 |
Introduzca el valor de identificación único para el informe y haga clic en Ejecutar. La API genera el estado del informe. La salida incluye el parámetro TempDownloadURL, que proporciona una dirección URL desde la que puede descargar el informe. |
| 3 |
Copie el TempDownloadURL en un navegador para acceder y descargar el informe. |
Lista de informes de facturación al por mayor
Utilice esta API para obtener una lista de informes de facturación generados para la organización asociada. Puede enumerar todos los informes existentes o limitar la lista a aquellos informes que cumplan con los parámetros especificados, como su período de facturación y tipo de facturación (socio, cliente, usuario).
Si ingresa parámetros opcionales, la API devuelve sólo los informes que coinciden exactamente con los parámetros que especifique. Por ejemplo, si especifica un período de facturación, solo se devuelven los informes que utilizan ese período de facturación específico. Los informes que se encuentran dentro del período, pero que no coinciden exactamente con las fechas no se devuelven.
| 1 |
Desde developer.webex.com, vaya a Liste Wholesale Billing Report API. |
| 2 |
En Parámetros de consulta, escriba los parámetros de búsqueda que desee utilizar (por ejemplo, StartDate, FindDate, Type, SortBy on). |
| 3 |
Haga clic en Ejecutar. La API genera la lista de informes junto con el identificador y el estado únicos del informe (COMPLETADO,IN_PROGRESS).
|
Qué hacer a continuación
Lleve un registro de la identificación para cualquier informe que quiera descargar. Vaya a Obtener un informe de facturación al por mayor para descargar el informe.
Eliminar un informe de facturación mayorista
Utilice este procedimiento para eliminar un informe de facturación generado basado en el identificador del informe. Algunos ejemplos en los que puede querer eliminar un informe incluyen:
-
Si desea regenerar un informe de facturación de Reconciliación existente, primero debe eliminar el informe existente. Después de eliminar el informe existente, puede crear un nuevo informe para ese período. No puede eliminar un informe si su generación ha fallado o aún está en progreso.
Para un informe puntual, no necesita eliminar un informe existente, ya que el sistema no regenera estos informes. Cada informe siempre refleja datos a partir de la marca de tiempo actual.
-
Si envía una URL de informe generada a la persona equivocada, puede eliminar el informe para que no puedan acceder a él.
| 1 |
Desde developer.webex.com, vaya a Eliminar API del informe de facturación mayorista. |
| 2 |
Introduzca el ID del informe y haga clic en Ejecutar. |
Campos de informe de facturación
Los informes de facturación contienen los siguientes campos:
|
Campo |
Descripción |
Tipo de informe admitido |
Categoría de informe admitida |
Atributo obligatorio u opcional |
|---|---|---|---|---|
|
PARTNER_NAME |
Nombre del socio |
PARTNER, CUSTOMER, USER |
Reconciliación, punto a tiempo |
Obligatorio |
|
PARTNER_ORG_ID |
Identificador único de socio |
PARTNER, CUSTOMER, USER |
Reconciliación, punto a tiempo |
Obligatorio |
|
SUBSCRIPTION_ID |
Identificador de suscripción único |
PARTNER, CUSTOMER, USER |
Reconciliación, punto a tiempo |
Obligatorio |
|
CUSTOMER_GROUP_ID | El identificador único del grupo al que pertenece el cliente. Si el cliente se mueve entre grupos durante el período de facturación, el uso se divide en función de los grupos a los que pertenecía el cliente durante ese período. |
CUSTOMER, USER |
Reconciliación, punto a tiempo |
Opcional |
|
CUSTOMER_GROUP_NAME | Mostrar el nombre del grupo de clientes. Si el nombre del grupo cambió durante el período de facturación, se utilizará el nombre más reciente. |
CUSTOMER, USER |
Reconciliación, punto a tiempo |
Opcional |
|
CUSTOMER_ORG_ID |
Identificador único del cliente interno |
CUSTOMER, USER |
Reconciliación, punto a tiempo |
Obligatorio |
|
CUSTOMER_EXTERNAL_ID |
Identificador único del cliente proporcionado por un socio |
CUSTOMER, USER |
Reconciliación, punto a tiempo |
Obligatorio |
|
TYPE |
Tipo de usuario o espacio de trabajo |
CUSTOMER, USER |
Punto en el tiempo |
Obligatorio |
|
SUBSCRIBER_ID |
Identificador único para el suscriptor |
USER |
Reconciliación, punto a tiempo |
Obligatorio |
|
USER_ID |
El ID de usuario de Webex del suscriptor |
USER |
Reconciliación, punto a tiempo |
Obligatorio |
|
WORKSPACE_ID |
Identificador único del espacio de trabajo |
USER |
Reconciliación, punto a tiempo |
Obligatorio |
|
SERVICE_NAME |
Nombre del servicio (por ejemplo,COMMON_AREA_CALLING,WEBEX_CALLING,WEBEX_SUITE,WEBEX_MEETINGS) |
PARTNER, CUSTOMER, USER |
Reconciliación, punto a tiempo |
Obligatorio |
|
SKU |
Sku para el servicio |
PARTNER, CUSTOMER, USER |
Reconciliación, punto a tiempo |
Obligatorio |
|
DESCRIPTION |
Descripción del servicio |
PARTNER, CUSTOMER, USER |
Reconciliación, punto a tiempo |
Obligatorio |
|
CONSUMPTION_START_DATE |
Inicio del consumo del servicio. Junto con el siguiente campo, este valor define el período de uso. |
PARTNER, CUSTOMER, USER |
Reconciliación |
Obligatorio |
|
CONSUMPTION_END_DATE |
Consumo final del servicio. Junto con el campo anterior, este valor define el período de consumo de uso. |
PARTNER, CUSTOMER, USER |
Reconciliación |
Obligatorio |
|
REPORT_DATE |
La fecha y hora en que se genera el informe. |
CUSTOMER, USER |
Punto en el tiempo |
Obligatorio |
|
QUANTITY |
Representa el consumo agregado de uso del usuario por socio, por cliente o por usuario (según el informe y el nivel en el que esté viendo los datos). Cálculo: El sistema calcula la cantidad por día para cada usuario en una base prorrateada para ese día. Uso para un día completo = 1 Uso durante medio día = 0.5 Luego, suma los totales por día para todos los días dentro del período de facturación para calcular la cantidad total para ese usuario dentro de ese período de facturación. Para los informes a nivel de clientes y socios, los totales para todos los usuarios se agregan para proporcionar una cantidad total para ese cliente o socio. Punto a tiempo: El informe del cliente enumera las asignaciones de paquetes por cliente. Cada fila representa la cantidad total de un paquete específico asignado a usuarios o espacios de trabajo dentro de una organización de cliente en particular. La cantidad muestra “0” si no hay paquetes asignados. El informe de usuario enumera los paquetes asignados a usuarios o espacios de trabajo. Cada fila muestra una cantidad de 1, que representa un usuario o espacio de trabajo y su paquete o complemento individual. Si se asignan varios paquetes o complementos a un usuario o espacio de trabajo, el informe muestra varias entradas, cada una con una cantidad de 1. |
PARTNER, CUSTOMER, USER |
Reconciliación, punto a tiempo |
Obligatorio |
|
LOCATION_ID |
Identificador de ubicación único |
CUSTOMER, USER |
Reconciliación, punto a tiempo El informe puntual del cliente no incluye el ID de ubicación |
Opcional |
|
LICENSE_ID |
Identificador de licencia Este campo es visible solo para paquetes mayoristas Para el informe de reconciliación, License_ID está en blanco para las licencias asignadas antes de la introducción de este campo. El informe de facturación muestra varias filas para el mismo paquete mayorista si está asociado con diferentes combinaciones de LOCATION_ID yLICENSE_ID. |
CUSTOMER, USER |
Reconciliación, punto a tiempo |
Opcional |
La selección de columnas opcionales modifica el orden de las columnas de los informes de reconciliación de clientes y usuarios. El siguiente pedido se aplica a los socios con solo SKU mayoristas en su suscripción:
Informe de nivel de usuario— 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_ID, SKUSERVICE_NAME, DESCRIPCIÓN,,CONSUMPTION_START_DATE,CONSUMPTION_END_DATE, CANTIDAD
Informe a nivel de cliente: PARTNER_NAME PARTNER_ORG_IDSUBSCRIPTION_ID,CUSTOMER_GROUP_ID,CUSTOMER_GROUP_NAME,CUSTOMER_ORG_ID,CUSTOMER_EXTERNAL_ID,LOCATION_ID, LICENSE_IDSERVICE_NAME, SKU, DESCRIPCIÓN,,CONSUMPTION_START_DATE,CONSUMPTION_END_DATE, CANTIDAD
El aprovisionamiento de un paquete a un usuario activa la facturación de Webex Wholesale, mientras que al eliminar la asignación del paquete se detiene.
Una organización de clientes puede pertenecer a un solo grupo de clientes en un momento dado. El soporte para varios grupos de clientes por organización no está disponible actualmente.