Manual de Usuarios

Código: IDI-MA-01
Versión: 07
Vigencia desde: 06/05/2024

Consulta de Facturación

A través de la API de Sagicc, podrás consultar la información de facturación de tu instancia, incluyendo el consumo de usuarios por diferentes roles y el consumo de ítems adicionales (mensajes de texto, llamadas entrantes y salientes, mensajes de WhatsApp, interacciones de bots, etc.). Esta funcionalidad facilita una integración fluida de Sagicc con otros sistemas o plataformas, brindando acceso a información relevante de facturación para una gestión más eficiente de los recursos de tu instancia.

 

Para consultar la información de facturación, realiza una petición de tipo GET al endpoint https://{{sagicc_instance_url}}/api/billing/get-billing-data?startDate=2024-07-01&endDate=2024-07-31&groupBy=month, modificando los siguiente parámetros de acuerdo a tu requerimiento:

 

  • startDate: Fecha a partir de la cual se obtendrá la información de facturación. Debe especificarse en el formado AAAA-MM-DD.

  • endDate: Fecha hasta la cual se obtendrá la información de facturación. Debe especificarse en el formado AAAA-MM-DD.

  • groupBy: Forma de agrupamiento en la que se devolverá la información de facturación. Puede ser una de las siguientes opciones: day (retornará los datos agrupados por día), week (retornará los datos agrupados por semana) o month (retornará los datos agrupados por mes).

 

Si la petición se ejecuta exitosamente, la información se obtendrá en formato JSON, y la respuesta devolverá un código 200 junto con un mensaje de éxito. En caso de que la solicitud falle, la respuesta incluirá un código 400 acompañado de un mensaje que detallará la causa del error.

 

Versión Fecha Comentarios
Versión actual (v. 3) sept 05, 2024 19:35 Laura Ortiz
v. 2 sept 02, 2024 19:32 Laura Ortiz
v. 1 ago 22, 2024 21:07 Laura Ortiz