DctfWebService class

Serviço: DCTFWeb (Declaração de Débitos e Créditos Tributários Federais)

Serviço para declaração e apuração de débitos e créditos tributários federais. A DCTFWeb substituiu a DCTF para empresas do Simples Nacional e outras.

Este serviço permite:

  • Gerar Documento de Arrecadação (DARF/DAE)
  • Consultar Recibo de transmissão
  • Consultar Declaração Completa
  • Consultar/Gerar XML da declaração
  • Transmitir declaração
  • Gerar Documento para declaração em andamento

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

Exemplo de uso:

final dctfwebService = DctfWebService(apiClient);

// Gerar guia de pagamento
final guia = await dctfwebService.gerarDocumentoArrecadacao(
  contribuinteNumero: '12345678000190',
  categoria: CategoriaDctf.mensal,
  anoPA: '2024',
  mesPA: '03',
);

Constructors

DctfWebService(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

consultarDeclaracaoCompleta({String? contribuinteNumero, required CategoriaDctf categoria, required String anoPA, String? mesPA, String? diaPA, int? cnoAfericao, int? numeroReciboEntrega, String? numProcReclamatoria, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future<ConsultarRelatorioResponse>
Consulta relatório de declaração completa transmitida
consultarReciboTransmissao({String? contribuinteNumero, required CategoriaDctf categoria, required String anoPA, String? mesPA, String? diaPA, int? cnoAfericao, int? numeroReciboEntrega, String? numProcReclamatoria, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future<ConsultarRelatorioResponse>
Consulta o recibo de transmissão de uma declaração
consultarXmlDeclaracao({String? contribuinteNumero, required CategoriaDctf categoria, required String anoPA, String? mesPA, String? diaPA, int? cnoAfericao, int? numeroReciboEntrega, String? numProcReclamatoria, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future<ConsultarXmlResponse>
Consulta o XML de uma declaração ATIVA ou gera XML de uma declaração EM ANDAMENTO
consultarXmlETransmitir({String? contribuinteNumero, required CategoriaDctf categoria, required String anoPA, String? mesPA, String? diaPA, String? numProcReclamatoria, required Future<String> assinadorXml(String xmlBase64), String? contratanteNumero, String? autorPedidoDadosNumero}) → Future<TransmitirDeclaracaoDctfResponse>
Consulta XML e transmite declaração em um fluxo completo
gerarDarf13Salario({String? contribuinteNumero, required String anoPA, bool isPessoaFisica = false, int? numeroReciboEntrega, int? dataAcolhimentoProposta, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future<GerarGuiaResponse>
Gera DARF para declaração 13º SALÁRIO (categorias 41 ou 51)
gerarDarfGeralMensal({String? contribuinteNumero, required String anoPA, required String mesPA, int? numeroReciboEntrega, int? dataAcolhimentoProposta, List<SistemaOrigem>? idsSistemaOrigem, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future<GerarGuiaResponse>
Gera DARF para declaração GERAL MENSAL (categoria 40)
gerarDarfPfMensal({String? contribuinteNumero, required String anoPA, required String mesPA, int? numeroReciboEntrega, int? dataAcolhimentoProposta, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future<GerarGuiaResponse>
Gera DARF para declaração PESSOA FÍSICA MENSAL (categoria 50)
gerarDocumentoArrecadacao({String? contribuinteNumero, required CategoriaDctf categoria, required String anoPA, String? mesPA, String? diaPA, int? cnoAfericao, int? numeroReciboEntrega, String? numProcReclamatoria, int? dataAcolhimentoProposta, List<SistemaOrigem>? idsSistemaOrigem, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future<GerarGuiaResponse>
Gera documento de arrecadação (DARF/DAE) para uma declaração ATIVA
gerarDocumentoArrecadacaoAndamento({String? contribuinteNumero, required CategoriaDctf categoria, required String anoPA, String? mesPA, String? diaPA, int? cnoAfericao, String? numProcReclamatoria, List<SistemaOrigem>? idsSistemaOrigem, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future<GerarGuiaResponse>
Gera documento de arrecadação para uma declaração EM ANDAMENTO
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
transmitirDeclaracao({String? contribuinteNumero, required CategoriaDctf categoria, required String anoPA, String? mesPA, String? diaPA, String? numProcReclamatoria, required String xmlAssinadoBase64, String? contratanteNumero, String? autorPedidoDadosNumero}) → Future<TransmitirDeclaracaoDctfResponse>
Transmite uma declaração EM ANDAMENTO usando XML assinado digitalmente
validarXmlBase64(String xmlBase64) → bool

Operators

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