CaixaPostalService class

Serviço: CAIXA POSTAL (Caixa Postal do Simples Nacional)

A Caixa Postal é um sistema de comunicação entre a Receita Federal e os contribuintes do Simples Nacional.

Este serviço disponibiliza APENAS os 3 serviços oficiais da API SERPRO:

  • MSGCONTRIBUINTE61: Obter Lista de Mensagens por Contribuintes
  • MSGDETALHAMENTO62: Obter Detalhes de uma Mensagem Específica
  • INNOVAMSG63: Obter Indicador de Novas Mensagens

Documentação oficial: .cursor/rules/caixapostal.mdc

Observação sobre variáveis: O campo assuntoModelo pode conter ++VARIAVEL++ que é substituído pelo valor de valorParametroAssunto. O campo corpoModelo pode conter ++1++, ++2++, etc. que são substituídos pelos valores do array variaveis. Exemplo: "IRPF Declaração do exercício ++VARIAVEL++ processada" com valorParametroAssunto="2023" resulta em: "IRPF Declaração do exercício 2023 processada"

Exemplo de uso:

final caixaPostalService = CaixaPostalService(apiClient);

// 1. Obter lista de mensagens
final mensagens = await caixaPostalService.obterListaMensagensPorContribuinte(
  '12345678000190',
  statusLeitura: 2, // 0=Todas, 1=Lida, 2=Não lida
  indicadorFavorito: null, // 0=Não favorita, 1=Favorita, null=Sem filtro
);

// 2. Obter detalhes de uma mensagem
final detalhes = await caixaPostalService.obterDetalhesMensagemEspecifica(
  '12345678000190',
  '0001626772', // ISN da mensagem
);

// 3. Obter indicador de novas mensagens
final indicador = await caixaPostalService.obterIndicadorNovasMensagens('12345678000190');

Constructors

CaixaPostalService(ApiClient _apiClient)

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
obterDetalhesMensagemEspecifica(String? contribuinte, String isn, {String? contratanteNumero, String? autorPedidoDadosNumero}) Future<DetalhesMensagemResponse>
Obtém os detalhes de uma mensagem específica
obterIndicadorNovasMensagens(String? contribuinte, {String? contratanteNumero, String? autorPedidoDadosNumero}) Future<IndicadorMensagensResponse>
Obtém o indicador de mensagens novas para um contribuinte
obterListaMensagensPorContribuinte(String? contribuinte, {String? cnpjReferencia, int statusLeitura = 0, int? indicadorFavorito, int indicadorPagina = 0, String? ponteiroPagina, String? contratanteNumero, String? autorPedidoDadosNumero}) Future<ListaMensagensResponse>
Obtém a lista de mensagens da Caixa Postal de um contribuinte
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited