Expedientes

Expedientes de documentos

Un expediente de documentos es un conjunto de documentos que se manejan en un sólo flujo. Se envía una sola invitación a cada persona involucrada y desde esa invitación puede ver y firmar los documentos que contenga el expediente.

El manejo del expediente se maneja en 3 pasos:

1. Crear el expediente

2. Agregar documentos al expediente

3. Cerrar expediente

Crear un expediente

Esta función crea un expediente vacío. Recibe como parámetro un nombre para el expediente y responde con un identificador único.

const {documentSet} = 
    await services.createDocumentSet('nombre para el expediente')

Agregar documentos al expediente

Con el expediente creado, el siguiente paso es agregar documentos. Para agregar un documento puedes utilizar las mismas funciones que están disponibles para generar un documento normalmente: stickers, recuadros, qr, templates, etc. Pero agregando el identificador para el expediente.

Notas importantes

• La única opción que no se puede utilizar en esta función es la de flujo (workflow), ya que el flujo se manejará a nivel expediente

• Cada firmante debe contener un dato de contacto. Esto significa que para las firmas por SAT, es obligatorio agregar el campo de correo ("email")

Por ejemplo, aquí estamos agregando un documento con un sticker al expediente que acabamos de crear:

const {documentSet} = 
    await services.createDocumentSet('nombre del expediente')
await services.request({        
    url_doc: {
        "url":"https://www.dropbox.com/s/sxvgq1uhb4k3s4w/test.pdf?dl=0",  
        "name":"contrato.pdf"
    },
    documentSet: documentSet,
    stickers: [{
        "authority": "SAT"
        "stickerType":"rect",
        "dataType":"RFC"
        "imageType":"stroke",
        "data":"GOCF9002225A711",
        "email": "[e-mail]",
        "page":0,
        "rect": {
            "lx":330,
            "ly":300,
            "tx":530,
            "ty": 400
        }
    }]
})

Cerrar expediente

El último paso sería cerrar el expediente, un expediente cerrado ya no permite que se agreguen más documentos.

Para cerrar el expediente, es necesario que envíes el identificador del expediente y las opciones del flujo de firmas (workflow). Estas opciones son las mismas que se utilizan para crear un flujo de firmas de un documento (ver sección de Flujos), con la limitante de que tiene que ser un flujo ordenado.

await services.closeDocumentSet({
        documentSet: documentSet,
        workflow: {
            remind_every: '1d',
            language: 'es',
            // los firmantes del expediente. Solo es necesario que 
            // se agreguen una sola vez aunque se les este 
            // solicitando mas de una firma
            ordered: [
                'GOCF9002225A711',
                '[e-mail]'
            ]
        }
    })

Consultar expediente

Puedes consultar el estatus del expediente en cualquier momento para verificar los documentos y firmantes que han sido agregados.

const documentSetData = await services.getDocumentSet(documentSet);

Ejemplo de respuesta:

 {
   "uuid":"9v3d6a47-e4e8-48ef-b9b3-7af45c8207dn",
   "status":"CLOSED",
   "documents":[
      "4a3d6a47-e4e8-48ef-b9b3-7af45c8207de",
      "5d08eabe-ecd0-46ad-9dbd-5d54098aca70"
   ],
   "signers":[
      "GOCF9002226A511",
      "[e-mail]",
      ...
   ]
}