SAI Open

Mediante el siguiente servicio es posible solicitar a la plataforma Mi Vereda la facturación de un periodo en específico. Retorna un JSON con la estructura predeterminada por SAI Open

Billing SAI Open

POST https://services.mivereda.com/rest/account/saiOpen/billing

Este servicio permite solicitar a la plataforma Mi Vereda la facturación de un periodo, para ser cargado en el software SAI Open.

Headers

Name	Type	Description
Content-Type*	string	application/json
Authentication*	string	Api key de autenticación. Llave de autenticación enviada vía correo electrónico.

Request Body

Name	Type	Description
languageId*	integer	Id que representa el idioma con el que se generan los conceptos.
businessId*	integer	Id que representa el acueducto a consultar
initialDate*	string	String que representa la fecha inicial del periodo a consultar
endDate*	string	String que representa la fecha final del periodo a consultar
apiKey	string	Llave de autenticación, enviada vía correo electrónico.

200 Json de facturación retornado de manera exitosa

successUpdateMeasur

El valor apiKey es generado de manera automática y enviado vía correo electrónico.

Recuerda enviarlo tanto en el Headers como Authentication, como en el JSON en el campo apiKey

Posibles Notificaciones de Error

El servicio puede retornar los siguientes mensajes de error

JSON Incompleto

Cuando el Json es enviado con alguno de los datos nulos o no incluido, el servicio retornará el error Not Found - Empty Fields.

API Key Inválida

Cuando la llave de autenticación no coincide con la llave guardada en el sistema, el servicio retornará el error Not Found - API Key Invalid.

Id de Acueducto Inválido

Cuando el id del acueducto (businessId) no se encuentra en la base de datos del sistema, el servicio retornará el error Not Found - Invalid BusinessId

Fechas de facturación Inválidas

Cuando las fechas de inicio y fin son enviadas en un formato diferente, el servicio retornará el error Not Found - Invalid dates.

Error General

Cuando los datos enviados están correctos, pero el proceso de solicitud de la facturación ha fallado, el servicio retornará el error errorResponseBilling

Postman

Puede verificar el servicio a través de Postman.

Recuerda enviar los datos como un JSON.