¿Cómo obtener un listado de Facturas de Compra por medio de una API?

Gcolina
Tue, 19 Dec 2023 12:52:52 +0000
API

Consulta : ¿Cómo obtener un listado de Pedidos de Venta Pendiente por medio de una API?

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.

URL de Token:

https://api.teamplace.finneg.com/api/oauth/token?grant_type=client_credentials&client_id={$clientid}&client_secret={$secretkey}

Se utiliza para generar un token de forma tal de poder consumir un api de teamplace.

Parámetros:

Parámetro | Requerido | Descripción | Ejemplo
| | |
grant_type | Sí | Solicitud de un token nuevo. El valor a indicar es client_credentials. | client_credentials
client_id | Sí | client_id del usuario que va a consumir la API. | e4132aa69a52a25f98046e3a598f0d54
client_secret | Sí | client_secret del usuario que va a consumir la API. | 1c05acf5604f7c366f53c29719829b51

Código de respuesta:

Código | Descripción | Ejemplo
| |
200 | Ok. Se devuelve el token en texto plano de forma correcta. | “c8ea2741-b019-4f47-91ee-4a8edf70cf09”
404 | Solicitud incorrecta. | {“error”: “credentials not found”,“status”: 404}
500 | Error interno de servidor. | {“error”: “Internal Server Error: null”,“status”: 500}
— | — |

Métodos de recuperación de datos a un servidor

GET

URL: https://api.teamplace.finneg.com/api/reports/analisisFacturasCompra?ACCESS_TOKEN={$access_token}&FechaDesde=2023-01-01&FechaHasta=2023-11-29&Documento=tipo_documento&Proveedor=proveedor&CircuitoContable=circuito_contable&PARAMWEBREPORT_dimension=dimensión&PARAMWEBREPORT_valor=dimensión_valor&Producto=producto&Moneda=moneda&PARAMEmpresa=empresa-sucursal&PARAMWEBREPORT_IncluirConceptosCalculados=false

Parámetros:

Parámetro | Requerido | Descripción | Ejemplo
| | |
ACCESS_TOKEN | Si | Token de autorización. | c8ea2741-b019-4f47-91ee-4a8edf70cf09
FechaDesde | Sí | Fecha desde la que se quiere obtener el listado. Formato AAAA-MM-DD. | 2023-01-01
FechaHasta | Sí | Fecha hasta la que se quiere obtener el listado. Formato AAAA-MM-DD. | 2023-10-11
Documento | No | Es el tipo de documento. Se obtiene del maestro Tipos de Documentos. | FC
Proveedor | No | Es el código del Proveedor obtenido del maestro Proveedores. |
CircuitoContable | No | Es el código del circuito contable. Se obtiene del maestro Circuitos Contables. | CIRCGRAL
PARAMWEBREPORT_dimension | No | Es el código de la dimensión utilizada por el documento, utilizada por ejemplo cuando se quiere filtrar por centro de costos, Se obtiene del maestro Dimensiones. | DIMCTC
PARAMWEBREPORT_valor | No | Es el código de uno de los valores dentro de la dimensión elegida. Si la dimensión es centro de costos, el valor de este campo será el del código de un centro de costos. |
Producto | No | Es el código del producto, obtenido del maestro Productos. |
Moneda | No | Es el código de la moneda utilizada en el pedido de venta. Se obtiene del maestro Monedas | PES
PARAMEmpresa | No | Código de la empresa obtenido del maestro Sucursales. | EMPRE01
PARAMWEBREPORT_IncluirConceptosCalculados | No | Permite indicar si se deben incluir los conceptos calculados o no. Las opciones son: | 0: en caso de que no se quieran incluir conceptos calculados. 1: en caso de que se quieran incluir conceptos calculados

Códigos de respuesta:

Código | Descripción | Respuesta
200 | Ok. Se devuelve la información del analisis de facturas de compra en formato json. | [JSON analisisFacturasCompra]
404 | Solicitud incorrecta. | {“error”: "Not Found: ",“status”: 404}
500 | Error interno de servidor. | {“error”: “Internal Server Error: null”,“status”: 500}
JSON analisisFacturasCompra | |
A continuación, se detalla el ejemplo de respuesta esperada al invocar el método GET de la API analisisFacturasCompra. | |

[
   {
       "TRANSACCIONSUBTIPOID": 85,
       "FECHA": "10-07-2023",
       "FECHACOMPROBANTE": "10-07-2023",
       "TRANSACCIONTIPONOMBRE": "Operación",
       "TRANSACCONSUBTIPONOMBRE": "Factura de Compra",
       "TRANSACCIONID": 5663,
       "DOCNROINT": "FC - 3",
       "COMPROBANTE": "A-53972-60611000",
       "COMPROBANTEADICIONAL": "",
       "NUMEROCONTRATO": "",
       "DIMENSIONVALOR": "Sin dimensión valor",
       "TOTALBRUTO": 287320.1600,
       "TOTALCONCEPTOS": 75779.8600,
       "TOTAL": 371520.0000,
       "CLIENTE": "EDET S.A.",
       "DESCRIPCION": "factura per 06-2023",
       "CONDICIONPAGO": "Cheque 30 días FF",
       "MONEDA": "PESOS",
       "COTIZACION": 1.000000,
       "LISTAPRECIO": null,
       "VENDEDOR": null,
       "PRODUCTO": "Gastos De Energia 27%",
       "MARCA": "",
       "DESCITEM": "luz per 06-2023",
       "CANTIDAD": 1.00000000,
       "CANTIDADSTOCK2": 0.000000,
       "UNIDADVENTA": "Unidades",
       "UNIDADCOMPRA": "Unidades",
       "UNIDADSTOCK": null,
       "UNIDADSTOCK2": null,
       "PRECIO": 287320.160000,
       "PRECIOMONPRINCIPAL": 287320.1600,
       "PRECIOMONSECUNDARIA": 1149.2806,
       "IMPORTEMONPRINCIPAL": 287320.160000,
       "IMPORTEMONSECUNDARIA": 1149.280000,
       "DEPOSITOORIGEN": null,
       "DEPOSITODESTINO": null,
       "PRECIOSOBRE": "Cantidad",
       "IMPORTE": 287320.160000,
       "GRAVADO": 280666.1500000,
       "NO GRAVADO": 6654.010000,
       "PROVEEDOR": "EDET S.A.",
       "PARTIDA": "",
       "ESTADO": "Activa",
       "CODIGOPROD": "ENERGIA",
       "PENDIENTEORIGEN": 1.000000,
       "PENDIENTEDESTINO": 1.000000,
       "IMPORTEPENDIENTEORIGEN": 287320.160000,
       "IMPORTEPENDIENTEDESTINO": 287320.160000,
       "ORGANIZACION": null,
       "CUENTA": "Energía Electricidad",
       "EMPRESA": "Empresa de prueba",
       "ANO": "2023",
       "ANO-MES": "2023-07",
       "PRODUCTORAMA1": null,
       "PRODUCTORAMA2": null,
       "PRODUCTORAMA3": null,
       "PRODUCTORAMAN": null,
       "PORCENTAJEIMPOSITIVO": 27.00,
       "CONTROLIMPOSITIVO3": null,
       "GRAVADOPORTASAIMPOSITIVA": 75779.8600,
       "GRAVADOPORTASAIMPOSITIVAMONEDAPRINCIPAL": 75779.8600,
       "@@CLASEVO": "OperacionVO",
       "FECHAPROXIMOPASO": null,
       "SEMANACARGADESDE": 0,
       "SEMANACARGAHASTA": 0,
       "PROVINCIADESTINO": "Tucuman",
       "PROVINCIAORIGEN": "Tucuman",
       "COORDENADAS": "",
       "CORREDOR": null,
       "SUCURSAL": null,
       "CAI/CAE": "34272004763601",
       "NIVEL1DIMENSION": null,
       "NIVEL2DIMENSION": null,
       "NIVEL1CLIENTE": null,
       "NIVEL2CLIENTE": null,
       "PROVINCIADESTINOITEM": "Tucuman",
       "PERCEPCIONES": 8419.9800,
       "SUBFAMILIA": "",
       "FAMILIA": "",
       "RUBRO": "",
       "ACTIVIDADIVA": null,
       "WORKFLOW": "Compras - Servicios & Conceptos",
       "IDENTIFICACIONEXTERNA": "FC - 3",
       "INDENTIFICACIONTRIBUTARIA": "C.U.I.T.",
       "NRODEIDENTIFICACION": "30-65865024-2",
       "IMPORTENETOPENDIENTE": 287320.160000,
       "NOMBREUSUARIOALTA": "Adriana Santillan"
   },
   {
       "TRANSACCIONSUBTIPOID": 85,
       "FECHA": "01-09-2023",
       "FECHACOMPROBANTE": "07-08-2023",
       "TRANSACCIONTIPONOMBRE": "Operación",
       "TRANSACCONSUBTIPONOMBRE": "Factura de Compra",
       "TRANSACCIONID": 10010,
       "DOCNROINT": "FC - 786",
       "COMPROBANTE": "A-00097-61909577",
       "COMPROBANTEADICIONAL": "",
       "NUMEROCONTRATO": "",
       "DIMENSIONVALOR": "Sin dimensión valor",
       "TOTALBRUTO": 80116.1400,
       "TOTALCONCEPTOS": 19704.4700,
       "TOTAL": 102010.0000,
       "CLIENTE": "EDET S.A.",
       "DESCRIPCION": "Luz período 07/2023 Vto 18/08/2023",
       "CONDICIONPAGO": "Cheque 30 días FF",
       "MONEDA": "PESOS",
       "COTIZACION": 1.000000,
       "LISTAPRECIO": null,
       "VENDEDOR": null,
       "PRODUCTO": "Gastos De Energia 27%",
       "MARCA": "",
       "DESCITEM": "Luz período 07/2023 Vto 18/08/2023",
       "CANTIDAD": 1.00000000,
       "CANTIDADSTOCK2": 0.000000,
       "UNIDADVENTA": "Unidades",
       "UNIDADCOMPRA": "Unidades",
       "UNIDADSTOCK": null,
       "UNIDADSTOCK2": null,
       "PRECIO": 72979.530000,
       "PRECIOMONPRINCIPAL": 72979.5300,
       "PRECIOMONSECUNDARIA": 261.2476,
       "IMPORTEMONPRINCIPAL": 72979.530000,
       "IMPORTEMONSECUNDARIA": 261.250000,
       "DEPOSITOORIGEN": null,
       "DEPOSITODESTINO": null,
       "PRECIOSOBRE": "Cantidad",
       "IMPORTE": 72979.530000,
       "GRAVADO": 72979.5300000,
       "NO GRAVADO": 0.000000,
       "PROVEEDOR": "EDET S.A.",
       "PARTIDA": "",
       "ESTADO": "Activa",
       "CODIGOPROD": "ENERGIA",
       "PENDIENTEORIGEN": 1.000000,
       "PENDIENTEDESTINO": 1.000000,
       "IMPORTEPENDIENTEORIGEN": 72979.530000,
       "IMPORTEPENDIENTEDESTINO": 72979.530000,
       "ORGANIZACION": null,
       "CUENTA": "Energía Electricidad",
       "EMPRESA": "DELOTTE S.A.",
       "ANO": "2023",
       "ANO-MES": "2023-09",
       "PRODUCTORAMA1": null,
       "PRODUCTORAMA2": null,
       "PRODUCTORAMA3": null,
       "PRODUCTORAMAN": null,
       "PORCENTAJEIMPOSITIVO": 27.00,
       "CONTROLIMPOSITIVO3": null,
       "GRAVADOPORTASAIMPOSITIVA": 19704.4700,
       "GRAVADOPORTASAIMPOSITIVAMONEDAPRINCIPAL": 19704.4700,
       "@@CLASEVO": "OperacionVO",
       "FECHAPROXIMOPASO": null,
       "SEMANACARGADESDE": 0,
       "SEMANACARGAHASTA": 0,
       "PROVINCIADESTINO": "Tucuman",
       "PROVINCIAORIGEN": "Tucuman",
       "COORDENADAS": "",
       "CORREDOR": null,
       "SUCURSAL": null,
       "CAI/CAE": "34302004792663",
       "NIVEL1DIMENSION": null,
       "NIVEL2DIMENSION": null,
       "NIVEL1CLIENTE": null,
       "NIVEL2CLIENTE": null,
       "PROVINCIADESTINOITEM": "Tucuman",
       "PERCEPCIONES": 2189.3900,
       "SUBFAMILIA": "",
       "FAMILIA": "",
       "RUBRO": "",
       "ACTIVIDADIVA": null,
       "WORKFLOW": "Compras - Servicios & Conceptos",
       "IDENTIFICACIONEXTERNA": "FC - 786",
       "INDENTIFICACIONTRIBUTARIA": "C.U.I.T.",
       "NRODEIDENTIFICACION": "30-65865024-2",
       "IMPORTENETOPENDIENTE": 80116.140000,
       "NOMBREUSUARIOALTA": "Adriana Santillan"
   }
]

Antes de empezar

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

Configuración 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 Análisis de Facturas de Compra.

Obtener credenciales de usuario

Para realizar solicitudes de API, es necesario obtener las credenciales de un usuario creado para la recuperación y envío de datos a un servidor.

Para obtener dichas credenciales hay que ir al maestro Usuarios (Menú → Configuración → General → Seguridad → Usuarios) y acceder al usuario que se va a utilizar. Dentro del mismo, se debe acceder a la opción Keys api, en la cual se encuentran las credenciales a configurar para la obtención del token.

Si es la primera vez que se accede a las credenciales, los campos Client ID y Secret Key van a estar vacíos, por lo que es necesario presionar el botón Generar keys para obtener los valores.