List

Método utilizado para obtener un listado de documentos

Para consultar el listado de documentos podemos generar la siguiente solicitud con el archivo payload.json:

curl "https://agents.boolfy.com/api/documents/list" \ 
    -H "Authorization: Bearer BOOLFY_BEARER_KEY" \
    -H "Content-Type: application/json" \
    -d @payload.json

El archivo payload.json debe tener el siguiente formato:

{
    "Agent": "Facturas",
    "FromDate": "2024/01/01",
    "ToDate": "2024/01/31",
    "State": "Finished",
    "DocumentState": "Approved",
    "FileFormat": "JSON"
}

Detallamos en forma completa los campos de la solicitud:

Campo	Descripción
Agent	Obligatorio. Especifica el nombre del agente IA de Boolfy para el documento.
FromDate	Obligatorio. Especifica la fecha desde del listado en formato: yyyy\mm\dd.
ToDate	Obligatorio. Especifica la fecha hasta del listado en formato: yyyy\mm\dd.
State	Opcional. Es el estado del Proceso del documento. Si no se especifica se asume Finished. Para consultar documentos enviados, especificar Sended.
DocumentState	Opcional. Es el Estado de revisión. Si no se especifica, este dato no filtra los documentos a obtener.
FileFormat	Opcional. Es el formato del campo response en la respuesta. Sus valores posibles son: JSON, CSV o XML. Si no se especifica, se asume: JSON.

Respuesta

La respuesta exitosa para la consulta es:

{
    "code": 200,
    "msg": null,
    "response": "[{\"Identifier\":\"5a37b2ab...",\"Pages\":2,\"Filename\":\"...},{...}]"
}

El campo Response es un listado de documentos. Los campos de este listado pueden consultarse en el método GetInfo.