API resumenes bancarios

Tesorería
,
1

Documento de Conocimiento: Integración API Resumen Bancario

La API de Resumen Bancario permite crear, consultar, modificar y eliminar resúmenes bancarios desde sistemas externos. No se debe utilizar la API de Factura de Compra, ya que este documento requiere un tratamiento específico para impactar correctamente en la cuenta bancaria y generar su asiento contable.

Conexión y Autenticación

  • URL Base: https://{dominio}/api/resumenBancario

  • Autenticación: Query Parameter ?ACCESS_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Operaciones Disponibles

Método Endpoint Descripción
POST /api/resumenBancario Crear documento
GET /api/resumenBancario/{IdentificacionExterna} Consultar documento
PUT /api/resumenBancario/{IdentificacionExterna} Modificar documento
DELETE /api/resumenBancario/{IdentificacionExterna} Eliminar documento

Nota: La IdentificacionExterna es el identificador provisto por la integración o el id retornado en la respuesta del alta.

Estructura de Datos y Reglas de Negocio

  • Cabecera: Datos generales (EmpresaCodigo, fechas, Proveedor, MonedaCodigo, número de comprobante, etc.).

  • Detalles: Productos, Conceptos y Retenciones.

  • Vencimientos: Define la cuenta impactada y la operación. Sus atributos clave son:

    • Cuenta: Código de la cuenta contable/bancaria.

    • FechaVTO: Fecha de vencimiento.

    • Porcentaje / Importe: Distribución del monto.

    • OperacionBancariaCodigo: Código de la operación (ej. GSTOSBCARIOS).

    • DimensionDistribucion: Dimensiones asociadas (ej. partida financiera).

Regla de Operación Bancaria: Si la cuenta del vencimiento es bancaria, el sistema requiere una operación bancaria para generar el asiento. Esta puede enviarse en la API (OperacionBancariaCodigo) o estar preconfigurada en el tipo de documento dentro del ERP.

Comportamiento en GET: Al consultar el documento mediante GET, el campo OperacionBancariaCodigo puede retornar como null. Esto es normal: el dato se utiliza durante el procesamiento del alta/modificación para el asiento y no se almacena como atributo del vencimiento.

Catálogos de Consulta

Los códigos enviados deben existir previamente en el ERP. Pueden consultarse mediante:

  • Empresas: /api/Empresa/list

  • Proveedores: /api/Proveedor/list

  • Condición de Pago: /api/CondicionPago/list

  • Tipo de Documento: /api/TransaccionSubtipo/list

  • Monedas: /api/Moneda/list

  • Productos / Conceptos: /api/Producto/list | /api/Concepto/list

  • Cuentas Contables: /api/Cuenta/list

  • Operaciones Bancarias: /api/tipoOperacionBancaria/list

Ejemplo de Solicitud (POST)

JSON

{
  "IdentificacionExterna": "RESBANC-DEMO-001",
  "EmpresaCodigo": "EMPRE01",
  "Fecha": "2026-08-13",
  "FechaComprobante": "2026-08-13",
  "Proveedor": "BBVA",
  "CondicionPagoCodigo": "DEB-CTA 00",
  "TransaccionTipoCodigo": "OPER",
  "TransaccionSubtipoCodigo": "RESBANC",
  "WorkflowCodigo": "CPRA-PROD",
  "NumeroComprobante": "TEST-0001",
  "MonedaCodigo": "PES",
  "ComprobanteTipoImpositivoCodigo": "001",
  "CAE": "0",
  "CAEFechaVto": "2026-08-13",
  "Descripcion": "Resumen bancario de ejemplo",
  "ImporteTotalControl": 51623.41,
  "Cotizaciones": [
    {
      "MonedaCodigo": "PES",
      "Cotizacion": 1
    }
  ],
  "Productos": [
    {
      "ProductoCodigo": "GASTO_BANCARIO",
      "Cantidad": 1,
      "Precio": 51623.41,
      "ImporteExento": 0,
      "Descripcion": "Gasto bancario"
    }
  ],
  "Conceptos": [],
  "Retenciones": [],
  "Vencimientos": [
    {
      "Cuenta": "1.1.4.02.02",
      "FechaVTO": "2026-08-13",
      "Porcentaje": 100,
      "Importe": 51623.41,
      "OperacionBancariaCodigo": "GSTOSBCARIOS",
      "DimensionDistribucion": [
        {
          "dimensionCodigo": "DIMPARFIN",
          "distribucionCodigo": "",
          "tipoCalculo": "2",
          "distribucionItems": [
            {
              "codigo": "PARTIDA_EJEMPLO",
              "porcentaje": 100,
              "importe": 51623.41
            }
          ]
        }
      ]
    }
  ]
}

Respuesta Exitosa (200 OK)

JSON

{
  "documento": "RESBANC - TEST",
  "id": "c3373a2df337ae30290322743231f7bde9c49262",
  "message": "created",
  "status": 200
}

Checklist de Verificación

  • Mapear todos los códigos del JSON con los catálogos del ambiente del cliente.

  • Confirmar que TransaccionSubtipoCodigo sea del tipo Resumen Bancario.

  • Verificar que la OperacionBancariaCodigo esté presente en la API o configurada en el subtipo dentro del ERP.

  • Validar en el ERP la creación correcta del comprobante, el impacto en la cuenta bancaria y la consistencia del asiento contable.