API Custom GestionObra

Constructoras
, , ,
1

Esta API permite consultar, insertar y eliminar información relacionada con la gestión de obras de construcción, incluyendo ítems, recursos, avances planificados y tarifarios.

Pasos a seguir

1. Obtención de token

Antes de realizar cada solicitud, es necesario obtener un token de autenticación utilizando las credenciales de un usuario API configurado en el maestro de Usuarios.

Este token es requerido para autorizar el consumo de los servicios expuestos por la API de Finnegans.

2. Métodos disponibles para la consulta y envío de datos al servidor

Campos del Body (formato JSON)

1. GestionObraInfo

Campo API Descripción Tipo de dato Ejemplo
codigoTransaccionSubTipo Código del subtipo de transacción string GESTION_OBRA
nombre Nombre de la gestión de obra string Obra Ejemplo
cliente Nombre del cliente string Cliente ABC
sucursal Nombre de la sucursal string Sucursal Principal
generaSucursal Indica si genera sucursal boolean TRUE
fecha Fecha de la gestión de obra string 2024-08-15
deposito Nombre del depósito string Depósito Central
generaDeposito Indica si genera depósito boolean FALSE
moneda Moneda principal de la obra string USD
monedaSecundaria Moneda secundaria de la obra string EUR
fechaCotizacion Fecha de cotización de la moneda string 2024-08-14
fechaBase Fecha base de la obra string 2024-08-01
indiceActualizacionGlobal Índice de actualización global string Índice 123
descripcion Descripción de la obra string Descripción de la obra de ejemplo
contratoAGenerar Tipo de contrato a generar string CONTRATO_OBRA
workflowContrato Workflow del contrato string Contrato Obra
coeficientePaso Coeficiente de paso BigDecimal 1.10
tipoActualizacion Tipo de actualización string 0 = Por incremento de precio / 1 = Por precio completo / 2 = Por índice
porcentajeAnticipo Porcentaje de anticipo BigDecimal 20.00
recalculaPrecioVenta Indica si recalcula el precio de venta boolean TRUE
pedidoAGenerar Tipo de pedido a generar string PEDIDO_MATERIALES
workflowPedido Workflow del pedido string Pedido Materiales
gestionObraItemInfo Lista de ítems de la obra List […]
gestionObraTarifarioInfo Lista de tarifarios de la obra List […]

2. GestionObraItemInfo

Campo API Descripción Tipo de dato Ejemplo
orden Orden del ítem string 1
rubro Rubro del ítem string Excavación
subRubro Sub-rubro del ítem string Preparación del terreno
nombre Nombre del ítem string Excavación inicial
descripcion Descripción del ítem string Excavación para cimientos
producto Nombre del producto string Excavadora
tipo Tipo de ítem string 0 = Costos / 1 = Costo y ventas / 2 = Ventas / 3 = Sin impacto
fechaInicio Fecha de inicio del ítem string 2024-08-15
fechaFin Fecha de fin del ítem string 2024-08-22
moneda Moneda del ítem string USD
fechaCotizacion Fecha de cotización del ítem string 2024-08-14
cantidad Cantidad del ítem BigDecimal 150.00
predecesor Nombre del ítem predecesor string Pre excavación
actualizaSegunCoeficienteGlobal Indica si actualiza según coeficiente global boolean FALSE
coeficientePaso Coeficiente de paso del ítem BigDecimal 1.05
precioAdaptado Precio adaptado del ítem BigDecimal 1200.00
gestionObraItemRecursoInfo Lista de recursos del ítem List […]
gestionObraItemAvancePlanificadoInfo Lista de avances planificados del ítem List […]

3. GestionObraItemRecursoInfo

Campo API Descripción Tipo de dato Ejemplo
tipo Tipo de recurso string 2 = Máquinas / 3 = Materiales / 4 = Mano de Obra / 5 = Costos Indirectos
producto Nombre del producto string Diesel
funcion Nombre de la función string Ayudante
maquina Nombre de la máquina string Excavadora XYZ
concepto Concepto del recurso string Anticipos
unidad Unidad del recurso string Litros
cantidad Cantidad del recurso BigDecimal 200.00
monedaRecurso Moneda del recurso string USD
descripcion Descripción del recurso string Combustible para excavadora
costoUnitario Costo unitario del recurso BigDecimal 1.50
importe Importe del recurso BigDecimal 5000.00

4. GestionObraItemAvancePlanificadoInfo

Campo API Descripción Tipo de dato Ejemplo
periodo Período del avance planificado string 2024-08-15
avancePlanificado Porcentaje de avance planificado BigDecimal 50.00

5. GestionObraTarifarioInfo

Campo API Descripción Tipo de dato Ejemplo
tipo Tipo de tarifario string 2 = Máquinas / 3 = Materiales / 4 = Mano de Obra
funcion Nombre de la función string Albañil
producto Nombre del producto string Cemento
maquina Nombre de la máquina string Excavadora
costoUnitario Costo unitario BigDecimal 25.00
moneda Moneda del tarifario string USD
metodoActualizacion Método de actualización string Índice
fechaCotizacion Fecha de cotización string 2024-08-14
descripcion Descripción del tarifario string Tarifa por hora de albañil

GET

URL:

https://api.finneg.com/api/custom/gestionObra?access_token={$access_token}&identificacionExterna={identificacionExterna}

Parámetros:

  • ACCESS_TOKEN: corresponde a un token emitido por el sistema de acuerdo a las credenciales del usuario.
  • IdentificacionExterna: identificador externo de la obra.

Códigos de respuesta:

  • 200 OK: Se devuelve la información de la gestión de obra.
  • 400 Bad Request: Falta el identificador externo.
  • 404 Not Found: No se encuentra la obra.
  • 500 Internal Server Error: Error interno del servidor.

Ejemplo de respuesta (Body):

{
    "codigoTransaccionSubTipo": "GESTIONOBRA", 
    "nombre": "Gestion obra test",
    "cliente": "CLIENTE1",
    "sucursal": "EMPRESA_EMPRE0186",
    "generaSucursal": false,
    "fecha": "2025-03-23",
    "deposito": "AUTODROMO",
    "generaDeposito": false,
    "moneda": "Pesos",
    "monedaSecundaria": "Pesos",
    "fechaCotizacion": "2025-01-01",
    "fechaBase": "2025-01-01",
    "indiceActualizacionGlobal": "CAC",
    "descripcion": "descripcion test",
    "contratoAGenerar": "Contrato de Obra",
    "workflowContrato": "Contrato de Ventas",
    "coeficientePaso": 1.5,
    "tipoActualizacion": "Actualización por índice",
    "porcentajeAnticipo": 5.00,
    "recalculaPrecioVenta": false,
    "pedidoAGenerar": "Solicitud de Compra",
    "workflowPedido": "Compras - Insumos",
    "gestionObraItemInfo": [
        {
            "orden": "14",
            "rubro": "04. MAMPOSTERIAS Y TABIQUERIAS",
            "subRubro": "02",
            "nombre": "Patricio test",
            "descripcion": "descripcion",
            "producto": "Mampostería: De elevación de ladrillos cerámicos huecos; e=18cm",
            "tipo": "Costo y ventas",
            "fechaInicio": "2025-04-24",
            "fechaFin": "2025-08-24",
            "moneda": "Pesos",
            "fechaCotizacion": "2025-04-24",
            "cantidad": 100.00,
            "actualizaSegunCoeficienteGlobal": true,
            "coeficientePaso": 1.00,
            "precioAdaptado": 0.00,
            "gestionObraItemRecursoInfo": [
                {
                    "tipo": "Mano de Obra",
                    "funcion": "Oficial",
                    "unidad": "Horas",
                    "cantidad": 1.30,
                    "monedaRecurso": "Pesos",
                    "descripcion": "Oficial",
                    "costoUnitario": 4482.63
                },
                {
                    "tipo": "Materiales",
                    "producto": "Cemento Loma Negra 50kg",
                    "unidad": "Unidades",
                    "cantidad": 0.03,
                    "monedaRecurso": "Pesos",
                    "descripcion": "",
                    "costoUnitario": 6842.98
                },
                {
                    "tipo": "Máquinas",
                    "maquina": "CAMION",
                    "unidad": "Kilómetros",
                    "cantidad": 10.00,
                    "monedaRecurso": "Pesos",
                    "descripcion": "CAMION",
                    "costoUnitario": 57849855.00
                }
            ],
            "gestionObraItemAvancePlanificadoInfo": [
                {
                    "periodo": "2025-05-01",
                    "avancePlanificado": 50.00
                },
                {
                    "periodo": "2025-06-01",
                    "avancePlanificado": 50.00
                }
            ]
        }
    ],
    "gestionObraTarifarioInfo": [
        {
            "tipo": "Mano de Obra",
            "funcion": "Oficial",
            "costoUnitario": 4482.63,
            "moneda": "Pesos",
            "metodoActualizacion": "Índice"
        },
        {
            "tipo": "Materiales",
            "producto": "Cemento Loma Negra 50kg",
            "costoUnitario": 6842.98,
            "moneda": "Pesos",
            "metodoActualizacion": "Costo estándar"
        }
    ]
}

POST

URL:

https://api.finneg.com/api/custom/gestionObra?access_token={$access_token}

Parámetros:

  • ACCESS_TOKEN: corresponde a un token emitido por el sistema de acuerdo a las credenciales del usuario.

Códigos de respuesta:

  • 201 Created: La creación fue exitosa.
  • 400 Bad Request: Información inválida.
  • 500 Internal Server Error: Error interno del servidor.

Ejemplo de body para envío:

{
    "codigoTransaccionSubTipo": "GESTIONOBRA",
    "nombre": "Gestion obra test",
    "cliente": "CLIENTE1",
    "sucursal": "EMPRESA_EMPRE0186",
    "generaSucursal": false,
    "fecha": "2025-03-23",
    "deposito": "AUTODROMO",
    "generaDeposito": false,
    "moneda": "PES",
    "monedaSecundaria": "",
    "fechaCotizacion": "2025-01-01",
    "fechaBase": "2025-01-01",
    "indiceActualizacionGlobal": "CAC",
    "descripcion": "descripcion test",
    "contratoAGenerar": "CONTA",
    "workflowContrato": "Venta",
    "coeficientePaso": 1.5,
    "tipoActualizacion": "2",
    "porcentajeAnticipo": 5.00,
    "recalculaPrecioVenta": false,
    "pedidoAGenerar": "SOL",
    "workflowPedido": "CPRA-INS",
    "gestionObraItemInfo": [
        {
            "orden": "14",
            "rubro": "04. MAMPOSTERIAS Y TABIQUERIAS",
            "subRubro": "02",
            "nombre": "Patricio test",
            "descripcion": "descripcion",
            "producto": "ITEM0022",
            "tipo": "1",
            "fechaInicio": "2025-04-24",
            "fechaFin": "2025-08-24",
            "moneda": "PES",
            "fechaCotizacion": "2025-04-24",
            "cantidad": 100.00,
            "actualizaSegunCoeficienteGlobal": true,
            "coeficientePaso": 1.00,
            "precioAdaptado": 0.00,
            "gestionObraItemRecursoInfo": [
                {
                    "tipo": "4",
                    "funcion": "Of",
                    "cantidad": 1.30,
                    "monedaRecurso": "PES",
                    "descripcion": "Oficial",
                    "costoUnitario": 4482.63
                },
                {
                    "tipo": "3",
                    "producto": "MAT00665",
                    "cantidad": 0.03,
                    "monedaRecurso": "PES",
                    "descripcion": "",
                    "costoUnitario": 6842.98
                },
                {
                    "tipo": "2",
                    "maquina": "CAMION",
                    "cantidad": 10.00,
                    "monedaRecurso": "PES",
                    "descripcion": "CAMION",
                    "costoUnitario": 57849855.00
                },
                {
                    "tipo": "5",
                    "concepto": "ACC",
                    "monedaRecurso": "PES",
                    "descripcion": "sdfee",
                    "importe": 568432.00
                }
            ],
            "gestionObraItemAvancePlanificadoInfo": [
                {
                    "periodo": "2025-05-01",
                    "avancePlanificado": 50.00
                },
                {
                    "periodo": "2025-06-01",
                    "avancePlanificado": 50.00
                }
            ]
        }
    ],
    "gestionObraTarifarioInfo": []
}

DELETE

URL:

https://api.finneg.com/api/custom/gestionObra?access_token={$access_token}&identificacionExterna={identificacionExterna}

Parámetros:

  • ACCESS_TOKEN: corresponde a un token emitido por el sistema de acuerdo a las credenciales del usuario.
  • IdentificacionExterna: identificador externo de la obra.

Códigos de respuesta:

  • 200 OK: Eliminación exitosa.
  • 404 Not Found: No se encuentra la obra.
  • 500 Internal Server Error: Error interno del servidor.