Dados dos Campos

Consulte a estrutura de dados dos campos do ENSPACE

Esta página documenta a estrutura de dados interna de cada tipo de campo do ENSPACE. Use esta referência sempre que precisar acessar dados específicos de um campo — seja em expressões, relatórios, condicionais, templates de documento ou eventos em campo.

Cada campo do ENSPACE armazena seus dados em um formato específico. Campos simples (como texto ou número) guardam um único valor direto. Campos complexos (como endereço ou pessoa) guardam um objeto com múltiplas propriedades que podem ser acessadas individualmente.

Como ler os exemplos

Os exemplos desta página usam referências de campo — os nomes técnicos que você define ao criar um campo no tipo. Por exemplo, se você criou um campo de texto curto com a referência nome, acessa seu valor com {{data.nome}}.

Ao longo da página você verá dois padrões de acesso aos dados:

• Notação de ponto — para acessar propriedades dentro de objetos: {{data.valor.currency}}
• Notação de colchete — para acessar itens dentro de listas por posição: {{data.anexos[0].name}}

Se esses padrões não são familiares, consulte a página Notação de Acesso antes de continuar.

Referência rápida

A tabela abaixo resume o tipo de dado retornado por cada campo. Para ver a estrutura completa e exemplos de acesso, consulte a seção correspondente.

Referência rápida

A tabela abaixo resume o tipo de dado retornado por cada campo. Para ver a estrutura completa e exemplos de acesso, consulte a seção correspondente.

Texto

Campos desta categoria armazenam conteúdo textual em diferentes formatos — desde strings simples até HTML rich text. Todos retornam String.

Texto curto — inputText

Campo de entrada de texto simples, sem formatação. Armazena uma string direta.

• Tipo de dado — String

"João Silva"

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é nome.

Texto longo — EnTextArea

Campo de texto longo, sem formatação rica. Ideal para observações, descrições detalhadas ou qualquer conteúdo textual extenso.

• Tipo de dado — String

"Observações gerais sobre o contrato de prestação de serviços firmado em janeiro."

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é observacoes.

Editor de texto HTML — EnHtml

Campo de texto com formatação HTML. O valor armazenado inclui tags HTML e deve ser tratado adequadamente ao ser renderizado em templates ou relatórios.

• Tipo de dado — String

"<p>Contrato revisado com <strong>cláusula adicional</strong> sobre prazos.</p>"

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é descricao.

Valor e Tempo

Campos desta categoria armazenam valores numéricos, datas e intervalos temporais. Utilizados para quantidades, prazos, valores monetários e qualquer informação que envolva medição ou marcação de tempo.

Número — EnlNumber

Campo numérico que armazena valores inteiros ou decimais.

• Tipo de dado — Number

1500.75

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é quantidade.

Valor monetário — EnCurrency

Campo monetário que armazena um valor com informações de moeda e, opcionalmente, configurações de correção monetária. A propriedade value reflete o valor atual (já corrigido quando aplicável).

• Tipo de dado — Object

{
  "currency": "BRL",
  "value": 1500.00,
  "originalValue": 1200.00,
  "config": {
    "correction": {
      "id": 1,
      "fieldRefId": "campo_referencia",
      "multiplePeriods": true,
      "periods": [
        {
          "id": 1,
          "indexCode": "IPCA",
          "startDate": "2024-01-01",
          "endDate": "2024-12-31",
          "isPercentage": false,
          "percentageValue": null,
          "validity": "FINISHED",
          "status": "SUCCESS",
          "incrementedValue": 300.00,
          "factorUsed": 1.25,
          "indexName": "IPCA",
          "lastIncrementedAt": "2024-12-31T23:59:59"
        }
      ]
    }
  }
}

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é valor.

Propriedades do objeto:

Propriedades de config.correction:

Propriedades de cada item em periods[]:

Data — EnlCalendar

Campo de data que armazena o valor em formato ISO 8601. A parte da hora geralmente é zerada (T00:00:00.000Z), mantendo apenas a informação da data.

• Tipo de dado — String

"2024-06-15T00:00:00.000Z"

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é data_vencimento.

Duração — EnlTimeRange

Campo de intervalo de tempo que define uma duração relativa ou absoluta. Utilizado para prazos, períodos de vigência ou qualquer medida temporal em diferentes escalas.

• Tipo de dado — Object

{
  "period": "current",
  "range": [0, 30],
  "scale": "days",
  "scaleValue": 30,
  "applyFrom": "start",
  "useRelativeTime": true
}

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é prazo.

Propriedades do objeto:

Opções

Campos desta categoria capturam escolhas do usuário — uma única opção, múltiplas opções ou estados booleanos. Retornam String, Boolean ou Array<String> conforme o tipo de seleção.

Lista de seleção — EnlDropdown

Lista suspensa que armazena o valor da opção selecionada. Apenas uma opção pode ser selecionada por vez.

• Tipo de dado — String

"Em andamento"

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é status.

Botões de seleção única — radioButton

Grupo de botões de rádio que armazena o valor da opção selecionada. Funciona de forma similar à lista de seleção, mas com apresentação visual diferente.

• Tipo de dado — String

"Aprovado"

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é aprovacao.

Alternativa binária — inputSwitch

Interruptor liga/desliga que armazena um valor booleano: ativado (true) ou desativado (false).

• Tipo de dado — Boolean

false

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é ativo.

Lista de seleção múltipla — multiSelect

Campo de seleção múltipla que armazena uma lista das opções selecionadas.

• Tipo de dado — Array<String>

["Financeiro", "Jurídico", "Compliance"]

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é departamentos.

Caixas de seleção — EnlCheckbox

Grupo de caixas de seleção que armazena uma lista das opções marcadas.

• Tipo de dado — Array<String>

["Leitura", "Escrita", "Exclusão"]

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é permissoes.

Relacionamento

Campos desta categoria criam vínculos entre itens de diferentes tipos. Retornam objetos com id, reference e display, permitindo acesso tanto ao identificador técnico quanto às informações legíveis do item vinculado.

Relacionamento simples — EnRel

Campo que armazena a referência a um único item de outro tipo. Retorna null quando nenhum item está vinculado.

• Tipo de dado — Object | null

{
  "id": 1042,
  "reference": "CONT-2024-001",
  "display": "Contrato de Prestação de Serviços"
}

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é contrato.

Propriedades do objeto:

Relacionamento múltiplo — EnRelMulti

Campo que armazena uma lista de referências a itens de outro tipo. Retorna uma lista vazia quando nenhum item está vinculado.

• Tipo de dado — Array<Object>

[
  {
    "id": 1042,
    "reference": "CONT-2024-001",
    "display": "Contrato de Prestação de Serviços"
  },
  {
    "id": 1043,
    "reference": "CONT-2024-002",
    "display": "Contrato de Licenciamento"
  }
]

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é contratos.

Cada item da lista possui as mesmas propriedades do Relacionamento simples: id, reference e display.

Mídia e Arquivos

Campos desta categoria armazenam arquivos anexados pelo usuário. Todos retornam Array<Object> onde cada objeto segue a estrutura EnFile com metadados do arquivo, URL de acesso e informações de armazenamento.

Arquivos — uploadFile

Campo de upload genérico que armazena uma lista de arquivos de qualquer tipo.

• Tipo de dado — Array<EnFile>

[
  {
    "id": 287,
    "created_at": "2024-06-15T14:30:00.000Z",
    "updated_at": "2024-06-15T14:30:00.000Z",
    "size": 204800,
    "ext": ".pdf",
    "width": null,
    "height": null,
    "name": "contrato-assinado.pdf",
    "hash": "contrato_assinado_a1b2c3d4",
    "url": "https://storage.enspace.com/uploads/contrato-assinado.pdf",
    "mime": "application/pdf",
    "alternativeText": null,
    "caption": null,
    "previewUrl": null,
    "provider": "aws-s3"
  }
]

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é anexos.

Propriedades de cada arquivo (EnFile):

Imagem — uploadImage

Campo de upload de imagens. A estrutura é idêntica ao Arquivos, com a diferença de que os campos width e height estarão preenchidos com as dimensões da imagem.

• Tipo de dado — Array<EnFile>

[
  {
    "id": 288,
    "created_at": "2024-06-15T14:35:00.000Z",
    "updated_at": "2024-06-15T14:35:00.000Z",
    "size": 102400,
    "ext": ".jpg",
    "width": 1920,
    "height": 1080,
    "name": "fachada-empresa.jpg",
    "hash": "fachada_empresa_e5f6g7h8",
    "url": "https://storage.enspace.com/uploads/fachada-empresa.jpg",
    "mime": "image/jpeg",
    "alternativeText": "Fachada da sede",
    "caption": null,
    "previewUrl": null,
    "provider": "aws-s3"
  }
]

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é fotos.

PDF — EnPDF

Campo específico para arquivos PDF. A estrutura de dados é idêntica à do Arquivos, diferenciando-se apenas na validação de tipo de arquivo permitido na interface.

• Tipo de dado — Array<EnFile>

[
  {
    "id": 289,
    "created_at": "2024-06-15T14:40:00.000Z",
    "updated_at": "2024-06-15T14:40:00.000Z",
    "size": 307200,
    "ext": ".pdf",
    "width": null,
    "height": null,
    "name": "relatorio-anual.pdf",
    "hash": "relatorio_anual_i9j0k1l2",
    "url": "https://storage.enspace.com/uploads/relatorio-anual.pdf",
    "mime": "application/pdf",
    "alternativeText": null,
    "caption": null,
    "previewUrl": null,
    "provider": "aws-s3"
  }
]

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é documentos.

Documentos

Campos desta categoria gerenciam documentos editáveis e assináveis. Além do arquivo original, mantêm versões derivadas (PDF, assinado) e metadados do processo de assinatura.

Documento Office — EnOnlyoffice

Campo de editor de documentos integrado que armazena referências ao arquivo original, sua versão em PDF e o documento assinado digitalmente (quando aplicável).

• Tipo de dado — Object

{
  "document": {
    "name": "contrato.docx",
    "url": "https://storage.enspace.com/uploads/contrato.docx",
    "ext": ".docx",
    "size": 102400,
    "mime": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "hash": "contrato_docx_a1b2",
    "created_at": "2024-06-10T10:00:00.000Z",
    "updated_at": "2024-06-10T10:00:00.000Z",
    "provider": "aws-s3"
  },
  "document_pdf": {
    "name": "contrato.pdf",
    "url": "https://storage.enspace.com/uploads/contrato.pdf",
    "ext": ".pdf",
    "size": 204800,
    "mime": "application/pdf",
    "hash": "contrato_pdf_e5f6",
    "created_at": "2024-06-10T10:05:00.000Z",
    "updated_at": "2024-06-10T10:05:00.000Z",
    "provider": "aws-s3"
  },
  "lastVersion": null,
  "signed": {
    "pdf": {
      "name": "contrato-assinado.pdf",
      "url": "https://storage.enspace.com/uploads/contrato-assinado.pdf",
      "ext": ".pdf",
      "size": 215000,
      "mime": "application/pdf",
      "hash": "contrato_signed_g7h8",
      "created_at": "2024-06-12T16:00:00.000Z",
      "updated_at": "2024-06-12T16:00:00.000Z",
      "provider": "aws-s3"
    },
    "fileZip": "https://storage.enspace.com/uploads/contrato-evidencias.zip",
    "created_at": "2024-06-12T16:00:00.000Z"
  }
}

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é doc.

Propriedades do objeto:

Propriedades de signed (quando presente):

Especiais

Campos desta categoria possuem comportamentos específicos — anotações, mensagens de chat e tags com estruturas de dados próprias.

Tags — EnlChips

Campo de tags que armazena uma lista de termos inseridos livremente pelo usuário. Útil para categorização dinâmica ou palavras-chave.

• Tipo de dado — Array<String>

["urgente", "revisão", "contrato-2024"]

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é tags.

Anotações — EnNotes

Campo de anotações que armazena uma lista de comentários vinculados ao item. Cada anotação inclui conteúdo, autor, arquivos anexos e status de leitura.

• Tipo de dado — Array<Object>

[
  {
    "id": "note-001",
    "created_at": "2024-06-15T14:30:00.000Z",
    "updated_at": "2024-06-15T14:30:00.000Z",
    "status": "open",
    "type": "comment",
    "content": "Revisar a cláusula 5 antes de enviar ao cliente.",
    "answer": null,
    "files": [],
    "sender": {
      "id": "user-123",
      "name": "Maria Silva",
      "email": "maria@empresa.com",
      "phone": "+5511999999999",
      "avatar": "https://storage.enspace.com/avatars/maria.jpg"
    },
    "seen_by": ["user-456", "user-789"]
  }
]

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é notas.

Propriedades de cada anotação:

Propriedades de sender:

Chat — EnChats

Campo de chat que armazena uma lista de mensagens. A estrutura de dados é idêntica à do Anotações — cada mensagem contém as mesmas propriedades: id, created_at, updated_at, status, type, content, answer, files, sender e seen_by.

• Tipo de dado — Array<Object>

[
  {
    "id": "chat-001",
    "created_at": "2024-06-15T15:00:00.000Z",
    "updated_at": "2024-06-15T15:00:00.000Z",
    "status": "open",
    "type": "message",
    "content": "O documento foi revisado e está pronto para assinatura.",
    "answer": null,
    "files": [],
    "sender": {
      "id": "user-456",
      "name": "Pedro Santos",
      "email": "pedro@empresa.com",
      "phone": null,
      "avatar": null
    },
    "seen_by": ["user-123"]
  }
]

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é mensagens.

Estruturados

Campos desta categoria definem a organização hierárquica dos dados. Agrupam campos relacionados ou permitem múltiplas repetições de um mesmo conjunto de campos.

Grupo — group

Campo de agrupamento que armazena seus campos internos como propriedades de um objeto. As chaves do objeto são as referências dos campos configurados dentro do grupo, e os valores seguem a estrutura de dados de cada tipo.

• Tipo de dado — Object (chaves dinâmicas)

{
  "nome_completo": "João Silva",
  "data_nascimento": "1990-05-20T00:00:00.000Z",
  "ativo": true
}

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é dados_pessoais.

Repetidor — EnRepeater

Campo repetidor que armazena uma lista de registros. Cada registro é um objeto com campos dinâmicos configurados no repetidor.

• Tipo de dado — Array<Object>

[
  {
    "descricao": "Parcela 1",
    "valor": { "currency": "BRL", "value": 500.00 },
    "vencimento": "2024-07-01T00:00:00.000Z"
  },
  {
    "descricao": "Parcela 2",
    "valor": { "currency": "BRL", "value": 500.00 },
    "vencimento": "2024-08-01T00:00:00.000Z"
  }
]

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é parcelas.

Compostos

Campos desta categoria agrupam múltiplas informações relacionadas em um único objeto — como endereços completos ou dados de pessoa física/jurídica. A estrutura interna varia conforme o contexto.

Endereço — EnAddress

Campo de endereço completo que suporta formatos brasileiro e internacional. As propriedades preenchidas dependem da configuração do campo e do país selecionado.

• Tipo de dado — Object

Formato brasileiro:

{
  "cep": "01310-100",
  "street": "Avenida Paulista",
  "number": "1000",
  "complement": "Sala 501",
  "neighborhood": "Bela Vista",
  "city": "São Paulo",
  "state": "SP",
  "country": "Brasil"
}

Formato internacional:

{
  "addressLine1": "350 Fifth Avenue",
  "addressLine2": "Suite 3300",
  "postalCode": "10118",
  "city": "New York",
  "state": "NY",
  "country": "United States"
}

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é endereco.

Propriedades do objeto:

Pessoa/Empresa — EnPerson

Campo de pessoa que armazena dados de pessoa física ou jurídica. A propriedade type define qual subobjeto está preenchido.

• Tipo de dado — Object

Pessoa física:

{
  "type": "natural_person",
  "natural_person": {
    "name": "João Silva",
    "cpf": "123.456.789-00",
    "rg": "12.345.678-9",
    "marital_status": "Casado",
    "profession": "Engenheiro",
    "contact_name": "João Silva",
    "contact_phone": "+5511999999999",
    "contact_email": "joao@email.com"
  }
}

Pessoa jurídica:

{
  "type": "legal_person",
  "legal_person": {
    "cnpj": "12.345.678/0001-00",
    "razao_social": "Empresa Exemplo LTDA",
    "nome_fantasia": "Exemplo Corp",
    "descricao_situacao_cadastral": "Ativa",
    "data_inicio_atividade": "2015-03-10",
    "cnae_fiscal": "6201-5/01",
    "cnae_fiscal_descricao": "Desenvolvimento de programas de computador sob encomenda",
    "contact_name": "Maria Souza",
    "contact_phone": "+5511988888888",
    "contact_email": "contato@exemplo.com"
  }
}

Nos exemplos abaixo, assumimos que a referência do campo configurada no tipo é cliente.

Propriedade raiz:

Propriedades de natural_person (pessoa física):

Propriedades de legal_person (pessoa jurídica):