SetInfo

Método utilizado para informar sobre la actualización de un documento en particular

Para informar de la actualización de un documento podemos generar la siguiente solicitud con el archivo payload.json:

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

El archivo payload.json debe tener el siguiente formato:

{
    "identifier": "5a37b2ab-551b-4380-aa88-b808e3352d66",
    "externalcode": "tyujt4f4s5f454w",
    "bag": "{\"property1\":\"value1\",\"property2\":12345.67}",
    "context": "{\"property1\":\"value1\",\"property2\":12345.67}"
}

Detallamos en forma completa los campos de la solicitud:

Se debe especificar Identifier o ExternalCode para identificar univocamente al documento sobre el que se quiere realizar la operación.

Campo	Descripción
Identifier	Opcional. Especifica el identificador único de Boolfy para el documento. Este dato se proporciono en Upload y en Callback.
ExternalCode	Opcional. Especifica el identificador del documento en tu plataforma
Bag	Opcional. Especifica los datos a ser enviados al Application registrado para el Agente. Ver Bag.
Context	Opcional. Especifica los datos que se quieren modificar en el documento. Ver Context.

Bag

Los datos especificados en Bag se transmiten a la Application registrada para el Agente. Quedando en responsabilidad de la Application aplicar los cambios y/o flujos de trabajo necesarios.

Context

Boolfy Agent toma la responsabilidad de aplicar los cambios en el documento especificado y deja trazabilidad de los mismos en el documento. Aquí pueden enviarse valores para campos que son leidos y/o no leidos desde los documentos.

Este JSON puede ser similar al obtenido en GetInfo, por ej:

//Simple
{"centro_costo":"ADM", "descuento": 12345.67}

//Complejo
{"cuenta_contable":"ADM", "items": [{"centro_costo": "ADM"}]}

Respuesta

La respuesta exitosa para la consulta es:

{
    "code": 200,
    "msg": null,
    "response": ""
}