¿Cómo obtener el Libro Mayor por medio de una API?

Contabilidad
, , ,
1

Esta entrada posee información técnica sobre la API especificada y está dirigido a clientes que busquen integrar el Libro Mayor con otro sistema.

Pasos a seguir:

1. Obtención de token

Antes de cada solicitud se debe obtener el token de autorización, en función de las credenciales de un usuario API creado en el maestro Usuarios.

Se utiliza para generar un token de autenticación que permite poder consumir una API de Finnegans.

2. Métodos de recuperación y envío de datos a un servidor:

GET

URL: https://api.finneg.com/api/reports/libroMayor?ACCESS_TOKEN=9e264027-6b71-4df9-b7cd-dd790d9aa82e&PARAMWEBREPORT_FechaDesde=2025-01-01&PARAMWEBREPORT_FechaHasta=2025-04-15&PARAMWEBREPORT_cuenta=&PARAMWEBREPORT_circuitocontable=&PARAMWEBREPORT_dimension=&PARAMWEBREPORT_valor=&PARAMWEBREPORT_organizacion=&PARAMWEBREPORT_producto=&PARAMWEBREPORT_verpor=0&PARAMWEBREPORT_moneda=&PARAMWEBREPORT_Empresa=

Parámetros:

  • ACCESS_TOKEN: Requerido. Ejemplo: “a0e172d4-e070-4346-96fa-c02a97230384”.
  • FechaDesde: Requerido. Es la fecha desde la que se quiere obtener el listado. Formato DD-MM-AAAA. Ejemplo: “01-01-2025”.
  • FechaHasta: Requerido. Es la fecha hasta la que se quiere obtener el listado. Formato DD-MM-AAAA. Ejemplo: “01-04-2025”.
  • Documento: Es el código del Tipo de Documento que se desea obtener. Se toma del Maestro de Tipos de Documentos. Ejemplo: “OC”.
  • Cuenta: Es el código de la Cuenta Contable. Se obtiene del maestro de Cuentas. Ejemplo: “CLI”.
  • Circuitocontable: Es el código del circuito contable. Se obtiene del maestro Circuitos Contables. Ejemplo: “CIRCGRAL”.
  • Dimension: Es el código de la Dimensión utilizada. Se toma del Maestro Dimensiones. Ejemplo: “DIMCTC”.
  • Dimensión_valor: Es el código de la Distribución utilizada. Se toma de la vista de Centros de Costos. Ejemplo: “ADM”.
  • Organización: Es el código de la Organización (Cliente/Proveedor) que se desea obtener. Se toma del Maestro de Clientes o Proveedores.
  • Producto: Es el código del Producto que se desea obtener. Se toma del Maestro de Productos. Ejemplo: “STK03655”.
  • verPor: Requerido. Permite indicar si se deben incluir en la consulta la visualización de la información distribuida por Cuenta o por Cuenta y Dimensión. Las opciones son: 0 = Cuenta y 3 =Cuenta Dimensión. Ejemplo: “0”.
  • Moneda: Es el código de la moneda. Se obtiene del maestro Monedas. Ejemplo: "PES”.
  • Empresa: Requerido. Es el código de la Empresa/Sucursal. Se obtiene del maestro Sucursales. Ejemplo: “ejemplo”.

Códigos de respuesta:

  • 200 Ok: Se devuelve la información del Libro Mayor en formato JSON.
  • 404 Solicitud incorrecta: { “error”: "Not Found: ", “status”: 404 }.
  • 500 Error interno de servidor: { “error”: “Internal Server Error: null”,“status”: 500}.

JSON libroMayor

[
    {
        "FINALTMPID": 1,
        "ASIENTOITEMID": null,
        "FECHA": "31-12-2024",
        "TRANSACCIONID": null,
        "DOCUMENTO": "Saldo Inicial",
        "TIPODOCUMENTO": null,
        "ORGANIZACIONID": null,
        "ORGANIZACION": "",
        "CUENTAID": 719,
        "CUENTACODIGO": "3300001",
        "CUENTA": "A.R.E.A.",
        "CIRCUITOCONTABLE": null,
        "DIMENSION": "",
        "DIMENSIONVALOR": "",
        "DESCRIPCION": "",
        "COMPROBANTE": "",
        "COMPROBANTEADICIONAL": "",
        "MONEDAID": null,
        "MONEDA": "",
        "DEBEMONEDAPPAL": 0.0000,
        "HABERMONEDAPPAL": 0.0000,
        "SALDOMONEDAPPAL": 0.0000,
        "DEBEMONEDASECUNDARIA": 0.0000,
        "HABERMONEDASECUNDARIA": 0.0000,
        "SALDOMONEDASECUNDARIA": 100010.9500,
        "DEBEMONEDATRANSACCION": 0.0000,
        "HABERMONEDATRANSACCION": 0.0000,
        "SALDOMONEDATRANSACCION": 0.0000,
        "@@CLASEVO": "",
        "PRODUCTOID": null,
        "PRODUCTO": "",
        "ANO": "2024",
        "ANO-MES": "2024-12",
        "EMPRESA": null,
        "COTIZACION": null,
        "OPERACION BANCARIA": null,
        "NUMERO": null,
        "ORGANIZACIONIDTRANSACCION": null,
        "ORGANIZACIONTRANSACCION": null,
        "DETALLE": " ",
        "BANCO": null,
        "CHEQUEFECHA": null,
        "CHEQUEFECHAVTO": null,
        "CORREDOR": null,
        "IMPORTEOPERACIONPPAL": 0.0000,
        "IMPORTEOPERACIONSEC": 0.0000,
        "IMPORTEOPERACIONTRANS": 0.0000,
        "FECHACOMPROBANTE": null,
        "FECHACARGADESDE": null,
        "FECHACARGAHASTA": null,
        "CUENTARAMA1": null,
        "CUENTARAMA2": null,
        "CUENTARAMA3": null,
        "CUENTARAMAN": null,
        "RAIZDIMENSION": null,
        "NIVEL1DIMENSION": null,
        "NIVEL2DIMENSION": null,
        "NIVEL3DIMENSION": null,
        "SUCURSAL": null,
        "NIVEL1CLIENTE": null,
        "NIVEL2CLIENTE": null,
        "FECHAVTO": null,
        "IDENTIFICACIONEXTERNA": null,
        "CODIGOALTERNATIVO": "3300001",
        "CUENTANOMBRECODIGO": "A.R.E.A.-3300001"
       }
]

Antes de empezar

Antes de utilizar esta API, se deben considerar algunas cuestiones que se detallan a continuación.

Configuración de API

Dentro de la API en el Diccionario de APIs debe estar la información configurada de acuerdo a lo que se detalla:

  • En el campo Tipo debe estar el valor Viewer.
  • En el campo Viewer debe indicarse Libro Mayor.