Cómo recuperar un gran volumen de gastos a través de la API de Expensya
Expensya facilita API públicas, que te permiten recuperar, añadir y modificar datos al instante.
En este artículo hablaremos de cómo recuperar un gran volumen de gastos utilizando las API de Expensya en caso de una auditoría URSSAF o para una simple auditoría contable.
¿Cómo utilizar las API públicas de Expensya?
Este enlace te llevará al artículo sobre cómo conectarte a las API de Expensya.
¿Qué API te permitirán recuperar un gran volumen de gastos?
Proporcionamos dos API que te permiten recuperar grandes volúmenes de gastos.
La elección de la API depende de tus necesidades:
- Si quieres recuperar datos sin procesar en formato JSON para poder utilizarlos en tu programa como mejor te convenga :
- Debes utilizar la API GetExpenses, que se encuentra en la sección Expenses. Esta API te permitirá, en función de la configuración que especifiques, devolver una lista de gastos.
- Si deseas recuperar los datos en un formato de exportación activo desde tu cuenta Expensya (Por ejemplo: Expensya estándar Excel, Expensya estándar PDF, Expensya completo csv, etc.).
- Debes utilizar la API ExportExpenses, que se encuentra en la sección Export. Primero debes contactar con el equipo de soporte de Expensya para que te faciliten el identificador único de la exportación deseada (el identificador está en formato Guid).
A - API GetExpenses
Para recuperar un gran volumen de gastos, estas son algunas de las configuraciones a tener en cuenta para obtener un resultado preciso:
- Si deseas recuperar los gastos relativos a una entidad específica. Puedes utilizar la configuración "ejes analíticos" presente en la ficha del empleado:
- ownerPayId2: el primer eje analítico del empleado. Normalmente se utiliza para identificar la entidad del empleado.
- ownerPayId3: el segundo eje analítico del empleado.
- ownerPayId4: el tercer eje analítico del empleado.
- ownerPayId5: el cuarto eje analítico del empleado.
- ownerPayId6: el quinto eje analítico del empleado.
- Si deseas recuperar los gastos en función de un período. También dispones de una configuración que te permite afinar la búsqueda:
- dateFilterType: Esta configuración te permitirá seleccionar la fecha objetivo a través de su lista de valores en formato "enum"
- InvoiceDate = 1: Fecha del gasto
- ValidationDate = 2: Fecha de validación del gasto
- AccountingValidationDate = 3: Fecha de la validación contable (Archivo del gasto)
- SubmissionDate = 4: Fecha de envío del gasto
- CreationDate = 6: Fecha de creación del gasto
- UserModificationDate = 9: Fecha de la modificación realizada por el empleado
- ValidatorModificationDate = 10: Fecha de la modificación realizada por el validador
- startDate: Fecha de inicio según el valor en dateFilterType (Formato - fecha-hora [como fecha-hora en RFC3339])
- endDate: Fecha de finalización según el valor en dateFilterType (Formato - fecha-hora [como fecha-hora en RFC3339])
- Si deseas recuperar sólo un informe específico de gastos:
- reportState: El informe de la nota de gastos, tiene una lista de valores en formato "enum":
- Submitted = 2: Informe enviado
- Rejected = 3: Informe rechazado
- Validated = 4: Informe aprobado
- Closed = 5: Informe archivado
- ValidatedAndExported = 6: Informe aprobado y exportado
- PreSubmitted = 8: Informe en validación
Buenas prácticas sugeridas por Expensya
- Utiliza la configuración "pageSize" para limitar el número de resultados por página (máximo 100 por página)
- Utiliza la configuración "page" para navegar entre páginas (por defecto 0)
- Recomendación de Expensya: No superes las 100 llamadas de API por minuto.
- El mejor período para conseguir este volumen de gastos es entre las 02h y las 04h (zona horaria de París).
Resultado de la API GetExpenses
B - API ExportExpenses
Una vez que haya obtenido el ID de exportación del equipo de soporte de Expensya, debes introducirlo en la configuración que aparece a continuación:
- exportId: identificador único del formato de exportación. Contacta con el equipo de soporte de Expensya para que te envíen este identificador único.
- Si deseas recuperar los gastos relativos a una entidad específica. Puedes utilizar la configuración "ejes analíticos" presente en la ficha del empleado:
- payId2: el primer eje analítico del empleado. Normalmente se utiliza para identificar la entidad del empleado.
- payId3: el segundo eje analítico del empleado.
- Si deseas recuperar los gastos en función de un período. También dispones de una configuración que te permite afinar la búsqueda:
- dateFilterType: Esta configuración te permitirá seleccionar la fecha objetivo a través de su lista de valores en formato "enum"
- InvoiceDate = 1: Fecha del gasto
- ValidationDate = 2: Fecha de validación del gasto
- AccountingValidationDate = 3: Fecha de la validación contable (Archivo del gasto)
- SubmissionDate = 4: Fecha de envío del gasto
- CreationDate = 6: Fecha de creación del gasto
- UserModificationDate = 9: Fecha de la modificación realizada por el empleado
- ValidatorModificationDate = 10: Fecha de la modificación realizada por el validador
- startDate: Fecha de inicio según el valor en dateFilterType (Formato - fecha-hora [como fecha-hora en RFC3339])
- endDate: Fecha de finalización según el valor en dateFilterType (Formato - fecha-hora [como fecha-hora en RFC3339])
- Si deseas recuperar sólo un informe específico de gastos:
- reportState: El informe de la nota de gastos, tiene una lista de valores en formato "enum":
- Submitted = 2: Informe enviado
- Rejected = 3: Informe rechazado
- Validated = 4: Informe aprobado
- Closed = 5: Informe archivado
- ValidatedAndExported = 6: Informe aprobado y exportado
- PreSubmitted = 8: Informe en validación
- Si también deseas recuperar los justificantes de los gastos:
- includeReceipts: Añade los justificantes de los gastos (la configuración es de tipo booleano, por lo que debes rellenar "true" para sí y "false" para no)
Si deseas exportar un gran número de gastos, te recomendamos que utilices la API GetExpenses, que es más eficaz y presenta menos riesgo de que se agote el tiempo de espera.
Resultado de la API ExportExpenses:
Descripción de los elementos de ResultItem:
FileUrl: Enlace para descargar el archivo de exportación de gastos.
FileExtension: Extensión del archivo de exportación.
FileName: Nombre del archivo de exportación.
