Class SeiConsultasClient

Operações somente leitura do SEI (listagens e consultas).

Remarks

Esta classe não altera estado no SEI. Ela é deliberadamente fina: recebe config, chama SOAP e devolve tipos TypeScript.

Em aplicações que usam SeiClient, acesse via seiClient.consultas.

See

Constructors

constructor

new SeiConsultasClient(config: SeiConfig): SeiConsultasClient
Parameters
- config: SeiConfig
  Configuração de conexão com o SEI.
Returns SeiConsultasClient
- Defined in packages/sei-client/src/client.ts:286

Methods

adicionarArquivo

adicionarArquivo(params: SeiAdicionarArquivoParams): Promise<string>
Inicia o upload de um arquivo temporário no SEI (upload em partes).
Parameters
- params: SeiAdicionarArquivoParams
  Unidade, nome, tamanho, hash MD5 e primeira parte em Base64.
Returns Promise<string>
O ID do arquivo temporário criado no SEI.
Remarks
Informe o tamanho total em bytes, o hash MD5 hexadecimal do arquivo completo e a primeira parte do conteúdo em Base64. Se a primeira parte não completar o tamanho declarado, envie o restante via adicionarConteudoArquivo. O ID retornado pode ser usado em SeiDocumentoInput.idArquivo.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
See
- adicionarConteudoArquivo
- SeiOperacoesClient.incluirDocumento
- Defined in packages/sei-client/src/client.ts:701

adicionarConteudoArquivo

adicionarConteudoArquivo(
params: SeiAdicionarConteudoArquivoParams,
): Promise<string>
Envia uma parte adicional de conteúdo para um arquivo temporário iniciado por adicionarArquivo.
Parameters
- params: SeiAdicionarConteudoArquivoParams
  Unidade, ID do arquivo e parte do conteúdo em Base64.
Returns Promise<string>
O ID do arquivo temporário.

Remarks
Quando o conteúdo acumulado atinge o tamanho declarado na criação, o SEI valida o hash MD5 informado e ativa o arquivo.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:727

consultarBloco

consultarBloco(
    params: SeiConsultarBlocoParams,
): Promise<
    | Readonly<
        {
            descricao: string;
            estado: string;
            idBloco: string;
            protocolos: Readonly<
                {
                    assinaturas: Readonly<
                        {
                            cargoFuncao: string;
                            dataHora: string;
                            idOrgao: string;
                            idOrigem: string;
                            idUsuario: string;
                            nome: string;
                            sigla: string;
                        },
                    >[];
                    identificacao: string;
                    protocoloFormatado: string;
                },
            >[];
            sinPrioridade: boolean;
            sinRevisao: boolean;
            tipo: string;
            unidade: | Readonly<
                {
                    descricao: string;
                    idUnidade: string;
                    sigla: string;
                    sinArquivamento: boolean;
                    sinOuvidoria: boolean;
                    sinProtocolo: boolean;
                },
            >
            | null;
            unidadesDisponibilizacao: Readonly<
                {
                    descricao: string;
                    idUnidade: string;
                    sigla: string;
                    sinArquivamento: boolean;
                    sinOuvidoria: boolean;
                    sinProtocolo: boolean;
                },
            >[];
            usuario: | Readonly<{ idUsuario: string; nome: string; sigla: string }>
            | null;
            usuarioAtribuicao:
                | Readonly<{ idUsuario: string; nome: string; sigla: string }>
                | null;
        },
    >
    | null,
>
Consulta um bloco (assinatura, reunião ou interno) e, opcionalmente, seus protocolos.
Parameters
- params: SeiConsultarBlocoParams
  Unidade, ID do bloco e sinalizador de retorno de protocolos.
Returns Promise<
    | Readonly<
        {
            descricao: string;
            estado: string;
            idBloco: string;
            protocolos: Readonly<
                {
                    assinaturas: Readonly<
                        {
                            cargoFuncao: string;
                            dataHora: string;
                            idOrgao: string;
                            idOrigem: string;
                            idUsuario: string;
                            nome: string;
                            sigla: string;
                        },
                    >[];
                    identificacao: string;
                    protocoloFormatado: string;
                },
            >[];
            sinPrioridade: boolean;
            sinRevisao: boolean;
            tipo: string;
            unidade: | Readonly<
                {
                    descricao: string;
                    idUnidade: string;
                    sigla: string;
                    sinArquivamento: boolean;
                    sinOuvidoria: boolean;
                    sinProtocolo: boolean;
                },
            >
            | null;
            unidadesDisponibilizacao: Readonly<
                {
                    descricao: string;
                    idUnidade: string;
                    sigla: string;
                    sinArquivamento: boolean;
                    sinOuvidoria: boolean;
                    sinProtocolo: boolean;
                },
            >[];
            usuario: | Readonly<{ idUsuario: string; nome: string; sigla: string }>
            | null;
            usuarioAtribuicao:
                | Readonly<{ idUsuario: string; nome: string; sigla: string }>
                | null;
        },
    >
    | null,
>
Dados do bloco, ou null quando o SEI não retorna corpo.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:504

consultarDocumento

consultarDocumento(
    params: SeiConsultarDocumentoParams,
): Promise<
    | Readonly<
        {
            andamentoGeracao: | Readonly<
                {
                    atributos: Readonly<
                        { idOrigem: string; nome: string; valor: string },
                    >[];
                    dataHora: string;
                    descricao: string;
                    idAndamento: string | null;
                    idTarefa: string | null;
                    idTarefaModulo: string | null;
                    unidade: SeiUnidade;
                    usuario: SeiUsuario;
                },
            >
            | null;
            assinaturas: Readonly<
                {
                    cargoFuncao: string;
                    dataHora: string;
                    idOrgao: string;
                    idOrigem: string;
                    idUsuario: string;
                    nome: string;
                    sigla: string;
                },
            >[];
            blocos: Readonly<
                {
                    descricao: string;
                    estado: string;
                    idBloco: string;
                    sinPrioridade: boolean;
                    sinRevisao: boolean;
                    tipo: string;
                    unidade: SeiUnidade;
                    unidadesDisponibilizacao: Readonly<
                        {
                            descricao: string;
                            idUnidade: string;
                            sigla: string;
                            sinArquivamento: boolean;
                            sinOuvidoria: boolean;
                            sinProtocolo: boolean;
                        },
                    >[];
                    usuario: SeiUsuario;
                    usuarioAtribuicao: SeiUsuario;
                },
            >[];
            campos: Readonly<{ nome: string; valor: string }>[];
            data: string;
            descricao: string;
            dinValor: string | null;
            documentoFormatado: string;
            idDocumento: string;
            idProcedimento: string;
            linkAcesso: string;
            nivelAcessoGlobal: string | null;
            nivelAcessoLocal: string | null;
            nomeArvore: string;
            numero: string;
            procedimentoFormatado: string;
            publicacao:
                | Readonly<
                    {
                        dataDisponibilizacao: string;
                        dataPublicacao: string;
                        estado: string;
                        idDocumento: string
                        | null;
                        idPublicacao: string | null;
                        idVeiculoPublicacao: string | null;
                        imprensaNacional: SeiPublicacaoImprensaNacional;
                        nomeVeiculo: string;
                        numero: string;
                        resumo: string | null;
                        staMotivo: string | null;
                        staTipoVeiculo: string | null;
                    },
                >
                | null;
            serie: | Readonly<
                { aplicabilidade: string
                | null; idSerie: string; nome: string },
            >
            | null;
            unidadeElaboradora:
                | Readonly<
                    {
                        descricao: string;
                        idUnidade: string;
                        sigla: string;
                        sinArquivamento: boolean;
                        sinOuvidoria: boolean;
                        sinProtocolo: boolean;
                    },
                >
                | null;
        },
    >
    | null,
>
Consulta os dados completos de um documento pelo protocolo.
Parameters
- params: SeiConsultarDocumentoParams
  Unidade, protocolo do documento e sinalizadores de retorno.
Returns Promise<
    | Readonly<
        {
            andamentoGeracao: | Readonly<
                {
                    atributos: Readonly<
                        { idOrigem: string; nome: string; valor: string },
                    >[];
                    dataHora: string;
                    descricao: string;
                    idAndamento: string | null;
                    idTarefa: string | null;
                    idTarefaModulo: string | null;
                    unidade: SeiUnidade;
                    usuario: SeiUsuario;
                },
            >
            | null;
            assinaturas: Readonly<
                {
                    cargoFuncao: string;
                    dataHora: string;
                    idOrgao: string;
                    idOrigem: string;
                    idUsuario: string;
                    nome: string;
                    sigla: string;
                },
            >[];
            blocos: Readonly<
                {
                    descricao: string;
                    estado: string;
                    idBloco: string;
                    sinPrioridade: boolean;
                    sinRevisao: boolean;
                    tipo: string;
                    unidade: SeiUnidade;
                    unidadesDisponibilizacao: Readonly<
                        {
                            descricao: string;
                            idUnidade: string;
                            sigla: string;
                            sinArquivamento: boolean;
                            sinOuvidoria: boolean;
                            sinProtocolo: boolean;
                        },
                    >[];
                    usuario: SeiUsuario;
                    usuarioAtribuicao: SeiUsuario;
                },
            >[];
            campos: Readonly<{ nome: string; valor: string }>[];
            data: string;
            descricao: string;
            dinValor: string | null;
            documentoFormatado: string;
            idDocumento: string;
            idProcedimento: string;
            linkAcesso: string;
            nivelAcessoGlobal: string | null;
            nivelAcessoLocal: string | null;
            nomeArvore: string;
            numero: string;
            procedimentoFormatado: string;
            publicacao:
                | Readonly<
                    {
                        dataDisponibilizacao: string;
                        dataPublicacao: string;
                        estado: string;
                        idDocumento: string
                        | null;
                        idPublicacao: string | null;
                        idVeiculoPublicacao: string | null;
                        imprensaNacional: SeiPublicacaoImprensaNacional;
                        nomeVeiculo: string;
                        numero: string;
                        resumo: string | null;
                        staMotivo: string | null;
                        staTipoVeiculo: string | null;
                    },
                >
                | null;
            serie: | Readonly<
                { aplicabilidade: string
                | null; idSerie: string; nome: string },
            >
            | null;
            unidadeElaboradora:
                | Readonly<
                    {
                        descricao: string;
                        idUnidade: string;
                        sigla: string;
                        sinArquivamento: boolean;
                        sinOuvidoria: boolean;
                        sinProtocolo: boolean;
                    },
                >
                | null;
        },
    >
    | null,
>
Dados do documento, ou null quando o SEI não retorna corpo.

Remarks
Os sinalizadores sinRetornar* seguem o padrão "S", exceto sinRetornarBlocos, que por padrão é "N" por ser a consulta mais custosa no SEI.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:478

consultarProcedimento

consultarProcedimento(
    params: SeiConsultarProcedimentoParams,
): Promise<
    | Readonly<
        {
            andamentoConclusao: | Readonly<
                {
                    atributos: Readonly<
                        { idOrigem: string; nome: string; valor: string },
                    >[];
                    dataHora: string;
                    descricao: string;
                    idAndamento: string | null;
                    idTarefa: string | null;
                    idTarefaModulo: string | null;
                    unidade: SeiUnidade;
                    usuario: SeiUsuario;
                },
            >
            | null;
            andamentoGeracao: | Readonly<
                {
                    atributos: Readonly<
                        { idOrigem: string; nome: string; valor: string },
                    >[];
                    dataHora: string;
                    descricao: string;
                    idAndamento: string | null;
                    idTarefa: string | null;
                    idTarefaModulo: string | null;
                    unidade: SeiUnidade;
                    usuario: SeiUsuario;
                },
            >
            | null;
            assuntos: Readonly<
                { codigoEstruturado: string; descricao: string
                | null },
            >[];
            dataAutuacao: string;
            especificacao: string;
            idProcedimento: string;
            interessados: Readonly<
                {
                    cnpj: string
                    | null;
                    cpf: string | null;
                    idContato: string | null;
                    nome: string | null;
                    sigla: string | null;
                },
            >[];
            linkAcesso: string;
            nivelAcessoGlobal: string
            | null;
            nivelAcessoLocal: string | null;
            observacoes: Readonly<{ descricao: string; unidade: SeiUnidade }>[];
            procedimentoFormatado: string;
            procedimentosAnexados: Readonly<
                {
                    idProcedimento: string;
                    procedimentoFormatado: string;
                    tipoProcedimento: SeiTipoProcedimento;
                },
            >[];
            procedimentosRelacionados: Readonly<
                {
                    idProcedimento: string;
                    procedimentoFormatado: string;
                    tipoProcedimento: SeiTipoProcedimento;
                },
            >[];
            tipoPrioridade: | Readonly<{ idTipoPrioridade: string; nome: string }>
            | null;
            tipoProcedimento: SeiTipoProcedimento;
            ultimoAndamento:
                | Readonly<
                    {
                        atributos: Readonly<
                            { idOrigem: string; nome: string; valor: string },
                        >[];
                        dataHora: string;
                        descricao: string;
                        idAndamento: string | null;
                        idTarefa: string | null;
                        idTarefaModulo: string | null;
                        unidade: SeiUnidade;
                        usuario: SeiUsuario;
                    },
                >
                | null;
            unidadesProcedimentoAberto: Readonly<
                { unidade: SeiUnidade; usuarioAtribuicao: SeiUsuario },
            >[];
        },
    >
    | null,
>
Consulta os dados completos de um processo pelo protocolo.
Parameters
- params: SeiConsultarProcedimentoParams
  Unidade, protocolo do processo e sinalizadores de retorno.
Returns Promise<
    | Readonly<
        {
            andamentoConclusao: | Readonly<
                {
                    atributos: Readonly<
                        { idOrigem: string; nome: string; valor: string },
                    >[];
                    dataHora: string;
                    descricao: string;
                    idAndamento: string | null;
                    idTarefa: string | null;
                    idTarefaModulo: string | null;
                    unidade: SeiUnidade;
                    usuario: SeiUsuario;
                },
            >
            | null;
            andamentoGeracao: | Readonly<
                {
                    atributos: Readonly<
                        { idOrigem: string; nome: string; valor: string },
                    >[];
                    dataHora: string;
                    descricao: string;
                    idAndamento: string | null;
                    idTarefa: string | null;
                    idTarefaModulo: string | null;
                    unidade: SeiUnidade;
                    usuario: SeiUsuario;
                },
            >
            | null;
            assuntos: Readonly<
                { codigoEstruturado: string; descricao: string
                | null },
            >[];
            dataAutuacao: string;
            especificacao: string;
            idProcedimento: string;
            interessados: Readonly<
                {
                    cnpj: string
                    | null;
                    cpf: string | null;
                    idContato: string | null;
                    nome: string | null;
                    sigla: string | null;
                },
            >[];
            linkAcesso: string;
            nivelAcessoGlobal: string
            | null;
            nivelAcessoLocal: string | null;
            observacoes: Readonly<{ descricao: string; unidade: SeiUnidade }>[];
            procedimentoFormatado: string;
            procedimentosAnexados: Readonly<
                {
                    idProcedimento: string;
                    procedimentoFormatado: string;
                    tipoProcedimento: SeiTipoProcedimento;
                },
            >[];
            procedimentosRelacionados: Readonly<
                {
                    idProcedimento: string;
                    procedimentoFormatado: string;
                    tipoProcedimento: SeiTipoProcedimento;
                },
            >[];
            tipoPrioridade: | Readonly<{ idTipoPrioridade: string; nome: string }>
            | null;
            tipoProcedimento: SeiTipoProcedimento;
            ultimoAndamento:
                | Readonly<
                    {
                        atributos: Readonly<
                            { idOrigem: string; nome: string; valor: string },
                        >[];
                        dataHora: string;
                        descricao: string;
                        idAndamento: string | null;
                        idTarefa: string | null;
                        idTarefaModulo: string | null;
                        unidade: SeiUnidade;
                        usuario: SeiUsuario;
                    },
                >
                | null;
            unidadesProcedimentoAberto: Readonly<
                { unidade: SeiUnidade; usuarioAtribuicao: SeiUsuario },
            >[];
        },
    >
    | null,
>
Dados do processo, ou null quando o SEI não retorna corpo.
Remarks
Por padrão todos os sinalizadores sinRetornar* são enviados como "S", retornando assuntos, interessados, observações, andamentos, unidades abertas e processos relacionados/anexados. Desligue os blocos que não precisa ("N") para reduzir o custo da consulta no SEI.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault (ex.: processo inexistente ou sem acesso pela unidade).
Example
```
const proc = await sei.consultas.consultarProcedimento({
  idUnidade: "110000001",
  protocoloProcedimento: "00000.000001/2026-01",
  sinRetornarAndamentoConclusao: "N",
})
```
- Defined in packages/sei-client/src/client.ts:419

consultarProcedimentoIndividual

consultarProcedimentoIndividual(
    params: SeiConsultarProcedimentoIndividualParams,
): Promise<
    | Readonly<
        {
            idProcedimento: string;
            procedimentoFormatado: string;
            tipoProcedimento: SeiTipoProcedimento;
        },
    >
    | null,
>
Consulta o procedimento individual de um usuário (tipos de processo com autuação individual, ex.: dossiê funcional).
Parameters
- params: SeiConsultarProcedimentoIndividualParams
  Unidade, órgão do procedimento, tipo de procedimento e identificação do usuário (órgão + sigla).
Returns Promise<
    | Readonly<
        {
            idProcedimento: string;
            procedimentoFormatado: string;
            tipoProcedimento: SeiTipoProcedimento;
        },
    >
    | null,
>
Referência resumida ao processo, ou null se não encontrado.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:450

consultarPublicacao

consultarPublicacao(
    params: SeiConsultarPublicacaoParams,
): Promise<
    | Readonly<
        {
            andamento: | Readonly<
                {
                    atributos: Readonly<
                        { idOrigem: string; nome: string; valor: string },
                    >[];
                    dataHora: string;
                    descricao: string;
                    idAndamento: string | null;
                    idTarefa: string | null;
                    idTarefaModulo: string | null;
                    unidade: SeiUnidade;
                    usuario: SeiUsuario;
                },
            >
            | null;
            assinaturas: Readonly<
                {
                    cargoFuncao: string;
                    dataHora: string;
                    idOrgao: string;
                    idOrigem: string;
                    idUsuario: string;
                    nome: string;
                    sigla: string;
                },
            >[];
            publicacao: | Readonly<
                {
                    dataDisponibilizacao: string;
                    dataPublicacao: string;
                    estado: string;
                    idDocumento: string
                    | null;
                    idPublicacao: string | null;
                    idVeiculoPublicacao: string | null;
                    imprensaNacional: SeiPublicacaoImprensaNacional;
                    nomeVeiculo: string;
                    numero: string;
                    resumo: string | null;
                    staMotivo: string | null;
                    staTipoVeiculo: string | null;
                },
            >
            | null;
        },
    >
    | null,
>
Consulta uma publicação oficial associada a um documento.
Parameters
- params: SeiConsultarPublicacaoParams
  Unidade e identificação da publicação (idPublicacao, idDocumento ou protocoloDocumento), com sinalizadores de retorno.
Returns Promise<
    | Readonly<
        {
            andamento: | Readonly<
                {
                    atributos: Readonly<
                        { idOrigem: string; nome: string; valor: string },
                    >[];
                    dataHora: string;
                    descricao: string;
                    idAndamento: string | null;
                    idTarefa: string | null;
                    idTarefaModulo: string | null;
                    unidade: SeiUnidade;
                    usuario: SeiUsuario;
                },
            >
            | null;
            assinaturas: Readonly<
                {
                    cargoFuncao: string;
                    dataHora: string;
                    idOrgao: string;
                    idOrigem: string;
                    idUsuario: string;
                    nome: string;
                    sigla: string;
                },
            >[];
            publicacao: | Readonly<
                {
                    dataDisponibilizacao: string;
                    dataPublicacao: string;
                    estado: string;
                    idDocumento: string
                    | null;
                    idPublicacao: string | null;
                    idVeiculoPublicacao: string | null;
                    imprensaNacional: SeiPublicacaoImprensaNacional;
                    nomeVeiculo: string;
                    numero: string;
                    resumo: string | null;
                    staMotivo: string | null;
                    staTipoVeiculo: string | null;
                },
            >
            | null;
        },
    >
    | null,
>
Dados da publicação, ou null quando o SEI não retorna corpo.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.

See
SeiOperacoesClient.agendarPublicacao
- Defined in packages/sei-client/src/client.ts:813

listarAndamentos

listarAndamentos(
    params: SeiListarAndamentosParams,
): Promise<
    Readonly<
        {
            atributos: Readonly<{ idOrigem: string; nome: string; valor: string }>[];
            dataHora: string;
            descricao: string;
            idAndamento: string | null;
            idTarefa: string | null;
            idTarefaModulo: string | null;
            unidade: SeiUnidade;
            usuario: SeiUsuario;
        },
    >[],
>
Lista o histórico de andamentos de um processo.
Parameters
- params: SeiListarAndamentosParams
  Unidade, protocolo do processo e filtros opcionais por andamentos, tarefas e tarefas de módulos.
Returns Promise<
    Readonly<
        {
            atributos: Readonly<{ idOrigem: string; nome: string; valor: string }>[];
            dataHora: string;
            descricao: string;
            idAndamento: string | null;
            idTarefa: string | null;
            idTarefaModulo: string | null;
            unidade: SeiUnidade;
            usuario: SeiUsuario;
        },
    >[],
>
Lista de andamentos do processo.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:747

listarAndamentosMarcadores

listarAndamentosMarcadores(
    params: SeiListarAndamentosMarcadoresParams,
): Promise<
    Readonly<
        {
            dataHora: string;
            idAndamentoMarcador: string
            | null;
            marcador: SeiMarcador;
            texto: string;
            usuario: SeiUsuario;
        },
    >[],
>
Lista os andamentos de marcadores registrados em um processo.
Parameters
- params: SeiListarAndamentosMarcadoresParams
  Unidade, protocolo do processo e filtro opcional por IDs de marcadores.
Returns Promise<
    Readonly<
        {
            dataHora: string;
            idAndamentoMarcador: string
            | null;
            marcador: SeiMarcador;
            texto: string;
            usuario: SeiUsuario;
        },
    >[],
>
Lista de andamentos de marcadores.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.

See
SeiOperacoesClient.definirMarcador
- Defined in packages/sei-client/src/client.ts:789

listarCargos

listarCargos(
    params: SeiListarCargosParams,
): Promise<
    Readonly<
        {
            expressaoCargo: string;
            expressaoTratamento: string;
            expressaoVocativo: string;
            idCargo: string;
        },
    >[],
>
Lista os cargos cadastrados no SEI.
Parameters
- params: SeiListarCargosParams
  Unidade e filtro opcional por ID de cargo.
Returns Promise<
    Readonly<
        {
            expressaoCargo: string;
            expressaoTratamento: string;
            expressaoVocativo: string;
            idCargo: string;
        },
    >[],
>
Lista de cargos com expressões de tratamento e vocativo.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:673

listarCidades

listarCidades(
    params: SeiListarCidadesParams,
): Promise<
    Readonly<
        {
            codigoIbge: string;
            idCidade: string;
            idEstado: string;
            idPais: string;
            latitude: string;
            longitude: string;
            nome: string;
            sinCapital: boolean;
        },
    >[],
>
Lista os municípios cadastrados no SEI.
Parameters
- params: SeiListarCidadesParams
  Unidade e filtros opcionais por país e estado.
Returns Promise<
    Readonly<
        {
            codigoIbge: string;
            idCidade: string;
            idEstado: string;
            idPais: string;
            latitude: string;
            longitude: string;
            nome: string;
            sinCapital: boolean;
        },
    >[],
>
Lista de municípios.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:630

listarContatos

listarContatos(
    params: SeiListarContatosParams,
): Promise<
    Readonly<
        {
            abreviaturaTitulo: string
            | null;
            bairro: string;
            cep: string;
            cnpj: string;
            cnpjAssociado: string | null;
            complemento: string;
            conjuge: string | null;
            cpf: string;
            dataNascimento: string;
            email: string;
            endereco: string;
            expressaoCargo: string | null;
            expressaoTitulo: string | null;
            expressaoTratamento: string | null;
            expressaoVocativo: string | null;
            funcao: string | null;
            idCargo: string | null;
            idCategoria: string | null;
            idCidade: string | null;
            idContato: string;
            idContatoAssociado: string | null;
            idEstado: string | null;
            idNomeCategoria: string | null;
            idPais: string | null;
            idPaisPassaporte: string | null;
            idTipoContato: string;
            idTitulo: string | null;
            matricula: string;
            matriculaOab: string;
            nome: string;
            nomeCidade: string | null;
            nomeContatoAssociado: string | null;
            nomePais: string | null;
            nomePaisPassaporte: string | null;
            nomeSocial: string | null;
            nomeTipoContato: string | null;
            numeroPassaporte: string | null;
            observacao: string;
            orgaoExpedidor: string;
            rg: string;
            sigla: string;
            siglaEstado: string | null;
            sinAtivo: boolean;
            sinEnderecoAssociado: boolean;
            sitioInternet: string;
            staGenero: string;
            staNatureza: string;
            staOperacao: string | null;
            telefoneCelular: string;
            telefoneComercial: string;
            telefoneResidencial: string;
        },
    >[],
>
Lista contatos cadastrados no SEI com filtros combinativos e paginação.
Parameters
- params: SeiListarContatosParams
  Unidade, filtros (tipo, sigla, nome, CPF, CNPJ, matrícula, IDs) e controle de paginação (paginaRegistros/paginaAtual).
Returns Promise<
    Readonly<
        {
            abreviaturaTitulo: string
            | null;
            bairro: string;
            cep: string;
            cnpj: string;
            cnpjAssociado: string | null;
            complemento: string;
            conjuge: string | null;
            cpf: string;
            dataNascimento: string;
            email: string;
            endereco: string;
            expressaoCargo: string | null;
            expressaoTitulo: string | null;
            expressaoTratamento: string | null;
            expressaoVocativo: string | null;
            funcao: string | null;
            idCargo: string | null;
            idCategoria: string | null;
            idCidade: string | null;
            idContato: string;
            idContatoAssociado: string | null;
            idEstado: string | null;
            idNomeCategoria: string | null;
            idPais: string | null;
            idPaisPassaporte: string | null;
            idTipoContato: string;
            idTitulo: string | null;
            matricula: string;
            matriculaOab: string;
            nome: string;
            nomeCidade: string | null;
            nomeContatoAssociado: string | null;
            nomePais: string | null;
            nomePaisPassaporte: string | null;
            nomeSocial: string | null;
            nomeTipoContato: string | null;
            numeroPassaporte: string | null;
            observacao: string;
            orgaoExpedidor: string;
            rg: string;
            sigla: string;
            siglaEstado: string | null;
            sinAtivo: boolean;
            sinEnderecoAssociado: boolean;
            sitioInternet: string;
            staGenero: string;
            staNatureza: string;
            staOperacao: string | null;
            telefoneCelular: string;
            telefoneComercial: string;
            telefoneResidencial: string;
        },
    >[],
>
Lista de contatos que atendem aos filtros.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:377

listarEstados

listarEstados(
    params: SeiListarEstadosParams,
): Promise<
    Readonly<
        {
            codigoIbge: string;
            idEstado: string;
            idPais: string;
            nome: string;
            sigla: string;
        },
    >[],
>
Lista os estados/UF cadastrados no SEI.
Parameters
- params: SeiListarEstadosParams
  Unidade e filtro opcional por país.
Returns Promise<
    Readonly<
        {
            codigoIbge: string;
            idEstado: string;
            idPais: string;
            nome: string;
            sigla: string;
        },
    >[],
>
Lista de estados.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:612

listarExtensoesPermitidas

listarExtensoesPermitidas(
    params: SeiListarExtensoesPermitidasParams,
): Promise<
    Readonly<
        { descricao: string; extensao: string; idArquivoExtensao: string },
    >[],
>
Lista as extensões de arquivo permitidas para upload no SEI.
Parameters
- params: SeiListarExtensoesPermitidasParams
  Unidade e filtro opcional por ID de extensão.
Returns Promise<
    Readonly<
        { descricao: string; extensao: string; idArquivoExtensao: string },
    >[],
>
Lista de extensões permitidas.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:523

listarFeriados

listarFeriados(
params: SeiListarFeriadosParams,
): Promise<Readonly<{ data: string; descricao: string }>[]>
Lista os feriados cadastrados para o órgão/unidade em um período.
Parameters
- params: SeiListarFeriadosParams
  Unidade e filtros opcionais por órgão e intervalo de datas.
Returns Promise<Readonly<{ data: string; descricao: string }>[]>
Lista de feriados.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:837

listarHipotesesLegais

listarHipotesesLegais(
    params: SeiListarHipotesesLegaisParams,
): Promise<
    Readonly<
        {
            baseLegal: string;
            idHipoteseLegal: string;
            nivelAcesso: string;
            nome: string;
        },
    >[],
>
Lista as hipóteses legais de restrição de acesso configuradas no SEI.
Parameters
- params: SeiListarHipotesesLegaisParams
  Unidade e filtro opcional por nível de acesso ("1" restrito, "2" sigiloso).
Returns Promise<
    Readonly<
        {
            baseLegal: string;
            idHipoteseLegal: string;
            nivelAcesso: string;
            nome: string;
        },
    >[],
>
Lista de hipóteses legais.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:562

listarMarcadoresUnidade

listarMarcadoresUnidade(
    params: SeiListarMarcadoresUnidadeParams,
): Promise<
    Readonly<
        { icone: string; idMarcador: string; nome: string; sinAtivo: boolean },
    >[],
>
Lista os marcadores configurados para a unidade.
Parameters
- params: SeiListarMarcadoresUnidadeParams
  Unidade de contexto da consulta.
Returns Promise<
    Readonly<
        { icone: string; idMarcador: string; nome: string; sinAtivo: boolean },
    >[],
>
Lista de marcadores da unidade.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.

See
SeiOperacoesClient.definirMarcador
- Defined in packages/sei-client/src/client.ts:771

listarPaises

listarPaises(
params: SeiListarPaisesParams,
): Promise<Readonly<{ idPais: string; nome: string }>[]>
Lista os países cadastrados no SEI.
Parameters
- params: SeiListarPaisesParams
  Unidade de contexto da consulta.
Returns Promise<Readonly<{ idPais: string; nome: string }>[]>
Lista de países.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:597

listarSeries

listarSeries(
    params: SeiListarSeriesParams,
): Promise<
    Readonly<
        { aplicabilidade: string
        | null; idSerie: string; nome: string },
    >[],
>
Lista as séries (tipos de documento) disponíveis na unidade.
Parameters
- params: SeiListarSeriesParams
  Unidade e filtro opcional por tipo de procedimento.
Returns Promise<
    Readonly<
        { aplicabilidade: string
        | null; idSerie: string; nome: string },
    >[],
>
Lista de séries documentais.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:358

listarTiposConferencia

listarTiposConferencia(
params: SeiListarTiposConferenciaParams,
): Promise<Readonly<{ descricao: string; idTipoConferencia: string }>[]>
Lista os tipos de conferência usados em documentos digitalizados.
Parameters
- params: SeiListarTiposConferenciaParams
  Unidade de contexto da consulta.
Returns Promise<Readonly<{ descricao: string; idTipoConferencia: string }>[]>
Lista de tipos de conferência.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:580

listarTiposPrioridade

listarTiposPrioridade(
params: SeiListarTiposPrioridadeParams,
): Promise<Readonly<{ idTipoPrioridade: string; nome: string }>[]>
Lista os tipos de prioridade de processo configurados no SEI.
Parameters
- params: SeiListarTiposPrioridadeParams
  Unidade de contexto da consulta.
Returns Promise<Readonly<{ idTipoPrioridade: string; nome: string }>[]>
Lista de tipos de prioridade.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:341

listarTiposProcedimento

listarTiposProcedimento(
    params: SeiListarTiposProcedimentoParams,
): Promise<
    Readonly<
        {
            idTipoProcedimento: string;
            nome: string;
            sinOuvidoriaAnonimo: boolean;
        },
    >[],
>
Lista os tipos de procedimento (tipos de processo) disponíveis na unidade.
Parameters
- params: SeiListarTiposProcedimentoParams
  Unidade e filtros opcionais por série e individualização.
Returns Promise<
    Readonly<
        {
            idTipoProcedimento: string;
            nome: string;
            sinOuvidoriaAnonimo: boolean;
        },
    >[],
>
Lista de tipos de procedimento.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:320

listarTiposProcedimentoOuvidoria

listarTiposProcedimentoOuvidoria(): Promise<
    Readonly<
        {
            idTipoProcedimento: string;
            nome: string;
            sinOuvidoriaAnonimo: boolean;
        },
    >[],
>
Lista os tipos de procedimento habilitados para manifestações de ouvidoria.

Returns Promise<
    Readonly<
        {
            idTipoProcedimento: string;
            nome: string;
            sinOuvidoriaAnonimo: boolean;
        },
    >[],
>
Lista de tipos de procedimento de ouvidoria.

Remarks
Diferente das demais consultas, esta operação não exige unidade: o SEI a resolve apenas com as credenciais do sistema integrador.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.

See
SeiOperacoesClient.registrarOuvidoria
- Defined in packages/sei-client/src/client.ts:655

listarUnidades

listarUnidades(
    params?: SeiListarUnidadesParams,
): Promise<
    Readonly<
        {
            descricao: string;
            idUnidade: string;
            sigla: string;
            sinArquivamento: boolean;
            sinOuvidoria: boolean;
            sinProtocolo: boolean;
        },
    >[],
>
Lista as unidades liberadas para o sistema integrador no SEI.
Parameters
- params: SeiListarUnidadesParams = {}
  Filtros opcionais por tipo de procedimento e série.
Returns Promise<
    Readonly<
        {
            descricao: string;
            idUnidade: string;
            sigla: string;
            sinArquivamento: boolean;
            sinOuvidoria: boolean;
            sinProtocolo: boolean;
        },
    >[],
>
Lista de unidades habilitadas para a integração.
Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
Example
```
const unidades = await sei.consultas.listarUnidades()
```
- Defined in packages/sei-client/src/client.ts:300

listarUsuarios

listarUsuarios(
params: SeiListarUsuariosParams,
): Promise<Readonly<{ idUsuario: string; nome: string; sigla: string }>[]>
Lista os usuários com acesso à unidade informada.
Parameters
- params: SeiListarUsuariosParams
  Unidade e filtro opcional por ID de usuário.
Returns Promise<Readonly<{ idUsuario: string; nome: string; sigla: string }>[]>
Lista de usuários da unidade.

Throws
SeiSoapError em caso de falha de comunicação ou SOAP Fault.
- Defined in packages/sei-client/src/client.ts:543

Class SeiConsultasClient

Remarks

See

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SeiConsultasClient

Methods

adicionarArquivo

Parameters

Returns Promise<string>

Remarks

Throws

See

adicionarConteudoArquivo

Parameters

Returns Promise<string>

Remarks

Throws

consultarBloco

Parameters

Throws

consultarDocumento

Parameters

Remarks

Throws

consultarProcedimento

Parameters

Remarks

Throws

Example

consultarProcedimentoIndividual

Parameters

Returns Promise< | Readonly< { idProcedimento: string; procedimentoFormatado: string; tipoProcedimento: SeiTipoProcedimento; }, > | null,>

Throws

consultarPublicacao

Parameters

Throws

See

listarAndamentos

Parameters

Returns Promise< Readonly< { atributos: Readonly<{ idOrigem: string; nome: string; valor: string }>[]; dataHora: string; descricao: string; idAndamento: string | null; idTarefa: string | null; idTarefaModulo: string | null; unidade: SeiUnidade; usuario: SeiUsuario; }, >[],>

Throws

listarAndamentosMarcadores

Parameters

Returns Promise< Readonly< { dataHora: string; idAndamentoMarcador: string | null; marcador: SeiMarcador; texto: string; usuario: SeiUsuario; }, >[],>

Throws

See

listarCargos

Parameters

Returns Promise< Readonly< { expressaoCargo: string; expressaoTratamento: string; expressaoVocativo: string; idCargo: string; }, >[],>

Throws

listarCidades

Parameters

Returns Promise< Readonly< { codigoIbge: string; idCidade: string; idEstado: string; idPais: string; latitude: string; longitude: string; nome: string; sinCapital: boolean; }, >[],>

Throws

listarContatos

Parameters

Throws

listarEstados

Parameters

Returns Promise< Readonly< { codigoIbge: string; idEstado: string; idPais: string; nome: string; sigla: string; }, >[],>

Throws

listarExtensoesPermitidas

Parameters

Returns Promise< Readonly< { descricao: string; extensao: string; idArquivoExtensao: string }, >[],>

Throws

listarFeriados

Parameters

Returns Promise<Readonly<{ data: string; descricao: string }>[]>

Throws

listarHipotesesLegais

Parameters

Returns Promise< Readonly< { baseLegal: string; idHipoteseLegal: string; nivelAcesso: string; nome: string; }, >[],>

Throws

listarMarcadoresUnidade

Parameters

Returns Promise<
| Readonly<
{
idProcedimento: string;
procedimentoFormatado: string;
tipoProcedimento: SeiTipoProcedimento;
},
>
| null,
>

Returns Promise<
Readonly<
{
atributos: Readonly<{ idOrigem: string; nome: string; valor: string }>[];
dataHora: string;
descricao: string;
idAndamento: string | null;
idTarefa: string | null;
idTarefaModulo: string | null;
unidade: SeiUnidade;
usuario: SeiUsuario;
},
>[],
>

Returns Promise<
Readonly<
{
dataHora: string;
idAndamentoMarcador: string
| null;
marcador: SeiMarcador;
texto: string;
usuario: SeiUsuario;
},
>[],
>

Returns Promise<
Readonly<
{
expressaoCargo: string;
expressaoTratamento: string;
expressaoVocativo: string;
idCargo: string;
},
>[],
>

Returns Promise<
Readonly<
{
codigoIbge: string;
idCidade: string;
idEstado: string;
idPais: string;
latitude: string;
longitude: string;
nome: string;
sinCapital: boolean;
},
>[],
>

Returns Promise<
Readonly<
{
codigoIbge: string;
idEstado: string;
idPais: string;
nome: string;
sigla: string;
},
>[],
>

Returns Promise<
Readonly<
{ descricao: string; extensao: string; idArquivoExtensao: string },
>[],
>

Returns Promise<
Readonly<
{
baseLegal: string;
idHipoteseLegal: string;
nivelAcesso: string;
nome: string;
},
>[],
>

Returns Promise<
Readonly<
{ icone: string; idMarcador: string; nome: string; sinAtivo: boolean },
>[],
>

Returns Promise<
Readonly<
{ aplicabilidade: string
| null; idSerie: string; nome: string },
>[],
>

Returns Promise<
Readonly<
{
idTipoProcedimento: string;
nome: string;
sinOuvidoriaAnonimo: boolean;
},
>[],
>

Returns Promise<
Readonly<
{
idTipoProcedimento: string;
nome: string;
sinOuvidoriaAnonimo: boolean;
},
>[],
>

Returns Promise<
Readonly<
{
descricao: string;
idUnidade: string;
sigla: string;
sinArquivamento: boolean;
sinOuvidoria: boolean;
sinProtocolo: boolean;
},
>[],
>