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 del registros de cambios, realiza una petición de tipo GET al siguiente endpoint:

https://{{sagicc_instance_url}}/api/billing/get-billing-data?startDate=2024-07-01&endDate=2024-07-31&groupBy=month

Asegúrate de modificar los siguientes parámetros de acuerdo a tus necesidades:

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, organizada de forma ascendente por fecha, 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.

La respuesta exitosa obtenida tendrá la siguiente estructura:

{
    "status": "OK",
    "code": 200,
    "message": "El reporte de facturación se ha obtenido exitosamente",
    "fullMessage": "200 - El reporte de facturación se ha obtenido exitosamente",
    "statusResult": true,
    "result": {
        "startDate": "2024-07-01",
        "endDate": "2024-07-01",
        "instance": "SAGICCTEST L10",
        "instance_url": "https://sagicctestl10.sagicc.co",
        "users": [
            {
                "id": 80681,
                "billing_instancia_id": 80681,
                "user_id": 4,
                "nombre": "Joohn Wick",
                "email": "jwick@sagicc.co",
                "roles": "administrador,agente",
                "canales": 3,
                "campanas": 2,
                "tipos_canales": 3,
                "dias_creado": 654,
                "habilitado": 1,
                "creado": "2022-09-16 11:37:55",
                "actualizado": "2024-06-28 10:51:34",
                "eliminado": null,
                "created_at": "2024-07-02T05:30:08.000000Z",
                "updated_at": "2024-07-02T05:30:08.000000Z",
                "instancia_id": 79,
                "fecha": "2024-07-01"
            },
            {...},
            {...},
            {...}
        ],
        "items": [
            {
                "fecha": "July",
                "tipo_item": "INBOUND_WHATSAPP_MESSAGE",
                "cantidad": "102.00"
            },
            {...0}
        ]
    }
}

La respuesta incluye información detallada sobre los usuarios (users) y los ítems facturados (items). A continuación, se describe el contenido de cada uno de estos objetos:

users:
- id: Identificador único del registro de facturación.
- billing_instancia_id: ID del vínculo entre usuario e instancia para fines de facturación.
- user_id: ID interno del usuario en la plataforma.
- nombre: Nombre del usuario.
- email: Correo electrónico del usuario.
- roles: Lista de roles asignados al usuario .
- canales: Número de canales asociados al usuario.
- campanas: Número de campañas a las que pertenece.
- tipos_canales: Cantidad de tipos distintos de canal asociados.
- dias_creado: Días transcurridos desde que fue creado el usuario.
- habilitado: Indica si el usuario está habilitado (1) o no (0).
- creado: Fecha y hora en que se creó el usuario.
- actualizado: Fecha y hora de la última actualización del usuario.
- eliminado: Si aplica, fecha y hora de eliminación del usuario (o null si no ha sido eliminado).
- created_at: Fecha y hora de creación del registro de facturación.
- updated_at: Fecha y hora de actualización del registro de facturación.
- instancia_id: Identificador de la instancia en la que se encuentra el usuario.
- fecha: Fecha específica del reporte de facturación para ese usuario.
items:
- fecha: Mes o fecha asociada al ítem facturado.
- tipo_item: Tipo de consumo registrado. Corresponde a un producto o servicio facturado por Sagicc.
- cantidad: Número de unidades consumidas para ese tipo de ítem.