Documents

Uma lista de documentos.

hasMore

boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

data

object[]

Uma lista de itens de documentos.

Este objeto representa um documento.

data.id

string

Identificador exclusivo para o objeto.

Example:

"doc_5f92f01728e009f403d8502e"

data.key

string

Chave/Nome que será dado ao documento

Example:

"funcionario_desligado"

data.value

object

Valor/Objeto que deve corresponder ao schema da entidade, ao qual o documento está sendo inserido

Example:

{}

data.dataEntity

string

Id da entidade, ao qual o documento está relacionado

data.createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.updatedAt

string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.deleted

boolean

default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false

data.createdBy

object

data.updatedBy

object

Document Workflows

{
  "hasMore": true,
  "data": [
    {
      "id": "doc_5f92f01728e009f403d8502e",
      "key": "funcionario_desligado",
      "value": {},
      "dataEntity": "<string>",
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false,
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      }
    }
  ]
}

Empréstimos

Empresas

Clientes

Fundos

Eventos

Cobrança

Arquivos

Configurações

Entidades

Automações

Modelos