PagtoWebService class
Serviço: PAGTOWEB (Sistema de Pagamentos do Simples Nacional)
O PAGTOWEB é o sistema para consulta de pagamentos do Simples Nacional.
Este serviço disponibiliza APENAS 3 serviços oficiais da API SERPRO:
- PAGAMENTOS71: Consultar pagamentos com filtros
- CONTACONSDOCARRPG73: Contar documentos de pagamento
- EMITECOMPROVANTEPAGAMENTO72: Emitir comprovante de pagamento em PDF
Métodos de conveniência: Este serviço também oferece métodos auxiliares que facilitam o uso dos 3 serviços principais, pré-configurando filtros específicos. Estes métodos NÃO são serviços distintos da API.
Documentação oficial: .cursor/rules/pagtoweb.mdc
Exemplo de uso:
final pagtoWebService = PagtoWebService(apiClient);
// Consultar pagamentos
final pagamentos = await pagtoWebService.consultarPagamentos(
contribuinteNumero: '12345678000190',
dataInicial: '2024-01-01',
dataFinal: '2024-12-31',
);
print('Total de pagamentos: ${pagamentos.totalRegistros}');
// Emitir comprovante
final comprovante = await pagtoWebService.emitirComprovante(
numeroDocumento: '123456789',
codigoTipoDocumento: '001',
);
print('Comprovante PDF: ${comprovante.pdfBase64}');
Constructors
- PagtoWebService(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
-
consultarPagamentos(
{String? contribuinteNumero, String? dataInicial, String? dataFinal, List< String> ? codigoReceitaLista, double? valorInicial, double? valorFinal, List<String> ? numeroDocumentoLista, List<String> ? codigoTipoDocumentoLista, int primeiroDaPagina = 0, int tamanhoDaPagina = 100, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future<ConsultarPagamentosResponse> - Consulta pagamentos com filtros opcionais
-
consultarPagamentosPorCodigoReceitaLista(
{String? contribuinteNumero, required List< String> codigoReceitaLista, int primeiroDaPagina = 0, int tamanhoDaPagina = 100, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future<ConsultarPagamentosResponse> - Método de conveniência: Consultar pagamentos por código de receita
-
consultarPagamentosPorIntervaloDataArrecadacao(
{String? contribuinteNumero, required String dataInicial, required String dataFinal, int primeiroDaPagina = 0, int tamanhoDaPagina = 100, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future< ConsultarPagamentosResponse> - Método de conveniência: Consultar pagamentos por intervalo de datas
-
consultarPagamentosPorIntervaloValorTotalDocumento(
{String? contribuinteNumero, required double valorInicial, required double valorFinal, int primeiroDaPagina = 0, int tamanhoDaPagina = 100, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future< ConsultarPagamentosResponse> - Método de conveniência: Consultar pagamentos por intervalo de valores
-
contarPagamentos(
{String? contribuinteNumero, String? dataInicial, String? dataFinal, List< String> ? codigoReceitaLista, double? valorInicial, double? valorFinal, List<String> ? numeroDocumentoLista, List<String> ? codigoTipoDocumentoLista, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future<ContarPagamentosResponse> - Conta pagamentos com filtros opcionais
-
contarPagamentosPorCodigoReceitaLista(
{String? contribuinteNumero, required List< String> codigoReceitaLista, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future<ContarPagamentosResponse> - Método de conveniência: Contar pagamentos por código de receita
-
contarPagamentosPorIntervaloDataArrecadacao(
{String? contribuinteNumero, required String dataInicial, required String dataFinal, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future< ContarPagamentosResponse> - Método de conveniência: Contar pagamentos por intervalo de datas
-
contarPagamentosPorIntervaloValorTotalDocumento(
{String? contribuinteNumero, required double valorInicial, required double valorFinal, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future< ContarPagamentosResponse> - Método de conveniência: Contar pagamentos por intervalo de valores
-
emitirComprovante(
{String? contribuinteNumero, required String numeroDocumento, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future< EmitirComprovanteResponse> - Emite comprovante de pagamento
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited