API Rest GCI

A continuación se detalla cada uno de los servicios a desarrollar. Cada servicio contiene una descripción, sus parámetros de entrada y los datos de salida o respuesta.

Cabe destacar que los recursos acá presentados podrían ser modificados en el transcurso del proyecto si ambas partes así lo consideran, por lo que ésta podría no ser una versión definitiva.

Endpoint: https://api-gci-rest.integracionplanok.io/

Swagger UI: https://api-gci-rest.integracionplanok.io/docs/

GET /inmobiliarias

Servicio que cumple con la funcionalidad de obtener la información de la inmobiliaria en uso.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
api_key	String	API Key de la inmobiliaria

Datos de salida

Atributo	Tipo Dato	Descripción
id	Int	Id único inmobiliaria
nombre	String	Nombre
nombreInmobiliaria	String	Nombre de la inmobiliaria
tipoMoneda	String	Tipo de moneda utilizada por la inmobiliaria
telefono	String	Teléfono
mail	String	Email
path	String	Ruta de la inmobiliaria
apiEnviaMail	Int	Valida si la API debe enviar mails
emailNotificacionApi	Int	Valida si la API debe enviar un mail de notificación
lenguaje	String	Código del lenguaje del país
expectativas	Array[Object]	Expectativas configuradas
id	Int	Id único expectativa
glosa	String	Glosa expectativa
razonesDeCompra	Array[Object]	Razones de compra configuradas
id	Int	Id único razón de compra
glosa	String	Glosa razón de compra
canalesADistancia	Array[Object]	Canales a distancia configurados
id	Int	Id único canal a distancia
glosa	String	Glosa canal a distancia

Ejemplo respuesta

{
  "id": 0,
  "nombre": "string",
  "nombreInmobiliaria": "string",
  "tipoMoneda": "string",
  "telefono": "string",
  "mail": "string",
  "path": "string",
  "apiEnviaMail": 0,
  "emailNotificacionApi": 0,
  "lenguaje": "string",
  "expectativas": [
    {
      "id": 0,
      "glosa": "string"
    }
  ],
  "razonesDeCompra": [
    {
      "id": 0,
      "glosa": "string"
    }
  ],
  "canalesADistancia": [
    {
      "id": 0,
      "glosa": "string"
    }
  ]
}

Servicio que cumple la funcionalidad de poder permitir al usuario autenticarse mediante sus credenciales.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
api_key	String	API Key de la inmobiliaria
credentials	Json	{ "username": Int, "password": "string" }

Datos de salida

Atributo	Tipo Dato	Descripción
token	String	Token JWT generado para realizar las peticiones posteriores
usuario	Object	Usuario
dni	String	DNI / RUT usuario
nombre	String	Nombre usuario
apellido	String	Apellido usuario
email	String	Email usuario
telefono	String	Teléfono del usuario
tipoVendedor	Int	Tipo de vendedor
imagen	String	Imágen del usuario
permisosVentas	Boolean	Valida si el usuario posee permisos para visualizar la sala de ventas
permisosPromesa	Boolean	Valida si el usuario posee permisos para visualizar las promesas
permisosVentasPromesa	Boolean	Valida si el usuario posee permisos para visualizar la venta de una promesa
fechaCreacion	Datetime	Fecha de creación del usuario
fechaEdicion	Datetime	Última fecha de edición del usuario
idInmobiliaria	Int	Id de la inmobiliaria del usuario

Se debe considerar que para todas las peticiones posteriores al login se debe enviar siempre el token JWT, de lo contrario la petición fallará por no autorización

Ejemplo respuesta

{
  "token": "string",
  "usuario": {
    "dni": 0,
    "nombre": "string",
    "apellido": "string",
    "email": "user@example.com",
    "telefono": "string",
    "tipoVendedor": 0,
    "imagen": "string",
	"permisosVentas": "true",
	"permisosPromesa": "true",
	"permisosVentasPromesa": "true",
    "fechaCreacion": "2020-06-04T15:12:15.470Z",
    "fechaEdicion": "2020-06-04T15:12:15.470Z"
  },
  "idInmobiliaria": 0
}

GET /documentos

Servicio orientado a entregar información de los documentos asociados a un cliente.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
tipoIdentificador	String	Tipo identificador del cliente asociado a los documentos a buscar (rut o id_cliente)
identificador	String	Valor del tipo de identificador ingresado (Valor del rut o el id cliente)
fechaInicio	Date	Fecha de creación inicial desde la cual se buscaran los documentos
fechaFin	Date	Fecha de creación final desde la cual se buscaran los documentos
extension	String	Extensión de documento por la cual se filtraran los documentos
idTipoDocumento	Int	Identificador único del tipo de documento por el cual se filtraran los documentos
idDocumento	Int	Identificador único del documento
idProyecto	Int	Identificador único del proyecto

Datos de salida en cada objeto de documento:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del documento
nombreCorto	String	Nombre del documento sin la extensión
nombreLargo	String	Nombre del documento junto con la extensión
extension	String	Extensión del documento (Ej: jpg, jpeg, pdf)
tipoDocumento	Objecto
id	Int	Identificador único del tipo de documento
nombre	String	Glosa del tipo de documento
urlPublica	String	URL publica del documento

Ejemplo respuesta

[
  {
    "id": 0,
    "nombreCorto": "string",
    "nombreLargo": "string",
    "extension": "string",
    "tipoDocumento": {
      "id": 0,
      "nombre": "string"
    },
    "urlPublica": "string"
  }
]

GET /proyectos

Servicio orientado a entregar información de los proyectos de una inmobiliaria.

Datos de salida en cada objeto de proyecto:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del proyecto
nombre	String	Glosa del proyecto
precioDesde	Int	Precio desde del proyecto
distrito	String	Distrito al cual pertenece el proyecto
imagenes	Array[Object]
url	String	URL de la imagen
orden	Int	Orden de la imagen
fechaCreacion	Datetime	Fecha de creación del proyecto
fechaEdicion	Datetime	Fecha de edición del proyecto
direccion	String	Dirección del proyecto
activo	Boolean	Valida si el proyecto se encuentra activo
logo	String	Logo del proyecto
codigoProyectoErp	String	Código del proyecto ERP
descripcion	String	Descripción del proyecto

Ejemplo respuesta

[
  {
    "id": 0,
    "nombre": "string",
    "precioDesde": 0,
    "distrito": "string",
    "imagenes": [
      {
        "url": "string",
        "orden": 0
      }
    ],
    "fechaCreacion": "0000-00-00T00:00:00.000Z",
    "fechaEdicion": "0000-00-00T00:00:00.000Z",
    "direccion": "string",
    "activo": true,
    "logo": "string",
    "codigoProyectoErp": "string",
    "descripcion": "string"
  }
]

GET /proyectos/{id}/etapas

Servicio orientado a entregar información de las etapas que posee un proyecto.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	String	Identificador único del proyecto

Datos de salida en cada objeto de etapa:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de la etapa
nombre	String	Glosa de la etapa
notasCotizacion	Array[Object]
description	String	Descripción de la nota de cotización
orden	Int	Orden de la nota de cotización
validezCotizacion	Int	Validez de la cotización
telefono	String	Teléfono asociado a la etapa
email	String	Email asociado a la etapa
fechaCreacion	Datetime	Fecha creación de la etapa
fechaEdicion	Datetime	Fecha edición de la etapa

Ejemplo respuesta

[
  {
    "id": 0,
    "nombre": "string",
    "notasCotizacion": [
      {
        "descripcion": "string",
        "orden": 0
      }
    ],
    "validezCotizacion": 0,
    "telefono": "string",
    "email": "user@example.com",
    "fechaCreacion": "0000-00-00T00:00:00.000Z",
    "fechaEdicion": "0000-00-00T00:00:00.000Z"
  }
]

GET /proyectos/{id}/mediosDeLlegada

Servicio orientado a entregar información de los medios de llegadas asociados a un proyecto.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	String	Identificador único del proyecto

Datos de salida en cada objeto de medio de llegada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del medio de llegada
nombre	String	Glosa del medio de llegada
activo	Boolean	Muestra si el medio de llegada se encuentra activo
fechaInicio	Date	Fecha de inicio del medio de llegada
fechaFin	Date	Fecha de fin del medio de llegada
fechaCreacion	Datetime	Fecha de creación del medio de llegada

Ejemplo respuesta

[
  {
    "id": 0,
    "nombre": "string",
    "activo": true,
    "fechaInicio": "0000-00-00",
    "fechaFin": "0000-00-00",
    "fechaCreacion": "0000-00-00T00:00:00.000Z"
  }
]

GET /proyectos/{id}/modelos

Servicio orientado a entregar información de los modelos asociados a un proyecto.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del proyecto

Datos de salida en cada objeto de modelo:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del modelo
nombre	String	Glosa del modelo
dormitorios	Int	Cantidad de dormitorios
banos	Int	Cantidad de baños
imagenes	Array [String]
precioDesde	Int	Precio desde del modelo
fechaCreacion	Datetime	Fecha creación del modelo
fechaEdicion	Datetime	Fecha edición del modelo

Ejemplo respuesta

[
  {
    "id": 0,
    "nombre": "string",
    "dormitorios": 0,
    "banos": 0,
    "imagenes": [
      "string"
    ],
    "precioDesde": 0,
    "fechaCreacion": "0000-00-00T00:00:00.000Z",
    "fechaEdicion": "0000-00-00T00:00:00.000Z"
  }
]

GET /proyectos/{id}/productos-secundarios

Servicio orientado a entregar información de los productos secundarios asociados a un proyecto.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del proyecto

Datos de salida en cada objeto de productos secundarios:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del producto secundario
nombre	String	Glosa del producto secundario
nombreEtapa	String	Glosa de la etapa
nombreSubagrupacion	String	Glosa de la subagrupacion
proyecto	Object
id	Int	Identificador único del proyecto
nombre	String	Glosa del proyecto
precio	Int	Precio del producto secundario
descuentoMaximo	Object
valor	Int	Valor del descuento
unidad	String (UF, %)	Unidad del descuento
techado	Boolean	Muestra si el producto posee techado
piso	String	Piso en el cual se localiza el producto
tipo	String	Tipo del producto (Ej: Bodega, Estacionamiento)
disponibleWeb	Boolean	Muestra si el producto esta disponible en la web
disponible	Boolean	Muestra si el producto esta disponible
fechaCreacion	Datetime	Fecha de creación del producto secundario
fechaEdicion	Datetime	Fecha de edición del producto secundarios
estado	String	Estado del producto (Ej: Reservado, Promesado)

Ejemplo respuesta

[
  {
    "id": 0,
    "nombre": "string",
    "nombreEtapa": "string",
    "nombreSubagrupacion": "string",
    "proyecto": {
      "id": 0,
      "nombre": "string"
    },
    "precio": 0,
    "descuentoMaximo": {
      "valor": 0,
      "unidad": "%"
    },
    "techado": true,
    "piso": "string",
    "tipo": "string",
    "disponibleWeb": true,
    "disponible": true,
    "fechaCreacion": "0000-00-00T00:00:00.000Z",
    "fechaEdicion": "0000-00-00T00:00:00.000Z",
    "estado": "string"
  }
]

GET /proyectos/{id}/productos-adicionales

Servicio orientado a entregar información de los productos adicionales asociados a un proyecto.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del proyecto

Datos de salida en cada objeto de producto adicional:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del producto adicional
nombre	String	Glosa del producto adicional
nombreEtapa	String	Glosa de la etapa
nombreSubagrupacion	String	Glosa de la subagrupacion
proyecto	Object
id	Int	Identificador único del proyecto
nombre	String	Glosa del proyecto
precio	Int	Precio del producto adicional
descuentoMaximo	Object
valor	Int	Valor del descuento
unidad	String (UF, %)	Unida del descuento
fechaCreacion	Datetime	Fecha de creación del producto adicional
fechaEdicion	Datetime	Fecha de edición del producto adicional

Ejemplo respuesta

[
  {
    "id": 0,
    "nombre": "string",
    "nombreEtapa": "string",
    "nombreSubagrupacion": "string",
    "proyecto": {
      "id": 0,
      "nombre": "string"
    },
    "precio": 0,
    "descuentoMaximo": {
      "valor": 0,
      "unidad": "%"
    },
    "fechaCreacion": "0000-00-00T00:00:00.000Z",
    "fechaEdicion": "0000-00-00T00:00:00.000Z"
  }
]

GET /proyectos/nombre/{nombre}/reserva

Servicio orientado a entregar información de las reservas asociados a un proyecto.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
nombre	String	Glosa del proyecto

Datos de salida por cada objeto de reserva:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de reserva
fechaReserva	Date	Fecha en la cual se produjo la reserva
totalLista	Float	Precio total lista de la reserva
descuentoSubtotal	Object
valor	Float	Valor del descuento al subtotal de la reserva
unidad	String (UF, %)	Unidad del descuento al subtotal de la reserva
totalVenta	Float	Precio total de la reserva
productos	Array[Object]
id	Int	Identificador único del producto
nombre	String	Glosa de producto
tipo	String (Principal, Secundario)	Tipo de producto
precioLista	Float	Precio lista del producto
descuento	Object
valor	Float	Valor de descuento del producto
unidad	String (UF, %))	Unidad del descuento del producto
precioVenta	Float	Precio venta del producto
proyecto	Object
id		Identificador único de proyecto
nombre	String	Proyecto al cual pertenece el producto
etapa	Object
id		Identificador único de etapa
nombre	String	Etapa a la cual pertenece el producto
subAgrupacion	Object
id		Identificador único de subagrupación
nombre	String	Subagrupación a la cual pertenece el producto
cliente	Object
id		Identificador único de cliente
identificadorPersonal	String	Rut de cliente
nombre	String	Nombre completo de cliente
telefono	String	Teléfono de cliente
email	String	Email de cliente

Nota: Se debe considerar que una reserva posee como mínimo 1 producto principal. A su vez, ésta puede considerar ninguno, uno o más productos secundarios, por lo que el total de productos asociados a la reserva podrían proyectarse como colecciones de productos.

Ejemplo respuesta

[
  {
    "id": 0,
    "fechaReserva": "0000-00-00T00:00:00.000Z",
    "totalLista": 0,
    "descuentoSubtotal": {
      "valor": 0,
      "unidad": "%"
    },
    "totalVenta": 0,
    "productos": [
      {
        "id": 0,
        "nombre": "string",
        "tipo": "PRINCIPAL",
        "precioLista": 0,
        "descuento": {
          "valor": 0,
          "unidad": "%"
        },
        "precioVenta": 0,
        "proyecto": {
          "id": 0,
          "nombre": "string"
        },
        "etapa": {
          "id": 0,
          "nombre": "string"
        },
        "subAgrupacion": {
          "id": 0,
          "nombre": "string"
        }
      }
    ],
    "cliente": {
      "id": 0,
      "identificadorPersonal": "string",
      "nombre": "string",
      "telefono": "string",
      "email": "user@example.com"
    }
  }
]

GET /etapas/{id}/subagrupaciones

Servicio orientado a entregar información de las subagrupaciones asociadas a una etapa.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de la etapa

Datos de salida por cada objeto de subagrupacion:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de reserva
nombre	String	Glosa de la subagrupacion
fechaCreacion	Datetime	Fecha de creación de la subagrupacion
fechaEdicion	Datetime	Fecha de edición de la subagrupacion

Ejemplo respuesta

[
  {
    "id": 0,
    "nombre": "string",
    "fechaCreacion": "0000-00-00T00:00:00.000Z",
    "fechaEdicion": "0000-00-00T00:00:00.000Z"
  }
]

GET /etapa/{id}/productos-secundarios

Servicio orientado a entregar información de los productos secundarios asociados a una etapa.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de la etapa

Datos de salida en cada objeto de productos secundarios:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del producto secundario
nombre	String	Glosa del producto secundario
nombreEtapa	String	Glosa de la etapa
nombreSubagrupacion	String	Glosa de la subagrupacion
proyecto	Object
id	Int	Identificador único del proyecto
nombre	String	Glosa del proyecto
precio	Int	Precio del producto secundario
descuentoMaximo	Object
valor	Int	Valor del descuento
unidad	String (UF, %)	Unidad del descuento
techado	Boolean	Muestra si el producto posee techado
piso	String	Piso en el cual se localiza el producto
tipo	String	Tipo del producto (Ej: Bodega, Estacionamiento)
disponibleWeb	Boolean	Muestra si el producto esta disponible en la web
disponible	Boolean	Muestra si el producto esta disponible
fechaCreacion	Datetime	Fecha de creación del producto secundario
fechaEdicion	Datetime	Fecha de edición del producto secundarios
estado	String	Estado del producto (Ej: Reservado, Promesado)

Ejemplo respuesta

[
  {
    "id": 0,
    "nombre": "string",
    "nombreEtapa": "string",
    "nombreSubagrupacion": "string",
    "proyecto": {
      "id": 0,
      "nombre": "string"
    },
    "precio": 0,
    "descuentoMaximo": {
      "valor": 0,
      "unidad": "%"
    },
    "techado": true,
    "piso": "string",
    "tipo": "string",
    "disponibleWeb": true,
    "disponible": true,
    "fechaCreacion": "0000-00-00T00:00:00.000Z",
    "fechaEdicion": "0000-00-00T00:00:00.000Z",
    "estado": "string"
  }
]

GET /modelos/{modeloId}/imagenes/{id}

Servicio orientado a entregar información de los productos secundarios asociados a una etapa.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
modeloId	Int	Identificador único del modelo
id	Int	Identificador único de la imagen

Datos de salida en cada objeto de productos secundarios:

Atributo	Tipo Dato	Descripción
Imagen	File	Imagen del modelo

Ejemplo respuesta

File

GET /modelos/{id}/productos-principales

Servicio orientado a entregar información de los productos principales asociados a un modelo.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del modelo

Datos de salida en cada objeto de productos principal:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del producto principal
nombre	String	Glosa del producto principal
nombreProyecto	String	Glosa del proyecto
nombreEtapa	String	Glosa de la etapa
nombreSubagrupacion	String	Glosa de la subagrupacion
nombreModelo	String	Glosa del modelo
precio	Int	Precio del producto
descuentoMaximo	Object
valor	Int	Valor del descuento
unidad	String (UF, %)	Unidad del descuento
piso	Int	Cantidad pisos del producto
orientacion	String	Orientación del producto
fechaCreacion	Datetime	Fecha de creación del producto
fechaEdicion	Datetime	Fecha de edición del producto
tipo_producto	String	Tipo de producto (Ej: Departamento, Oficina)
programa	String	Programa del producto
superficies	Object
terraza	Int	Calculo de la superficie de la terraza
interior	Int	Calculo de la superficie interior
util	Int	Calculo de la superficie útil
total	Int	Calculo de la superficie total
loggia	Int	Calculo de la superficie loggia
jardin	Int	Calculo de la superficie del jardín
miradorTerraza	Int	Calculo de la superficie del mirador de la terraza
otrasSuperficies	Int	Calculo de otras superficies
terreno	Int	Calculo de la superficie del terreno
disponibleWeb	Boolean	Muestra si el producto esta disponible en la web
disponibleSistema	Boolean	Muestra si el producto esta disponible en el sistema
estado	String	Estado del producto (Ej: Disponible, Reservado, Promesado)

Ejemplo respuesta

[
  {
    "id": 0,
    "nombre": "string",
    "nombreProyecto": "string",
    "nombreEtapa": "string",
    "nombreSubagrupacion": "string",
    "nombreModelo": "string",
    "precio": 0,
    "descuentoMaximo": {
      "valor": 0,
      "unidad": "%"
    },
    "piso": 0,
    "orientacion": "string",
    "fechaCreacion": "0000-00-00T00:00:00.000Z",
    "fechaEdicion": "0000-00-00T00:00:00.000Z",
    "tipo_producto": "string",
    "programa": "string",
    "superficies": {
      "terraza": 0,
      "interior": 0,
      "util": 0,
      "total": 0,
      "loggia": 0,
      "jardin": 0,
      "miradorTerraza": 0,
      "otrasSuperficies": 0,
      "terreno": 0
    },
    "disponibleWeb": true,
    "disponibleSistema": true,
    "estado": "Disponible"
  }
]

GET /subagrupaciones/{id}/productos-secundarios

Servicio orientado a entregar información de los productos secundarios asociados a una subagrupacion.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de la subagrupacion

Datos de salida en cada objeto de productos secundarios:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del producto secundario
nombre	String	Glosa del producto secundario
nombreEtapa	String	Glosa de la etapa
nombreSubagrupacion	String	Glosa de la subagrupacion
proyecto	Object
id	Int	Identificador único del proyecto
nombre	String	Glosa del proyecto
precio	Int	Precio del producto secundario
descuentoMaximo	Object
valor	Int	Valor del descuento
unidad	String (UF, %)	Unidad del descuento
techado	Boolean	Muestra si el producto posee techado
piso	String	Piso en el cual se localiza el producto
tipo	String	Tipo del producto (Ej: Bodega, Estacionamiento)
disponibleWeb	Boolean	Muestra si el producto esta disponible en la web
disponible	Boolean	Muestra si el producto esta disponible
fechaCreacion	Datetime	Fecha de creación del producto secundario
fechaEdicion	Datetime	Fecha de edición del producto secundarios
estado	String	Estado del producto (Ej: Reservado, Promesado)

Ejemplo respuesta

[
  {
    "id": 0,
    "nombre": "string",
    "nombreEtapa": "string",
    "nombreSubagrupacion": "string",
    "proyecto": {
      "id": 0,
      "nombre": "string"
    },
    "precio": 0,
    "descuentoMaximo": {
      "valor": 0,
      "unidad": "%"
    },
    "techado": true,
    "piso": "string",
    "tipo": "string",
    "disponibleWeb": true,
    "disponible": true,
    "fechaCreacion": "0000-00-00T00:00:00.000Z",
    "fechaEdicion": "0000-00-00T00:00:00.000Z",
    "estado": "string"
  }
]

GET /subagrupaciones/{id}/productos-adicionales

Servicio orientado a entregar información de los productos adicionales asociados a una subagrupacion.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de la subagrupacion

Datos de salida en cada objeto de producto adicional:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del producto adicional
nombre	String	Glosa del producto adicional
nombreEtapa	String	Glosa de la etapa
nombreSubagrupacion	String	Glosa de la subagrupacion
proyecto	Object
id	Int	Identificador único del proyecto
nombre	String	Glosa del proyecto
precio	Int	Precio del producto adicional
descuentoMaximo	Object
valor	Int	Valor del descuento
unidad	String (UF, %)	Unida del descuento
fechaCreacion	Datetime	Fecha de creación del producto adicional
fechaEdicion	Datetime	Fecha de edición del producto adicional

Ejemplo respuesta

[
  {
    "id": 0,
    "nombre": "string",
    "nombreEtapa": "string",
    "nombreSubagrupacion": "string",
    "proyecto": {
      "id": 0,
      "nombre": "string"
    },
    "precio": 0,
    "descuentoMaximo": {
      "valor": 0,
      "unidad": "%"
    },
    "fechaCreacion": "0000-00-00T00:00:00.000Z",
    "fechaEdicion": "0000-00-00T00:00:00.000Z"
  }
]

GET /packs

Servicio orientado a entregar información de los packs.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id_proyecto	Int	Identificador único del proyecto
id_modelo	Int	Identificador único del modelo
id_producto	Int	Identificador único del producto principal
id_producto_secundario	Int	Identificador único del producto secundario

Datos de salida en cada objeto de producto adicional:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del producto adicional
subagrupacion	Object
id	Int	Identificador único del
nombre	String	Glosa de la subagrupacion
proyecto	String
id	Int	Identificador único del
nombre	Object	Glosa del proyecto
productosPrincipales	Array[Object]
id	Int	Identificador único del
nombre	Varchar	Glosa del producto principal
subagrupacion	Object
id	Int	Identificador único del
etapa	Object
id	Int	Identificador único del
proyecto	Object
id	Int	Identificador único del
nombreProyecto	String	Glosa del proyecto
nombreEtapa	String	Glosa de la etapa
nombreModelo	String	Glosa del modelo
precio	Int	Precio del producto
precioTerreno	Int	Precio terreno del producto
descuentoMaximo	Object
valor	Int	Valor del descuento
unidad	String (UF, %)	Unidad del descuento
piso	Int	Cantidad pisos del producto
orientacion	String	Orientación del producto
fechaCreacion	Datetime	Fecha de creación del producto
fechaEdicion	Datetime	Fecha de edición del producto
fechaRecepcionMunicipal	Date	Fecha de recepción municipal
tipo_producto	String	Tipo de producto (Ej: Departamento, Oficina)
programa	String	Programa del producto
superficies	Object
terraza	Int	Calculo de la superficie de la terraza
interior	Int	Calculo de la superficie interior
util	Int	Calculo de la superficie útil
total	Int	Calculo de la superficie total
loggia	Int	Calculo de la superficie loggia
jardin	Int	Calculo de la superficie del jardín
miradorTerraza	Int	Calculo de la superficie del mirador de la terraza
otrasSuperfices	Int	Calculo de la superficie de otras superficies
terreno	Int	Calculo de la superficie del terreno
disponibleWeb	Boolean	Muestra si el producto esta disponible en la web
disponibleSistema	Boolean	Muestra si el producto esta disponible en el sistema
proyecto	Object
id	Int	Identificador único del
modelo	Object
id	Int	Identificador único del
estado	String	Estado del producto (Ej: Reservado, Promesado)
productosSecundarios	Array[Object]
id	Int	Identificador único del
nivelJerarquico	String	Nivel jerárquico del producto secundario
nombre	String	Glosa del producto secundario
nombreEtapa	String	Glosa de la etapa
nombreSubagrupacion	String	Glosa de la subagrupacion
proyecto	Object
id	Int	Identificador único del
nombre	String	Glosa del proyecto
subAgrupacion	Object
id	Int	Identificador único del
etapa	Object
id	Int	Identificador único del
precio	Int	Precio del producto secundario
precioTerreno	Int	Precio terreno del producto secundario
descuentoMaximo	Object
valor	Int	Valor del descuento
unidad	String (UF, %)	Unidad del descuento
techado	Boolean	Muestra si el producto posee techado
piso	Int	Piso en el cual se localiza el producto
tipo	String	Tipo del producto (Ej: Bodega, Estacionamiento)
disponibleWeb	Boolean	Muestra si el producto esta disponible en la web
disponible	Boolean	Muestra si el producto esta disponible
fechaCreacion	Datetime	Fecha de creación del producto principal
fechaEdicion	Datetime	Fecha de edición del producto principal
productosAdicionales	Array[Object]
id	Int	Identificador único del
nivelJerarquico	String	Nivel jerárquico del producto adicional
nombre	String	Glosa del producto adicional
nombreEtapa	String	Glosa de la etapa
nombreSubagrupacion	String	Glosa de subagrupacion
proyecto	Object
id	Int	Identificador único del
nombre	String	Glosa del proyecto
subagrupacion	Object
id	Int	Identificador único del
etapa	Object
id	Int	Identificador único del
proyecto	Object
id	Int	Identificador único del
precio	Int	Precio del producto adicional
descuentoMaximo	Object
valor	Int	Valor del descuento
unidad	String (UF, %)	Unida del descuento
fechaCreacion	Datetime	Fecha de creación del producto adicional
fechaEdicion	Datetime	Fecha de edición del producto adicional

Ejemplo respuesta

[
  {
    "id": 0,
    "subagrupacion": {
      "id": 0,
      "nombre": "string",
      "etapa": {
        "id": 0,
        "nombre": "string",
        "proyecto": {
          "id": 0,
          "nombre": "string"
        }
      }
    },
    "productosPrincipales": [
      {
        "id": 0,
        "nombre": "string",
        "subAgrupacion": {
          "id": 0,
          "etapa": {
            "id": 0,
            "proyecto": {
              "id": 0
            }
          }
        },
        "nombreProyecto": "string",
        "nombreEtapa": "string",
        "nombreSubAgrupacion": "string",
        "nombreModelo": "string",
        "precio": 0,
        "precioTerreno": 0,
        "descuentoMaximo": {
          "valor": 0,
          "unidad": "string"
        },
        "piso": 0,
        "orientacion": "string",
        "fechaCreacion": "0000-00-00T00:00:00.000Z",
        "fechaEdicion": "0000-00-00T00:00:00.000Z",
        "fechaRecepcionMunicipal": "string",
        "tipo_producto": "string",
        "programa": "string",
        "superficies": {
          "terraza": 0,
          "interior": 0,
          "util": 0,
          "total": 0,
          "loggia": 0,
          "jardin": 0,
          "miradorTerraza": 0,
          "otrasSuperficies": 0,
          "terreno": 0
        },
        "disponibleWeb": true,
        "disponibleSistema": true,
        "proyecto": {
          "id": 0,
          "modelo": {
            "id": 0
          }
        },
        "estado": "string"
      }
    ],
    "productosSecundarios": [
      {
        "id": 0,
        "nivelJerarquico": "string",
        "nombre": "string",
        "nombreEtapa": "string",
        "nombreSubagrupacion": "string",
        "proyecto": {
          "id": 0,
          "nombre": "string"
        },
        "subAgrupacion": {
          "id": 0
        },
        "etapa": {
          "id": 0
        },
        "precio": 0,
        "precioTerreno": 0,
        "descuentoMaximo": {
          "valor": 0,
          "unidad": "%"
        },
        "techado": true,
        "piso": 0,
        "tipo": "string",
        "disponibleWeb": true,
        "disponible": true,
        "fechaCreacion": "0000-00-00T00:00:00.000Z",
        "fechaEdicion": "0000-00-00T00:00:00.000Z"
      }
    ],
    "productosAdicionales": [
      {
        "id": 0,
        "nivelJerarquico": "string",
        "nombre": "string",
        "nombreEtapa": "string",
        "nombreSubagrupacion": "string",
        "proyecto": {
          "id": 0,
          "nombre": "string"
        },
        "subAgrupacion": {
          "id": 0,
          "etapa": {
            "id": 0,
            "proyecto": {
              "id": 0
            }
          }
        },
        "precio": 0,
        "descuentoMaximo": {
          "valor": 0,
          "unidad": "string"
        },
        "fechaCreacion": "0000-00-00T00:00:00.000Z",
        "fechaEdicion": "0000-00-00T00:00:00.000Z"
      }
    ]
  }
]

GET /clientes/naturales/cotizaciones/{rut_dni}

Servicio orientado a entregar información de las cotizaciones de un cliente natural.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
rut_dni	Int	Rut o DNI del cliente

Datos de salida en cada objeto de producto adicional:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del producto adicional
productoPrincipal	Object
id	Int	Identificador único del
glosaProyecto	String	Glosa del proyecto
glosaEtapa	String	Glosa de la etapa
glosaSubagrupacion	String	Glosa de la subagrupacion
glosaModelo	String	Glosa del modelo
idProducto	Int	Identificador único del producto
glosaProducto	String	Glosa del producto principal
programa	String	Programa del producto
pisoProductoPrincipal	String	Cantidad pisos del producto
orientacion	String	Orientación del producto
activoWeb	Boolean	Muestra si el producto esta activo en la web
supInterior	Int	Calculo de la superficie interior
supTerraza	Int	Calculo de la superficie de la terraza
superficieUtil	Int	Calculo de la superficie útil
fechaCreacion	Datetime	Fecha de creación del producto
estado	String	Estado del producto
productoSecundario	Object
id	Int	Identificador único del producto secundario
nombre	String	Glosa del producto secundario
tipo	String	Tipo de producto
piso	Int	Piso en el cual se localiza el producto
estado	String	Estado del producto (Reservado, Promesado)
ps
id	Int	Identificador único del producto secundario
glosa	String	Glosa del producto secundario
glosaProyecto	String	Glosa del proyecto
glosaEtapa	String	Glosa de la etapa
glosaSubagrupacion	String	Glosa de la subagrupacion
piso	String	Piso en el cual se localiza el producto
fechaCrecion	Datetime	Fecha de creación del producto
tipo	String	Tipo del producto (Ej: Bodega, Estacionamiento)
estado	String	Estado del producto (Reservado, Promesado)

Ejemplo respuesta

[
  {
    "id": 0,
    "productoPrincipal": {
      "glosaProyecto": "string",
      "glosaEtapa": "string",
      "glosaSubagrupacion": "string",
      "glosaModelo": "string",
      "idProducto": 0,
      "glosaProducto": "string",
      "programa": "string",
      "pisoProductoPrincipal": "string",
      "orientacion": "string",
      "activoWeb": true,
      "supInterior": 0,
      "supTerraza": 0,
      "superficieUtil": 0,
      "fechaCreacion": "0000-00-00T00:00:00.000Z",
      "estado": "Disponible"
    },
    "productoSecundario": [
      {
        "id": 0,
        "nombre": "string",
        "tipo": "string",
        "piso": 0,
        "estado": "Disponible"
      }
    ],
    "ps": [
      {
        "id": 0,
        "glosa": "string",
        "glosaProyecto": "string",
        "glosaEtapa": "string",
        "glosaSubagrupacion": "string",
        "piso": "string",
        "fechaCreacion": "0000-00-00T00:00:00.000Z",
        "tipo": "string",
        "estado": "Disponible"
      }
    ]
  }
]

GET /leads

Servicio orientado a entregar información de los leads.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
estado	String	Estado del lead
fechaInicio	Date	Fecha inicial desde la cual se necesita filtrar
fechaFin	Date	Fecha final desde la cual se necesita filtrar

Datos de salida en cada objeto de producto adicional:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del producto adicional
estado	String	Estado del lead
fecha_ingreso	Datetime	Fecha de ingreso del lead
fecha_contacto	Datetime	Fecha de contacto del lead
via_ingreso	String	Vía de ingreso del lead
medio_llegada	String	Medio de llegada del lead
medio_defecto	String	Medio de defecto del lead
rut	String	Rut del cliente
nombre	String	Nombre del cliente
telefono_fijo	String	Teléfono fijo del cliente
telefono_movil	String	Teléfono móvil del cliente
email	String	Email del cliente
proyecto	String	Glosa del proyecto
producto	String	Glosa del producto
vendedor	String	Nombre del vendedor
correo_vendedor	String	Correo del vendedor
contacto	String	Estado del contacto
comentario	String	Comentario del lead
id_cliente	Int	Identificador único del cliente
id_proyecto	Int	Identificador único del proyecto
id_visita	Int	Identificador único de la visita
rut_usuario	String	Rut del usuario

Ejemplo respuesta

[
  {
    "id": 0,
    "estado": "string",
    "fecha_ingreso": "0000-00-00T00:00:00.000Z",
    "fecha_contacto": "0000-00-00T00:00:00.000Z",
    "via_ingreso": "string",
    "medio_llegada": "string",
    "medio_defecto": "string",
    "rut": "string",
    "nombre": "string",
    "telefojo_fijo": "string",
    "telefono_movil": "string",
    "email": "string",
    "proyecto": "string",
    "producto": "user@example.com",
    "vendedor": "string",
    "correo_vendedor": "string",
    "contacto": "string",
    "comentario": "string",
    "id_cliente": 0,
    "id_proyecto": 0,
    "id_visita": 0,
    "rut_usuario": "string"
  }
]

PATCH /leads

Servicio orientado a modificar uno o varios datos de un lead.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
data	Json	{}

Nota: Este servicio actualiza solo los campos que se introduzcan en el JSON, el nombre de estos campos debe ser igual a los nombres de las columnas de la base de datos, sino arrojara un error.

Datos de salida:

Atributo	Tipo Dato	Descripción
Mensaje	String	Mensaje que se entrega cuando la solicitud es exitosa

Ejemplo respuesta

"string"

POST /clientes/documento

Servicio orientado a cargar documentos en la ficha de un cliente.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
idCliente	String (FormData)
idTipoDocumento	String (FormData)
	File (FormData)

Datos de salida:

Atributo	Tipo Dato	Descripción
idDocumento	Int	Identificador único del proyecto
nombreDocumento	String	Nombre del documento cargado
fechaCarga	Datetime	Fecha de carga del documento
tipoDocumento	Object
id	Int	Identificador único del tipo de documento
tipoDocumento	String	Nombre del tipo de documento

Ejemplo respuesta

{
  "idDocumento": 0,
  "nombreDocumento": "string",
  "fechaCarga": "2023-05-17T15:35:39.679Z",
  "tipoDocumento": {
    "id": 0,
    "tipoDocumento": "string"
  }
}

GET /clientes/vendedor-by-cliente

Servicio orientado a obtener los vendedores asignados a un cliente por proyecto.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
identificador	String	Tipo de identificador del cliente a buscar (rut/dni o id cliente)
valorIdentificador	String	Valor del tipo de identificador ingresado (Si es rut, este se debe ingresar sin guion y digito verificador)
tipoCliente	String	Tipo cliente a buscar (Natural o Jurídico)
idProyecto	Int	Identificador único del proyecto

Datos de salida:

Atributo	Tipo Dato	Descripción
id_proyecto	Int	Identificador único del proyecto
glosa_proyecto	String	Glosa del proyecto
vendedor	Object
vendedor_seguimiento_reciente	Object
id_seguimiento	Int	Identificador único del seguimiento
rut_largo_vendedor_seguimiento	String	Rut con digito verificador del vendedor del seguimiento
rut_corto_vendedor_seguimiento	String	Rut sin digito verificador del vendedor del seguimiento
dv_vendedor_seguimiento	String	Digito verificador del vendedor del seguimiento
nombre_vendedor_seguimiento	String	Nombre del vendedor del seguimiento
apellido_paterno_vendedor_seguimiento	String	Apellido paterno del vendedor del seguimiento
apellido_materno_vendedor_seguimiento	String	Apellido materno del vendedor del seguimiento
telefono_vendedor_seguimiento	String	Teléfono del vendedor del seguimiento
email_vendedor_seguimiento	String	Email del vendedor del seguimiento
fecha_seguimiento	Datetime	Fecha de creación del seguimiento
vendedor_cotizacion_reciente	Object
id_cotizacion	Int	Identificador único de la cotización
rut_largo_vendedor_cotizacion	String	Rut con digito verificador del vendedor del cotización
rut_corto_vendedor_cotizacion	String	Rut sin digito verificador del vendedor del cotización
dv_vendedor_cotizacion	String	Digito verificador del vendedor de la cotización
nombre_vendedor_cotizacion	String	Nombre del vendedor de la cotización
apellido_paterno_vendedor_cotizacion	String	Apellido paterno del vendedor de la cotización
apellido_materno_vendedor_cotizacion	String	Apellido materno del vendedor de la cotización
telefono_vendedor_cotizacion	String	Teléfono del vendedor de la cotización
email_vendedor_cotizacion	String	Email del vendedor de la cotización
fecha_cotizacion	Datetime	Fecha de creación de la cotización
vendedor_reserva_reciente	Object
id_reserva	Int	Identificador único de la reserva
rut_largo_vendedor_reserva	String	Rut con digito verificador del vendedor del reserva
rut_corto_vendedor_reserva	String	Rut sin digito verificador del vendedor del reserva
dv_vendedor_reserva	String	Digito verificador del vendedor de la reserva
nombre_vendedor_reserva	String	Nombre del vendedor de la reserva
apellido_paterno_vendedor_reserva	String	Apellido paterno del vendedor de la reserva
apellido_materno_vendedor_reserva	String	Apellido materno del vendedor de la reserva
telefono_vendedor_reserva	String	Teléfono del vendedor de la reserva
email_vendedor_reserva	String	Email del vendedor de la reserva
fecha_reserva	Datetime	Fecha de creación de la reserva
vendedor_promesa_reciente	Object
id_promesa	Int	Identificador único de la promesa
rut_largo_vendedor_promesa	String	Rut con digito verificador del vendedor de la promesa
rut_corto_vendedor_promesa	String	Rut sin digito verificador del vendedor de la promesa
dv_vendedor_promesa	String	Digito verificador del vendedor de la promesa
nombre_vendedor_promesa	String	Nombre del vendedor de la promesa
apellido_paterno_vendedor_promesa	String	Apellido paterno del vendedor de la promesa
apellido_materno_vendedor_promesa	String	Apellido materno del vendedor de la promesa
telefono_vendedor_promesa	String	Teléfono del vendedor de la promesa
email_vendedor_promesa	String	Email del vendedor de la promesa
fecha_promesa	Datetime	Fecha de creación de la promesa

Ejemplo respuesta

[
  {
    "id_proyecto": 0,
    "glosa_proyecto": "string",
    "vendedor": {
      "vendedor_seguimiento_reciente": {
        "id_seguimiento": 0,
        "rut_largo_vendedor_seguimiento": "string",
        "rut_corto_vendedor_seguimiento": "string",
        "dv_vendedor_seguimiento": "string",
        "nombre_vendedor_seguimiento": "string",
        "apellido_paterno_vendedor_seguimiento": "string",
        "apellido_materno_vendedor_seguimiento": "string",
        "telefono_vendedor_seguimiento": "string",
        "email_vendedor_seguimiento": "string",
        "fecha_seguimiento": "0000-00-00T00:00:00.000Z"
      },
      "vendedor_cotizacion_reciente": {
        "id_cotizacion": 0,
        "rut_largo_vendedor_cotizacion": "string",
        "rut_corto_vendedor_cotizacion": "string",
        "dv_vendedor_cotizacion": "string",
        "nombre_vendedor_cotizacion": "string",
        "apellido_paterno_vendedor_cotizacion": "string",
        "apellido_materno_vendedor_cotizacion": "string",
        "telefono_vendedor_cotizacion": "string",
        "email_vendedor_cotizacion": "string",
        "fecha_cotizacion": "0000-00-00T00:00:00.000Z"
      },
      "vendedor_reserva_reciente": {
        "id_reserva": 0,
        "rut_largo_vendedor_reserva": "string",
        "rut_corto_vendedor_reserva": "string",
        "dv_vendedor_reserva": "string",
        "nombre_vendedor_reserva": "string",
        "apellido_paterno_vendedor_reserva": "string",
        "apellido_materno_vendedor_reserva": "string",
        "telefono_vendedor_reserva": "string",
        "email_vendedor_reserva": "string",
        "fecha_reserva": "0000-00-00T00:00:00.000Z"
      },
      "vendedor_promesa_reciente": {
        "id_promesa": 0,
        "rut_largo_vendedor_promesa": "string",
        "rut_corto_vendedor_promesa": "string",
        "dv_vendedor_promesa": "string",
        "nombre_vendedor_promesa": "string",
        "apellido_paterno_vendedor_promesa": "string",
        "apellido_materno_vendedor_promesa": "string",
        "email_vendedor_promesa": "string",
        "fecha_promesa": "0000-00-00T00:00:00.000Z"
      }
    }
  }
]

GET /clientes/naturales

Servicio orientado a entregar información sobre un cliente natural.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
identificador-personal	Int	Identificador personal del cliente

Datos de salida:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del cliente
nombre	String	Glosa del cliente
apellidoPaterno	String	Apellido paterno del cliente
apellidoMaterno	String	Apellido materno del cliente
edad	String	Edad del cliente
departamento	String	Región en la cual reside el cliente
provincia	String	Provincia en la cual reside el cliente
distrito	String	Distrito en el cual reside el cliente
celular	String	Numero de celular del cliente
telefono	String	Numero de teléfono del cliente
email	String	Email de contacto del cliente
estadoCivil	String	Estado civil del cliente
ingresoFamiliar	String	Ingreso familiar del cliente
ingresoIndividual	Int	Ingreso individual del cliente
profesion	String	Profesión del cliente
fechaCreacion	Datetime	Fecha de creación del cliente
fechaEdicion	Datetime	Fecha de edición del cliente
dni	String	DNI del cliente
direccion	String	Dirección del cliente

Ejemplo respuesta

{
  "id": 0,
  "nombre": "string",
  "apellidoPaterno": "string",
  "apellidoMaterno": "string",
  "edad": 0,
  "departamento": "string",
  "provincia": "string",
  "distrito": "string",
  "celular": "string",
  "telefono": "string",
  "email": "user@example.com",
  "estadoCivil": "string",
  "ingresoFamiliar": 0,
  "ingresoIndividual": 0,
  "profesion": "string",
  "fechaCreacion": "0000-00-00T00:00:00.000Z",
  "fechaEdicion": "0000-00-00T00:00:00.000Z",
  "dni": "string",
  "direccion": "string"
}

POST /clientes/naturales

Servicio orientado a crear un cliente natural.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
cliente	Int	{ "identificadorPersonal": 0, "digitoVerificador": "string", "nombre": "string", "apellidoPaterno": "string", "apellidoMaterno": "String", "celular": "string", "email": "user@example.com" }

Datos de salida:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del cliente

nombre	String	Glosa del cliente
apellidoPaterno	String	Apellido paterno del cliente
apellidoMaterno	String	Apellido materno del cliente
edad	String	Edad del cliente
departamento	String	Región en la cual reside el cliente
provincia	String	Provincia en la cual reside el cliente
distrito	String	Distrito en el cual reside el cliente
celular	String	Numero de celular del cliente
telefono	String	Numero de teléfono del cliente
email	String	Email de contacto del cliente
estadoCivil	String	Estado civil del cliente
ingresoFamiliar	String	Ingreso familiar del cliente
ingresoIndividual	Int	Ingreso individual del cliente
profesion	String	Profesión del cliente
fechaCreacion	Datetime	Fecha de creación del cliente
fechaEdicion	Datetime	Fecha de edición del cliente
dni	String	DNI del cliente
direccion	String	Dirección del cliente

Ejemplo respuesta

{
  "id": 0,
  "tipo": "string",
  "nombre": "string",
  "apellidoPaterno": "string",
  "apellidoMaterno": "string",
  "edad": 0,
  "departamento": "string",
  "provincia": "string",
  "distrito": "string",
  "celular": "string",
  "telefono": "string",
  "email": "user@example.com",
  "estadoCivil": "string",
  "ingresoFamiliar": 0,
  "ingresoIndividual": 0,
  "profesion": "string",
  "fechaCreacion": "0000-00-00T00:00:00.000Z",
  "fechaEdicion": "0000-00-00T00:00:00.000Z",
  "dni": "string",
  "direccion": "string"
}

PUT /clientes/naturales/{id}

Servicio proporcionado para editar la información de un cliente natural.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del cliente natural a modificar
cliente	JSON	{ "identificadorPersonal": 0, "digitoVerificador": "string", "nombre": "string", "apellidoPaterno": "string", "apellidoMaterno": "string", "celular": "string", "email": "user@example.com" }

Datos de salida:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del cliente
nombre	String	Glosa del cliente
apellidoPaterno	String	Apellido paterno del cliente
apellidoMaterno	String	Apellido materno del cliente
edad	String	Edad del cliente
departamento	String	Región en la cual reside el cliente
provincia	String	Provincia en la cual reside el cliente
distrito	String	Distrito en el cual reside el cliente
celular	String	Numero de celular del cliente
telefono	String	Numero de teléfono del cliente
email	String	Email de contacto del cliente
estadoCivil	String	Estado civil del cliente
ingresoFamiliar	String	Ingreso familiar del cliente
ingresoIndividual	Int	Ingreso individual del cliente
profesion	String	Profesión del cliente
fechaCreacion	Datetime	Fecha de creación del cliente
fechaEdicion	Datetime	Fecha de edición del cliente
dni	String	DNI del cliente
direccion	String	Dirección del cliente

Ejemplo respuesta

{
  "id": 0,
  "nombre": "string",
  "apellidoPaterno": "string",
  "apellidoMaterno": "string",
  "edad": 0,
  "departamento": "string",
  "provincia": "string",
  "distrito": "string",
  "celular": "string",
  "telefono": "string",
  "email": "user@example.com",
  "estadoCivil": "string",
  "ingresoFamiliar": 0,
  "ingresoIndividual": 0,
  "profesion": "string",
  "fechaCreacion": "0000-00-00T00:00:00.000Z",
  "fechaEdicion": "0000-00-00T00:00:00.000Z",
  "dni": "string",
  "direccion": "string"
}

GET /clientes/juridicos

Servicio proporcionado para obtener información de un cliente jurídico.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
identificador-personal	Int	Identificador personal del cliente

Datos de salida:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del cliente
ruc	String	Ruc del cliente
razonSocial	String	Razón social del cliente
giro	String	Giro del cliente
departamento	String	Región donde reside el cliente
provincia	String	Provincia donde reside el cliente
distrito	String	Distrito donde reside el cliente
telefono	String	Teléfono de contacto del cliente
email	String	Email de contacto del cliente
fechaCreacion	Datetime	Fecha de creación del cliente
fechaEdicion	Datetime	Fecha de edición del cliente
direccion	String	Dirección del cliente
representanteLegal	Object
dni	String	DNI del representante legal
nombre	String	Nombre del representante legal
apellidos	String	Apellidos del representante legal
celular	String	Celular de contacto del representante legal
telefono	String	Teléfono de contacto del representante legal
email	String	Email de contacto del representante legal
direccion	String	Dirección del representante legal

Ejemplo respuesta

{
  "id": 0,
  "ruc": 0,
  "razonSocial": "string",
  "giro": "string",
  "departamento": "string",
  "provincia": "string",
  "distrito": "string",
  "telefono": "string",
  "email": "user@example.com",
  "fechaCreacion": "2023-05-02T14:53:50.372Z",
  "fechaEdicion": "2023-05-02T14:53:50.372Z",
  "direccion": "string",
  "representanteLegal": {
    "dni": "string",
    "nombres": "string",
    "apellidos": "string",
    "celular": "string",
    "telefono": "string",
    "email": "string",
    "direccion": "string"
  }
}

PUT /clientes/juridicos/{id}

Servicio proporcionado para editar la información de un cliente jurídico.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del cliente jurídico a modificar
cliente	JSON	{ "identificadorPersonal": 0, "digitoVerificador": "string", "razonSocial": "string", "telefono": "string", "email": "user@example.com" }

Datos de salida:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del cliente
ruc	String	Ruc del cliente
razonSocial	String	Razón social del cliente
giro	String	Giro del cliente
departamento	String	Región donde reside el cliente
provincia	String	Provincia donde reside el cliente
distrito	String	Distrito donde reside el cliente
telefono	String	Teléfono de contacto del cliente
email	String	Email de contacto del cliente
fechaCreacion	Datetime	Fecha de creación del cliente
fechaEdicion	Datetime	Fecha de edición del cliente
direccion	String	Dirección del cliente
representanteLegal	Object
dni	String	DNI del representante legal
nombre	String	Nombre del representante legal
apellidos	String	Apellidos del representante legal
celular	String	Celular de contacto del representante legal
telefono	String	Teléfono de contacto del representante legal
email	String	Email de contacto del representante legal
direccion	String	Dirección del representante legal

Ejemplo respuesta

{
  "id": 0,
  "ruc": 0,
  "razonSocial": "string",
  "giro": "string",
  "departamento": "string",
  "provincia": "string",
  "distrito": "string",
  "telefono": "string",
  "email": "user@example.com",
  "fechaCreacion": "0000-00-00T00:00:00.000Z",
  "fechaEdicion": "0000-00-00T00:00:00.000Z",
  "direccion": "string",
  "representanteLegal": {
    "dni": "string",
    "nombres": "string",
    "apellidos": "string",
    "celular": "string",
    "telefono": "string",
    "email": "string",
    "direccion": "string"
  }
}

POST /cotizaciones

Servicio orientado a crear una cotización.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
cotizacion	JSON	[ { "productoPrincipal": { "id": 0, "descuento": { "valor": 0, "unidad": "%" } }, "productosSecundarios": [ { "id": 0, "descuento": { "valor": 0, "unidad": "%" } } ], "productosAdicionales": [ { "id": 0, "descuento": { "valor": 0, "unidad": "%" } } ], "idCliente": 0, "idTipoIVA": 0, "fecha": "0000-00-00T00:00:00.000Z", "idMedioLlegada": 0, "telefonoValidado": true, "evaluacion": { "idExpectativa": 0, "idRazonDeCompra": 0, "fechaRecontacto": "string", "comentario": "string", "idCanalADistancia": 0 }, "utm": { "source": "string", "medium": "string", "campaign": "string", "term": "string", "content": "string" }, "gclid": "string" } ]

Datos de salida:

Atributo	Tipo Dato	Descripción
idProductoPrincipal	Int	Identificador único del producto principal
hasError	Boolean	Valida si existe un error
error	String	Descripción del error
hashCotizacion	String	Hash de la cotización
id_cotizacion	Int	Identificador único de la cotización

Ejemplo respuesta

{
  "idProductoPrincipal": 0,
  "hasError": true,
  "error": "string",
  "hashCotizacion": "string",
  "id_cotizacion": 0
}

GET /cotizaciones/{idCotizacion}

Servicio orientado a entregar información de una cotización a través de su identificador único.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
idCotizacion	Int	Identificador único de la cotización

Datos de salida en cada objeto de producto adicional:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de la cotización
productoPrincipal	Object
id	Int	Identificador único del producto principal
glosa	String	Glosa del producto principal
programa	String	Programa del producto
piso	String	Cantidad pisos del producto
orientacion	String	Orientación del producto
activoWeb	Boolean	Muestra si el producto esta activo en la web
supInterior	Int	Calculo de la superficie interior
supTerraza	Int	Calculo de la superficie de la terraza
superficieUtil	Int	Calculo de la superficie útil
proyecto	Object
id	Int	Identificador único del proyecto
glosa	String
etapa	Object
id	Int	Identificador único de la etapa
glosa	String	Glosa de la etapa
subagrupacion	Object
id	Int	Identificador único de la subagrupacion
glosa	String	Glosa de la subagrupacion
modelo	Object
id	Int	Identificador único del modelo
glosa	String	Glosa del modelo
fechaCreacion	Datetime	Fecha de creación del producto
estado	String	Estado del producto
productosSecundarios
id	Int	Identificador único del producto secundario
tipo	String	Tipo del producto (Ej: Bodega, Estacionamiento)
glosa	String	Glosa del producto secundario
piso	String	Piso en el cual se localiza el producto
proyecto	Object
id	Int	Identificador único del proyecto
glosa	String
etapa	Object
id	Int	Identificador único de la etapa
glosa	String	Glosa de la etapa
subagrupacion	Object
id	Int	Identificador único de la subagrupacion
glosa	String	Glosa de la subagrupacion
fechaCrecion	Datetime	Fecha de creación del producto
estado	String	Estado del producto (Reservado, Promesado)

Ejemplo respuesta

{
  "id": 0,
  "productoPrincipal": {
    "id": 0,
    "glosa": "string",
    "programa": "string",
    "piso": 0,
    "orientacion": "string",
    "activoWeb": 0,
    "supInterior": 0,
    "supTerraza": 0,
    "superficeUtil": 0,
    "proyecto": {
      "id": 0,
      "glosa": "string"
    },
    "etapa": {
      "id": 0,
      "glosa": "string"
    },
    "subagrupacion": {
      "id": 0,
      "glosa": "string"
    },
    "modelo": {
      "id": 0,
      "glosa": "string"
    },
    "fechaCreacion": "2023-05-17T16:09:30.955Z",
    "estado": "Disponible"
  },
  "productosSecundarios": [
    {
      "id": 0,
      "tipo": "string",
      "glosa": "string",
      "piso": "string",
      "proyecto": {
        "id": 0,
        "glosa": "string"
      },
      "etapa": {
        "id": 0,
        "glosa": "string"
      },
      "subagrupacion": {
        "id": 0,
        "glosa": "string"
      },
      "fechaCreacion": "2023-05-17T16:09:30.955Z",
      "estado": "Disponible"
    }
  ]
}

GET /cotizaciones/vendedor-by-id-cotizacion

Servicio orientado a entregar información de un vendedor de una cotización.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
idCotizacion	Int	Identificador único de la cotización

Datos de salida:

Atributo	Tipo Dato	Descripción
rut_largo	String	Rut del vendedor con digito verificador
rut_corto	String	Rut del vendedor sin digito verificador
dv	String	Digito verificador
nombre	String	Nombre del vendedor
apellido_paterno	String	Apellido paterno del vendedor
apellido_materno	String	Apellido materno del vendedor
telefono	String	Teléfono del vendedor
email	String	Email del vendedor

Ejemplo respuesta

{
  "rut_largo": "string",
  "rut_corto": 0,
  "dv": "string",
  "nombre": "string",
  "apellido_paterno": "string",
  "apellido_materno": "string",
  "telefono": "string",
  "email": "string"
}

GET /datos-forma-pago

Servicio orientado a entregar información de la forma de pago de un cliente.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
rutDNI	String	Rut o DNI del cliente
idProyecto	Int	Identificador único de la cotización

Datos de salida por cada negocio:

Atributo	Tipo Dato	Descripción
proyecto	Object
codigoConvenioPagoOtrosPagos	String	Código del convenio de pago con otros pagos
idProyecto	Int	Identificador único del proyecto
glosaProyecto	String	Glosa del proyecto
idNegocio	Int	Identificador único del negocio
promesa	Object
id	Int	Identificador único de la promesa
estado	String	Estado de la promesa
totalPrecioLista	Int	Total del precio lista de la promesa
descUFPrecioLista	Int	Descuento en UF del precio lista de la promesa
descPorcentPrecioLista	Int	Porcentaje de descuento del precio lista de la promesa
descuentoUF	Int	Descuento en UF de la promesa
descuentoPorcent	Int	Porcentaje de descuento de la promesa
subTotal	Int	Subtotal de la promesa
total	Int	Total de la promesa
productoPrincipal	Object
id	Int	Identificador único del producto principal
nombre	String	Glosa del producto principal
tipo	String	Tipo de producto del producto principal
precio	Int	Precio del producto principal
precioLista	Int	Precio lista del producto principal
descUF	Int	Descuento en UF del producto principal
descPorcent	Int	Porcentaje de descuento del producto principal
productosSecundarios	Array[Object]
id	Int	Identificador único del producto secundario
nombre	String	Glosa del producto secundario
tipo	String	Tipo de producto del producto secundario
precio	Int	Precio del producto secundario
precioLista	Int	Precio lista del producto secundario
descPorcent	Int	Porcentaje de descuento del producto secundario
descUF	Int	Descuento en UF del producto secundario
cuotas	Array[Object]
id	Int	Identificador único de la cuota
numero	String	Numero de la cuota
codigoTipoCuota	String	Código del tipo de cuota
montoUF	Int	Monto en UF de la cuota
montoPesos	Int	Monto en pesos de la cuota
pagadoUF	Int	Total pagado en UF de la cuota
pagadoPesos	Int	Total pagado en pesos dela cuota
fechaVencimiento	Datetime	Fecha de vencimiento de la cuota
estado	String	Estado de la cuota
pagos	Array[Object]
id	Int	Identificador único del pago
monto	Int	Monto del pago
fecha	Datetime	Fecha del pago
tipoDocumento	String	Tipo de documento
estadoDocumento	String	Estado del documento

Ejemplo respuesta

{
  "negocios": [
    {
      "proyecto": {
        "codigoConvenioPagoOtrosPagos": "string",
        "idProyecto": 0,
        "glosaProyecto": "string"
      },
      "promesa": {
        "id": 0,
        "estado": "CREADA",
        "totalPrecioLista": 0,
        "descUFPrecioLista": 0,
        "descPorcentPrecioLista": 0,
        "descuentoUF": 0,
        "descuentoPorcent": 0,
        "subTotal": 0,
        "total": 0
      },
      "productoPrincipal": {
        "id": 0,
        "nombre": "string",
        "tipo": "string",
        "precio": 0,
        "precioLista": 0,
        "descUF": 0,
        "descPorcent": 0
      },
      "productosSecundarios": [
        {
          "id": 0,
          "nombre": "string",
          "tipo": "string",
          "precio": 0,
          "precioListo": 0,
          "descPorcent": 0,
          "descUF": 0
        }
      ],
      "cuotas": [
        {
          "id": 0,
          "numero": "string",
          "codigoTipoCuota": "string",
          "montoUF": 0,
          "montoPesos": 0,
          "pagadoUF": 0,
          "pagadoPesos": 0,
          "fechaVencimiento": "0000-00-00T00:00:00.000Z",
          "estado": "Sin Documentar",
          "pagos": [
            {
              "id": 0,
              "monto": 0,
              "fecha": "0000-00-00T00:00:00.000Z",
              "tipoDocumento": "string",
              "estadoDocumento": "Pendiente"
            }
          ]
        }
      ]
    }
  ]
}

GET /datos-forma-pago-reserva

Servicio orientado a entregar información de la forma de pago de un cliente en base a la reserva.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
rutDNI	String	Rut o DNI del cliente
idProyecto	Int	Identificador único del proyecto

Datos de salida por cada negocio:

Atributo	Tipo Dato	Descripción
proyecto	Object
codigoConvenioPagoOtrosPagos	String	Código del convenio de pago con otros pagos
idProyecto	Int	Identificador único del proyecto
glosaProyecto	String	Glosa del proyecto
idNegocio	Int	Identificador único del negocio
reserva	Object
id	Int	Identificador único de la reserva
estado	String	Estado de la reserva
totalPrecioLista	Int	Total del precio lista de la reserva
descUFPrecioLista	Int	Descuento en UF del precio lista de la reserva
descPorcentPrecioLista	Int	Porcentaje de descuento del precio lista de la reserva
descuentoUF	Int	Descuento en UF de la reserva
descuentoPorcent	Int	Porcentaje de descuento de la reserva
subTotal	Int	Subtotal de la reserva
total	Int	Total de la reserva
productoPrincipal	Object
id	Int	Identificador único del producto principal
nombre	String	Glosa del producto principal
tipo	String	Tipo de producto del producto principal
precio	Int	Precio del producto principal
precioLista	Int	Precio lista del producto principal
descUF	Int	Descuento en UF del producto principal
descPorcent	Int	Porcentaje de descuento del producto principal
productosSecundarios	Array[Object]
id	Int	Identificador único del producto secundario
nombre	String	Glosa del producto secundario
tipo	String	Tipo de producto del producto secundario
precio	Int	Precio del producto secundario
precioLista	Int	Precio lista del producto secundario
descPorcent	Int	Porcentaje de descuento del producto secundario
descUF	Int	Descuento en UF del producto secundario
cuotas	Array[Object]
id	Int	Identificador único de la cuota
numero	String	Numero de la cuota
codigoTipoCuota	String	Código del tipo de cuota
montoUF	Int	Monto en UF de la cuota
montoPesos	Int	Monto en pesos de la cuota
pagadoUF	Int	Total pagado en UF de la cuota
pagadoPesos	Int	Total pagado en pesos dela cuota
fechaVencimiento	Datetime	Fecha de vencimiento de la cuota
estado	String	Estado de la cuota
pagos	Array[Object]
id	Int	Identificador único del pago
monto	Int	Monto del pago
fecha	Datetime	Fecha del pago
tipoDocumento	String	Tipo de documento
estadoDocumento	String	Estado del documento

Ejemplo respuesta

{
  "negocios": [
    {
      "proyecto": {
        "codigoConvenioPagoOtrosPagos": "string",
        "idProyecto": 0,
        "glosaProyecto": "string"
      },
      "promesa": {
        "id": 0,
        "estado": "CREADA",
        "totalPrecioLista": 0,
        "descUFPrecioLista": 0,
        "descPorcentPrecioLista": 0,
        "descuentoUF": 0,
        "descuentoPorcent": 0,
        "subTotal": 0,
        "total": 0
      },
      "productoPrincipal": {
        "id": 0,
        "nombre": "string",
        "tipo": "string",
        "precio": 0,
        "precioLista": 0,
        "descUF": 0,
        "descPorcent": 0
      },
      "productosSecundarios": [
        {
          "id": 0,
          "nombre": "string",
          "tipo": "string",
          "precio": 0,
          "precioListo": 0,
          "descPorcent": 0,
          "descUF": 0
        }
      ],
      "cuotas": [
        {
          "id": 0,
          "numero": "string",
          "codigoTipoCuota": "string",
          "montoUF": 0,
          "montoPesos": 0,
          "pagadoUF": 0,
          "pagadoPesos": 0,
          "fechaVencimiento": "0000-00-00T00:00:00.000Z",
          "estado": "Sin Documentar",
          "pagos": [
            {
              "id": 0,
              "monto": 0,
              "fecha": "0000-00-00T00:00:00.000Z",
              "tipoDocumento": "string",
              "estadoDocumento": "Pendiente"
            }
          ]
        }
      ]
    }
  ]
}

GET /ciudades/{id}/region

Servicio orientado a entregar información de las regiones de una ciudad.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de la ciudad

Datos de salida por cada negocio:

Atributo	Tipo Dato	Descripción
idRegion	Int	Identificador único de la región
glosaRegion	String	Glosa de la region
idCiudad	Int	Identificador único de la ciudad
glosaCiudad	String	Glosa de la ciudad

Ejemplo respuesta

{
  "idRegion": 0,
  "glosaRegion": "string",
  "numRomano": "string",
  "idCiudad": 0,
  "glosaCiudad": "string"
}

GET /negocios

Servicio orientado a entregar información de los negocios en relación a un producto principal (glosa).

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
productos.nombres	String	Glosas de productos principales separados por coma

Existe la posibilidad de consultar por una sola glosa, o por más de una, separando las glosas por coma. Ej. (ECG-1007, KLW-564, THF-202).

Datos de salida en cada objeto de negocio:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de Negocio asociado al producto principal requerido
estado	String (Disponible, Reservado, Promesado, Escriturado).	Estado de negocio en el que se encuentra el negocio
nombreProductoPrincipal	String	Glosa del producto principal

Ejemplo respuesta

[
  {
    "id": 0,
    "nombre": "string",
    "nombreProductoPrincipal": "string"
  }
]

GET /negocios/{id}/reservas

Servicio orientado a entrega información de una reserva con respecto a su identificador único de negocio (id_negocio).

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de negocio

Existe la posibilidad de consultar por un solo identificador, o por más de uno, separando los identificadores por coma. Ej. (187, 234, 277).

Datos de salida:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de reserva
fechaReserva	Date	Fecha en la cual se produjo la reserva
totalLista	Float	Precio total lista de la reserva
descuentoSubtotal	Object
valor	Float	Valor del descuento al subtotal de la reserva
unidad	String (UF, %)	Unidad del descuento al subtotal de la reserva
totalVenta	Float	Precio total de la reserva
productos	Array[Object]
id	Int	Identificador único del producto
nombre	String	Glosa de producto
tipo	String (Principal, Secundario)	Tipo de producto
precioLista	Float	Precio lista del producto
descuento	Object
valor	Float	Valor de descuento del producto
unidad	String (UF, %))	Unidad del descuento del producto
precioVenta	Float	Precio venta del producto
proyecto	Object
id		Identificador único de proyecto
nombre	String	Proyecto al cual pertenece el producto
etapa	Object
id		Identificador único de etapa
nombre	String	Etapa a la cual pertenece el producto
subAgrupacion	Object
id		Identificador único de subagrupación
nombre	String	Subagrupación a la cual pertenece el producto
cliente	Object
id		Identificador único de cliente
identificadorPersonal	String	Rut de cliente
nombre	String	Nombre completo de cliente
telefono	String	Teléfono de cliente
email	String	Email de cliente

Nota: Se debe considerar que una reserva posee como mínimo 1 producto principal. A su vez, ésta puede considerar ninguno, uno o más productos secundarios, por lo que el total de productos asociados a la reserva podrían proyectarse como colecciones de productos.

Ejemplo respuesta

{
  "id": 0,
  "fechaReserva": "2023-05-02T20:05:56.892Z",
  "totalLista": 0,
  "descuentoSubtotal": {
    "valor": 0,
    "unidad": "%"
  },
  "totalVenta": 0,
  "productos": [
    {
      "id": 0,
      "nombre": "string",
      "tipo": "PRINCIPAL",
      "precioLista": 0,
      "descuento": {
        "valor": 0,
        "unidad": "%"
      },
      "precioVenta": 0,
      "proyecto": {
        "id": 0,
        "nombre": "string"
      },
      "etapa": {
        "id": 0,
        "nombre": "string"
      },
      "subAgrupacion": {
        "id": 0,
        "nombre": "string"
      }
    }
  ],
  "cliente": {
    "id": 0,
    "identificadorPersonal": "string",
    "nombre": "string",
    "telefono": "string",
    "email": "user@example.com"
  }
}

GET /negocios/{id}/promesas

Servicio orientado a entrega información de una promesa con respecto a su identificador único de negocio (id_negocio).

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del negocio

Datos de salida:

Atributo	Tipo Dato	Descripción
id	Int	Mensaje de respuesta exitosa
fechaPromesa	Datetime	Fecha de creación de la promesa
totalLista	Int	Total lista de la promesa
descuentoSubtotal	Object
valor	Int	Valor del descuento
unidad	String	Unidad del descuento
totalVenta	Int	Total venta de la promesa
productos	Array[Object]
id	Int	Identificador único del producto
nombre	String	Glosa del producto
tipo	String	Tipo producto
precioLista	Int	Precio lista del producto
descuento	Object
valor	Int	Valor del descuento
unidad	String	Unidad del descuento
precioVenta	Int	Precio venta del producto
proyecto	Object
id	Int	Identificador único del proyecto
nombre	String	Glosa del proyecto
etapa	Object
id	Int	Identificador único de la etapa
nombre	String	Glosa de la etapa
subAgrupacion	Object
id	Int	Identificador único de la su agrupación
nombre	String	Glosa de la su agrupación
cliente	Object
id	Int	Identificador único del cliente
identificadorPersonal	String	Identificador personal del cliente
nombre	String	Glosa del cliente
telefono	String	Teléfono de contacto del cliente
email	String	Email del cliente

Ejemplo respuesta

{
  "id": 0,
  "fechaPromesa": "2023-05-02T21:49:25.913Z",
  "totalLista": 0,
  "descuentoSubtotal": {
    "valor": 0,
    "unidad": "%"
  },
  "totalVenta": 0,
  "productos": [
    {
      "id": 0,
      "nombre": "string",
      "tipo": "PRINCIPAL",
      "precioLista": 0,
      "descuento": {
        "valor": 0,
        "unidad": "%"
      },
      "precioVenta": 0,
      "proyecto": {
        "id": 0,
        "nombre": "string"
      },
      "etapa": {
        "id": 0,
        "nombre": "string"
      },
      "subAgrupacion": {
        "id": 0,
        "nombre": "string"
      }
    }
  ],
  "cliente": {
    "id": 0,
    "identificadorPersonal": "string",
    "nombre": "string",
    "telefono": "string",
    "email": "user@example.com"
  }
}

POST /negocios/{id}/modificar-promesa

Servicio orientado a modificar una promesa con respecto a su identificador único de negocio (id_negocio).

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del negocio
body	JSON	{ "fecha": "string" }

Datos de salida:

Atributo	Tipo Dato	Descripción
message	String	Mensaje de respuesta exitosa

Ejemplo respuesta

{
   "message": "string"
}

POST /negocios/{id}/modificar-cliente-reserva

Servicio orientado a modificar al cliente de una reserva con respecto a su identificador único de negocio (id_negocio).

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del negocio
body	JSON	{ "rut": 0, "tipoCompareciente": "CONYUGE" }

Datos de salida:

Atributo	Tipo Dato	Descripción
message	String	Mensaje de respuesta exitosa

Ejemplo respuesta

{
   "message": "string"
}

POST /negocios/{id}/modificar-cliente-promesa

Servicio orientado a modificar al cliente de una promesa con respecto a su identificador único de negocio (id_negocio).

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del negocio
body	JSON	{ "rut": 0, "tipoCompareciente": "CONYUGE" }

Datos de salida:

Atributo	Tipo Dato	Descripción
message	String	Mensaje de respuesta exitosa

Ejemplo respuesta

{
   "message": "string"
}

POST /negocios/{id}/agregar-producto-secundario-o-adicional-reserva

Servicio orientado a agregar productos secundarios o adicionales a una reserva con respecto a su identificador único de negocio (id_negocio).

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del negocio
body	JSON	{ "idProducto": 0, "tipoProducto": "Secundario", "descuento": { "valor": 0, "unidad": "%" } }

Datos de salida:

Atributo	Tipo Dato	Descripción
message	String	Mensaje de respuesta exitosa

Ejemplo respuesta

{
   "message": "string"
}

POST /negocios/{id}/eliminar-producto-secundario-o-adicional-reserva

Servicio orientado a eliminar productos secundarios o adicionales de una reserva con respecto a su identificador único de negocio (id_negocio).

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del negocio
body	JSON	{ "idProducto": 0, "tipoProducto": "Secundario" }

Datos de salida:

Atributo	Tipo Dato	Descripción
message	String	Mensaje de respuesta exitosa

Ejemplo respuesta

{
   "message": "string"
}

POST /negocios/{id}/modificar-producto-principal-reserva

Servicio orientado a modificar el producto principal de una reserva con respecto a su identificador único de negocio (id_negocio).

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del negocio
body	JSON	{ "idProducto": 0, "descuento": { "valor": 0, "unidad": "%" } }

Datos de salida:

Atributo	Tipo Dato	Descripción
message	String	Mensaje de respuesta exitosa

Ejemplo respuesta

{
   "message": "string"
}

POST /negocios/{id}/modificar-producto-principal-promesa

Servicio orientado a modificar el producto principal de una promesa con respecto a su identificador único de negocio (id_negocio).

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del negocio
body	JSON	{ "idProducto": 0, "descuento": { "valor": 0, "unidad": "%" } }

Datos de salida:

Atributo	Tipo Dato	Descripción
message	String	Mensaje de respuesta exitosa

Ejemplo respuesta

{
   "message": "string"
}

POST /negocios/{id}/agregar-producto-secundario-o-adicional-promesa

Servicio orientado a agregar un producto secundario o adicional a una promesa con respecto a su identificador único de negocio (id_negocio).

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del negocio
body	JSON	{ "idProducto": 0, "tipoProducto": "Secundario", "descuento": { "valor": 0, "unidad": "%" } }

Datos de salida:

Atributo	Tipo Dato	Descripción
message	String	Mensaje de respuesta exitosa

Ejemplo respuesta

{
   "message": "string"
}

POST /negocios/{id}/eliminar-producto-secundario-o-adicional-promesa

Servicio orientado a eliminar un producto secundario o adicional de un promesa con respecto a su identificador único de negocio (id_negocio).

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del negocio
body	JSON	{ "idProducto": 0, "tipoProducto": "Secundario" }

Datos de salida:

Atributo	Tipo Dato	Descripción
message	String	Mensaje de respuesta exitosa

Ejemplo respuesta

{
   "message": "string"
}

POST /negocios/{id}/reversar-escritura

Servicio orientado a reversar una escrituras con respecto a su identificador único de negocio (id_negocio).

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del negocio

Datos de salida:

Atributo	Tipo Dato	Descripción
message	String	Mensaje de respuesta exitosa

Ejemplo respuesta

{
   "message": "string"
}

GET /productos-principales

Servicio orientado a entregar información de los productos principales.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
nombres	Array [String]	Arreglo de nombres de productos principales

Datos de salida en cada objeto de productos principal:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del producto principal
nombre	String	Glosa del producto principal
nombreProyecto	String	Glosa del proyecto
nombreEtapa	String	Glosa de la etapa
nombreSubagrupacion	String	Glosa de la subagrupacion
nombreModelo	String	Glosa del modelo
precio	Int	Precio del producto
descuentoMaximo	Object
valor	Int	Valor del descuento
unidad	String (UF, %)	Unidad del descuento
piso	Int	Cantidad pisos del producto
orientacion	String	Orientación del producto
fechaCreacion	Datetime	Fecha de creación del producto
fechaEdicion	Datetime	Fecha de edición del producto
tipo_producto	String	Tipo de producto (Ej: Departamento, Oficina)
programa	String	Programa del producto
superficies	Object
terraza	Int	Calculo de la superficie de la terraza
interior	Int	Calculo de la superficie interior
util	Int	Calculo de la superficie útil
total	Int	Calculo de la superficie total
loggia	Int	Calculo de la superficie loggia
jardin	Int	Calculo de la superficie del jardin
miradorTerraza	Int	Calculo de la superficie del mirador de la terraza
otrasSuperficies	Int	Calculo de otras superficies
terreno	Int	Calculo de la superficie del terreno
disponibleWeb	Boolean	Muestra si el producto esta disponible en la web
disponibleSistema	Boolean	Muestra si el producto esta disponible en el sistema
estado	String	Estado del producto (Ej: Disponible, Reservado, Promesado)

Ejemplo respuesta

[
  {
    "id": 0,
    "nombre": "string",
    "nombreProyecto": "string",
    "nombreEtapa": "string",
    "nombreSubagrupacion": "string",
    "nombreModelo": "string",
    "precio": 0,
    "descuentoMaximo": {
      "valor": 0,
      "unidad": "%"
    },
    "piso": 0,
    "orientacion": "string",
    "fechaCreacion": "0000-00-00T00:00:00.000Z",
    "fechaEdicion": "0000-00-00T00:00:00.000Z",
    "tipo_producto": "string",
    "programa": "string",
    "superficies": {
      "terraza": 0,
      "interior": 0,
      "util": 0,
      "total": 0,
      "loggia": 0,
      "jardin": 0,
      "miradorTerraza": 0,
      "otrasSuperficies": 0,
      "terreno": 0
    },
    "disponibleWeb": true,
    "disponibleSistema": true,
    "estado": "Disponible"
  }
]

POST /promesa

Servicio orientado a crear una promesa.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
promesa	JSON	{ "idNegocio": 0, "fechaCreacion": "2023-05-03T14:59:31.196Z", "fechaFirmaCliente": "string", "fechaFirmaInmobiliaria": "string" }

Datos de salida:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de la promesa

Ejemplo respuesta

{
   "id": 0
}

GET /promesas/{idPromesa}

Servicio orientado a entregar información de una promesa.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
idPromesa	Int	Identificador único de la promesa

Datos de salida:

Atributo	Tipo Dato	Descripción
id	Int	Mensaje de respuesta exitosa
fechaPromesa	Datetime	Fecha de creación de la promesa
totalLista	Int	Total lista de la promesa
descuentoSubtotal	Object
valor	Int	Valor del descuento
unidad	String	Unidad del descuento
totalVenta	Int	Total venta de la promesa
productos	Array[Object]
id	Int	Identificador único del producto
nombre	String	Glosa del producto
tipo	String	Tipo producto
precioLista	Int	Precio lista del producto
descuento	Object
valor	Int	Valor del descuento
unidad	String	Unidad del descuento
precioVenta	Int	Precio venta del producto
proyecto	Object
id	Int	Identificador único del proyecto
nombre	String	Glosa del proyecto
etapa	Object
id	Int	Identificador único de la etapa
nombre	String	Glosa de la etapa
subAgrupacion	Object
id	Int	Identificador único de la su agrupación
nombre	String	Glosa de la su agrupación
cliente	Object
id	Int	Identificador único del cliente
identificadorPersonal	String	Identificador personal del cliente
nombre	String	Glosa del cliente
telefono	String	Teléfono de contacto del cliente
email	String	Email del cliente

Ejemplo respuesta

{
  "id": 0,
  "fechaPromesa": "2023-05-02T21:49:25.913Z",
  "totalLista": 0,
  "descuentoSubtotal": {
    "valor": 0,
    "unidad": "%"
  },
  "totalVenta": 0,
  "productos": [
    {
      "id": 0,
      "nombre": "string",
      "tipo": "PRINCIPAL",
      "precioLista": 0,
      "descuento": {
        "valor": 0,
        "unidad": "%"
      },
      "precioVenta": 0,
      "proyecto": {
        "id": 0,
        "nombre": "string"
      },
      "etapa": {
        "id": 0,
        "nombre": "string"
      },
      "subAgrupacion": {
        "id": 0,
        "nombre": "string"
      }
    }
  ],
  "cliente": {
    "id": 0,
    "identificadorPersonal": "string",
    "nombre": "string",
    "telefono": "string",
    "email": "user@example.com"
  }
}

POST /promesas/cancelar

Servicio orientado a cancelar una promesa.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
promesa	JSON	{ "idNegocio": 0, "idTipoCancelacion": 0, "descripcion": "string" }

Datos de salida:

Atributo	Tipo Dato	Descripción
message	String	Mensaje de respuesta exitosa

Ejemplo respuesta

{
   "message": "string"
}

GET /promesas/fecha-inmobiliaria

Servicio orientado a entregar información de promesas ordenadas por la fecha de inmobiliaria.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
fechaInicio	Date (YYYY-MM-DD)	Fecha de inmobiliaria inicial desde la cual se necesita filtrar
fechaFin	Date (YYYY-MM-DD)	Fecha de inmobiliaria final desde la cual se necesita filtrar

Datos de salida por cada objeto de promesa:

Atributo	Tipo Dato	Descripción
id_promesa	Int	Identificador único de la promesa
id_negocio	Int	Identificador único del negocio
fecha_inmobiliaria	Date	Fecha de la inmobiliaria
setFechaInmobilairia	Datetime	Fecha de la inmobiliaria en formato fecha mas hora

Ejemplo respuesta

[
  {
    "id_promesa": "string",
    "id_negocio": "string",
    "fecha_inmobiliaria": "string",
    "setFechaInmobiliaria": "0000-00-00T00:00:00.000Z"
  }
]

GET /promesas/fecha-firma-comprador

Servicio orientado a entregar información de promesas ordenadas por la fecha de firma comprador.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
fechaInicio	Date (YYYY-MM-DD)	Fecha de firma comprador inicial desde la cual se necesita filtrar
fechaFin	Date (YYYY-MM-DD)	Fecha de firma comprador final desde la cual se necesita filtrar

Datos de salida por cada objeto de promesa:

Atributo	Tipo Dato	Descripción
id_promesa	Int	Identificador único de la promesa
id_negocio	Int	Identificador único del negocio
fecha_firma_comprador	Date	Fecha de firma del comprador
setFechaFirmaComprador	Datetime	Fecha de firma del comprador en formato fecha mas hora

Ejemplo respuesta

[
  {
    "id_promesa": "string",
    "id_negocio": "string",
    "fecha_firma_comprador": "string",
    "setFechaFirmaComprador": "0000-00-00T00:00:00.000Z"
  }
]

GET /promesas/canceladas

Servicio orientado a entregar información de promesas ordenadas por la fecha de cancelación.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
fechaInicio	Date (YYYY-MM-DD)	Fecha de cancelación inicial desde la cual se necesita filtrar
fechaFin	Date (YYYY-MM-DD)	Fecha de cancelación final desde la cual se necesita filtrar

Datos de salida por cada objeto de promesa:

Atributo	Tipo Dato	Descripción
id_promesa	Int	Identificador único de la promesa
id_negocio	Int	Identificador único del negocio
fecha_cancelacion	Datetime	Fecha de cancelación
accion	String	Tipo de cancelación

Ejemplo respuesta

[
  {
    "id_promesa": "string",
    "id_negocio": "string",
    "fecha_cancelacion": "0000-00-00T00:00:00.000Z",
    "accion": "string"
  }
]

POST /escritura

Servicio utilizado para crear las escrituras en base a las promesas ya existentes en el sistema GCI.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
idNegocio	Int	Identificador único del negocio
fechaEscritura	Date	Fecha relacionada a la fecha firma cliente en notaría

Datos de salida:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de escritura

Ejemplo respuesta

{
  "id": 0
}

GET /reservas

Servicio orientado a desplegar información asociadas a todas las reservas existentes asociadas a un proyecto.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
fechaInicio	Date (YYYY-MM-DD)	Fecha de creación de reserva inicial desde la cual se necesita filtrar
fechaFin	Date (YYYY-MM-DD)	Fecha de creación de reserva final desde la cual se necesita filtrar

Datos de salida:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único de reserva
idNegocio	Int	Identificador único del negocio
fechaReserva	Date	Fecha en la cual se produjo la reserva
aprobada	Boolean	Valida si la reserva esta aprobada
totalLista	Float	Precio total lista de la reserva
descuentoSubtotal	Object
valor	Float	Valor del descuento al subtotal de la reserva
unidad	String (UF, %)	Unidad del descuento al subtotal de la reserva
totalVenta	Float	Precio total de la reserva
estado	String	Estado de la reserva
rutVendedor	String	Rut del vendedor
destinoAnexo	Int	Identificador único de la reserva de la reserva de destino de modificación
productos	Array[Object]
id	Int	Identificador único del producto
nombre	String	Glosa de producto
tipo	String (Principal, Secundario)	Tipo de producto
precioLista	Float	Precio lista del producto
descuento	Object
valor	Float	Valor de descuento del producto
unidad	String (UF, %))	Unidad del descuento del producto
precioVenta	Float	Precio venta del producto
proyecto	Object
id	Int	Identificador único de proyecto
nombre	String	Proyecto al cual pertenece el producto
etapa	Object
id	Int	Identificador único de etapa
nombre	String	Etapa a la cual pertenece el producto
subAgrupacion	Object
id	Int	Identificador único de subagrupación
nombre	String	Subagrupación a la cual pertenece el producto
cliente	Object
id	Int	Identificador único de cliente
identificadorPersonal	String	Rut de cliente
nombre	String	Nombre completo de cliente
telefono	String	Teléfono de cliente
email	String	Email de cliente

Ejemplo respuesta

[
  {
    "id": 0,
    "idNegocio": 0,
    "fechaReserva": "0000-00-00T00:00:00.000Z",
    "aprobada": true,
    "totalLista": 0,
    "descuentoSubtotal": {
      "valor": 0,
      "unidad": "string"
    },
    "totalVenta": 0,
    "estado": "CREADA",
    "rutVendedor": 0,
    "destinoAnexo": 0,
    "productos": [
      {
        "id": 0,
        "nombre": "string",
        "tipo": "PRINCIPAL",
        "precioLista": 0,
        "descuento": {
          "valor": 0,
          "unidad": "%"
        },
        "precioVenta": 0,
        "proyecto": {
          "id": 0,
          "nombre": "string"
        },
        "etapa": {
          "id": 0,
          "nombre": "string"
        },
        "subAgrupacion": {
          "id": 0,
          "nombre": "string"
        }
      }
    ],
    "cliente": {
      "id": 0,
      "identificadorPersonal": "string",
      "nombre": "string",
      "telefono": "string",
      "email": "user@example.com"
    }
  }
]

POST /reservas/cancelar

Servicio orientado a la cancelación de una reserva ya emitida en sistema GCI.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
idNegocio	Int	Identificador único del negocio
idTipoCancelacion	Int	Tipo de cancelación de la reserva
motivoCancelacion	String	Comentario del motivo de cancelación de la reserva
fecha	Datetime	Fecha de cancelación de la reserva

Datos de salida:

Atributo	Tipo Dato	Descripción
message	String	Mensaje de resultado de operación

Ejemplo respuesta

{
  "message": "string"
}

POST /producto-principal/{id}/bloquear

Servicio orientado a bloquear un producto principal mediante su identificador único.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
id	Int	Identificador único del producto principal

Datos de salida:

Atributo	Tipo Dato	Descripción
message	String	Mensaje de resultado de operación

Ejemplo respuesta

{
  "message": "string"
}

GET /seguimientos

Servicio orientado a entregar información sobre seguimientos.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
fechaDesde	Date (YYYY-MM-DD)	Fecha de creación del seguimiento inicial desde la cual se necesita filtrar
fechaHasta	Date (YYYY-MM-DD)	Fecha de creación del seguimiento final desde la cual se necesita filtrar
identificador	String	Tipo de identificador del cliente a buscar (rut/dni o id cliente)
valorIdentificador	String	Valor del tipo de identificador ingresado (Si es rut, este se debe ingresar sin guion y digito verificador)
idProyecto	Int	Identificador único del proyecto
ejecutivo	String	Rut del ejecutivo (Rut sin guion ni digito verificador)

Datos de salida:

Atributo	Tipo Dato	Descripción
id_evaluacion	Int	Identificador único de la evaluación
id_seguimiento	Int	Identificador único del seguimiento
id_cliente	Int	Identificador único del cliente
rut_largo_cliente	String	Rut completo del cliente
rut_corto_cliente	String	Rut sin guion ni digito verificador
dv_rut_cliente	String	Digito verificador del cliente
id_proyecto	Int	Identificador único del proyecto
nombre_proyecto	String	Glosa del proyecto
fecha	Datetime	Fecha creación del seguimiento
fecha_recontacto	Datetime	Fecha de recontacto
tipo_contacto	String	Tipo de contacto el cual se utiliza para contactar al cliente
expectativa	String	Expectativa sobre el cliente
comentario	String	Comentario escrito por el ejecutivo
nombre_ejecutivo	String	Nombre del ejecutivo
apellido_paterno_ejecutivo	String	Apellido paterno del ejecutivo
apellido_materno_ejecutivo	String	Apellido materno del ejecutivo
rut_ejecutivo	String	Rut del ejecutivo
correo_ejecutivo	String	Correo de contacto del ejecutivo
fono_ejecutivo	String	Fono de contacto del ejecutivo
probabilidad_compra	String	Probabilidad de compra
estado	String	Estado del seguimiento

Ejemplo respuesta

[
  {
    "id_evaluacion": 0,
    "id_seguimiento": 0,
    "id_cliente": 0,
    "rut_largo_cliente": "string",
    "rut_corto_cliente": 0,
    "dv_rut_cliente": 0,
    "id_proyecto": 0,
    "nombre_proyecto": "string",
    "fecha": "0000-00-00T00:00:00.000Z",
    "fecha_recontacto": "0000-00-00T00:00:00.000Z",
    "tipo_contacto": "string",
    "expectativa": "string",
    "comentario": "string",
    "nombre_ejecutivo": "string",
    "apellido_paterno_ejecutivo": "string",
    "apellido_materno_ejecutivo": "string",
    "rut_ejecutivo": 0,
    "correo_ejecutivo": "string",
    "fono_ejecutivo": "string",
    "probabilidad_compra": "string",
    "estado": "string"
  }
]

POST /seguimientos

Servicio orientado a crear seguimientos.

Parámetros de entrada:

Atributo	Tipo Dato	Descripción
crearSeguimiento	JSON	{ "id_cliente": 0, "id_proyecto": 0, "id_medio": 0, "id_tipo_contacto": 0, "id_expectativa": 0, "comentario": "string", "fecha_recontacto": "000-00-00T00:00:00.000Z", "mantenerEjecutivo": false }

Datos de salida:

Atributo	Tipo Dato	Descripción
idSeguimiento	Int	Identificador único del seguimiento

Ejemplo respuesta

{
  0
}

API Rest GCI

GET /inmobiliarias

POST /login

GET /documentos

GET /proyectos

GET /proyectos/{id}/etapas

GET /proyectos/{id}/mediosDeLlegada

GET /proyectos/{id}/modelos

GET /proyectos/{id}/productos-secundarios

GET /proyectos/{id}/productos-adicionales

GET /proyectos/nombre/{nombre}/reserva

GET /etapas/{id}/subagrupaciones

GET /etapa/{id}/productos-secundarios

GET /modelos/{modeloId}/imagenes/{id}

GET /modelos/{id}/productos-principales

GET /subagrupaciones/{id}/productos-secundarios

GET /subagrupaciones/{id}/productos-adicionales

GET /packs

GET /clientes/naturales/cotizaciones/{rut_dni}

GET /leads

PATCH /leads

POST /clientes/documento

GET /clientes/vendedor-by-cliente

GET /clientes/naturales

POST /clientes/naturales

PUT /clientes/naturales/{id}

GET /clientes/juridicos

PUT /clientes/juridicos/{id}

POST /cotizaciones

GET /cotizaciones/{idCotizacion}

GET /cotizaciones/vendedor-by-id-cotizacion

GET /datos-forma-pago

GET /datos-forma-pago-reserva

GET /ciudades/{id}/region

GET /negocios

GET /negocios/{id}/reservas

GET /negocios/{id}/promesas

POST /negocios/{id}/modificar-promesa

POST /negocios/{id}/modificar-cliente-reserva

POST /negocios/{id}/modificar-cliente-promesa

POST /negocios/{id}/agregar-producto-secundario-o-adicional-reserva

POST /negocios/{id}/eliminar-producto-secundario-o-adicional-reserva

POST /negocios/{id}/modificar-producto-principal-reserva

POST /negocios/{id}/modificar-producto-principal-promesa

POST /negocios/{id}/agregar-producto-secundario-o-adicional-promesa

POST /negocios/{id}/eliminar-producto-secundario-o-adicional-promesa

POST /negocios/{id}/reversar-escritura

GET /productos-principales

POST /promesa

GET /promesas/{idPromesa}

POST /promesas/cancelar

GET /promesas/fecha-inmobiliaria

GET /promesas/fecha-firma-comprador

GET /promesas/canceladas

POST /escritura

GET /reservas

POST /reservas/cancelar

POST /producto-principal/{id}/bloquear

GET /seguimientos

POST /seguimientos