Pular para conteúdo

Escrituração#

Escrituracao #

Escrituracao(modulo: ModuloT, escrituracao_texto: str, nome: str)

Bases: Componente, ABC

Classe abstrata para contém informações de uma escrituração, seus blocos e registros.

Attributes:

  • blocos (dict[str, Bloco]) –

    Dicionário de blocos da escrituração.

  • abertura (Registro) –

    Registro de abertura da escrituração.

  • fechamento (Registro) –

    Registro de fechamento da escrituração.

  • modulo (ModuloT) –

    Módulo ao qual a escrituração pertence.

Parameters:

  • escrituracao_texto (str) –

    Texto da escrituração a ser criada.

  • nome (str) –

    Nome da escrituração.

MODULO instance-attribute #

MODULO: ModuloT

Nome do módulo a que essa escrituração pertence.

ECD class-attribute instance-attribute #

ECD = ECD

Nome para uma escrituração do tipo Escrituração Contábil Digital.

ECF class-attribute instance-attribute #

ECF = ECF

Nome para uma escrituração do tipo Escrituração Contábil Fiscal.

EFD_ICMS_IPI class-attribute instance-attribute #

EFD_ICMS_IPI = EFD_ICMS_IPI

Nome para uma escrituração do tipo Escrituração Fiscal Digital Contribuições.

EFD_CONTRIBUICOES class-attribute instance-attribute #

EFD_CONTRIBUICOES = EFD_CONTRIBUICOES

Nome para uma escrituração do tipo Escrituração Fiscal Digital ICMS IPI.

MODULOS_NOMES class-attribute instance-attribute #

MODULOS_NOMES = MODULOS_NOMES

Lista dos nomes dos módulos disponíveis na biblioteca.

abrir classmethod #

abrir(arquivo: str | Path) -> Self

Fábrica para criar uma escrituração diretamente de um arquivo.

Parameters:

  • arquivo (str | Path) –

    Caminho do arquivo a ser aberto.

Returns:

  • Self –

    Instância da escrituração criada.

salvar #

salvar(arquivo: str | Path) -> Self

Salva a escrituração para um arquivo.

Parameters:

  • arquivo (str | Path) –

    Caminho do arquivo a ser salvo.

Returns:

  • Self –

    A própria escrituração.

__getitem__ #

__getitem__(chave: str) -> Bloco

Encontra o bloco desejado da escrituração.

Parameters:

  • chave (str) –

    Nome do bloco.

Raises:

Returns:

  • Bloco –

    Bloco desejado.

__contains__ #

__contains__(chave: str) -> bool

Testa se um bloco existe na escrituração.

Parameters:

  • chave (str) –

    Nome ou número do bloco a ser testado.

Returns:

  • bool –

    Se o bloco existe na escrituração.

texto #

texto() -> str

Converte o componente para texto, da messa forma como ele estaria presente em um arquivo de escrituração, inclusive contendo quebras de linhas.

Returns:

  • str –

    Representação textual do componente.

adicionar #

adicionar(nome_bloco: str) -> Self

Adiciona um bloco a escrituração.

Parameters:

  • nome_bloco (str) –

    Nome do bloco a ser adicionado.

Returns:

  • Self –

    Própria escrituração.

remover #

remover(nome_bloco: str) -> Self

Remove um bloco a escrituração.

Parameters:

  • nome_bloco (str) –

    Nome do bloco a ser removido.

Returns:

  • Self –

    Própria escrituração.

totalizar #

totalizar(ordenar_9900: bool = False) -> Self

Totaliza os valores de contagem do bloco 9 e os fechamentos da escrituração.

Parameters:

  • ordenar_9900 (bool, default: False ) –

    Se os registros 9900 devem ser ordenados de acordo com os registros que eles totalizam.

totalizar_escrituracao #

totalizar_escrituracao() -> Self

Totaliza o fechamento da escrituração.

totalizar_blocos #

totalizar_blocos() -> Self

Totaliza os fechamentos dos blocos da escrituração.

totalizar_registros #

totalizar_registros(ordenar_9900: bool = False) -> Self

Totaliza os valores de contagem do bloco 9.

Parameters:

  • ordenar_9900 (bool, default: False ) –

    Se os registros 9900 devem ser ordenados de acordo com os registros que eles totalizam.

EscrituracaoEcd #

EscrituracaoEcd(escrituracao_texto: str | None = None)

Bases: Escrituracao

Contém informações sobre uma escrituração do módulo ECD e seus blocos e registros.

Parameters:

  • escrituracao_texto (str | None, default: None ) –

    Texto da escrituração a ser criada. Se não informado a escrituração é criada minimamente preenchida.

Raises:

  • TypeError –

    Se o texto não é de um tipo válido.

MODULO class-attribute instance-attribute #

MODULO = Escrituracao.ECD

Nome do módulo ECD.

EscrituracaoEcf #

EscrituracaoEcf(escrituracao_texto: str | None = None)

Bases: Escrituracao

Contém informações sobre uma escrituração do módulo ECF e seus blocos e registros.

Parameters:

  • escrituracao_texto (str | None, default: None ) –

    Texto da escrituração a ser criada. Se não informado a escrituração é criada minimamente preenchida.

Raises:

  • TypeError –

    Se o texto não é de um tipo válido.

MODULO class-attribute instance-attribute #

MODULO = Escrituracao.ECF

Nome do módulo ECF.

EscrituracaoEfdContribuicoes #

EscrituracaoEfdContribuicoes(escrituracao_texto: str | None = None)

Bases: Escrituracao

Contém informações sobre uma escrituração do módulo EFD_CONTRIBUICOES e seus blocos e registros.

Parameters:

  • escrituracao_texto (str | None, default: None ) –

    Texto da escrituração a ser criada. Se não informado a escrituração é criada minimamente preenchida.

Raises:

  • TypeError –

    Se o texto não é de um tipo válido.

MODULO class-attribute instance-attribute #

Nome do módulo EFD_CONTRIBUICOES.

EscrituracaoEfdIcmsIpi #

EscrituracaoEfdIcmsIpi(escrituracao_texto: str | None = None)

Bases: Escrituracao

Contém informações sobre uma escrituração do módulo EFD_ICMS_IPI e seus blocos e registros.

Parameters:

  • escrituracao_texto (str | None, default: None ) –

    Texto da escrituração a ser criada. Se não informado a escrituração é criada minimamente preenchida.

Raises:

  • TypeError –

    Se o texto não é de um tipo válido.

MODULO class-attribute instance-attribute #

Nome do módulo EFD_ICMS_IPI.