calculadora-rtc-simples-nacional README

项目的 README,来自 github.com/ReceitaFederal/calculadora-rtc-simples-nacional。合并为一个 markdown 文件:README.md。

Calculadora de Tributos - Simples Nacional

Descrição do Projeto

API REST que realiza o cálculo da CBS e do IBS (Reforma Tributária do Consumo — LC 214/2025) nas operações do regime do simples nacional.


Público-Alvo


Funcionalidades

Todos os caminhos começam com http://localhost:8082/api. A lista completa, com esquemas e exemplos, está no Swagger (http://localhost:8082/api/swagger-ui.html).

Funcionalidade Endpoint
Cálculo do Simples Nacional com observabilidade (erros por item, sem interromper os demais) POST /calculadora/observabilidade/simples-nacional
Descrição de um código de erro VSN- GET /calculadora/observabilidade/simples-nacional/erros?codigo=VSN-001
Atividades do Simples Nacional vigentes em uma data, com filtros por anexo, tipo de documento e cClassTrib GET /calculadora/simples-nacional/atividades?data=AAAA-MM-DD
Consulta de uma atividade pelo código, vigente na data GET /calculadora/simples-nacional/atividades/{codigo}?data=AAAA-MM-DD
Informações de versão da aplicação, da base de dados e do ambiente GET /versao
Status da versão no perfil offline, comparado à instalação online GET /versao/status (somente perfil offline)

Requisitos

Requisitos do Sistema

Dependências Principais

O projeto utiliza as seguintes tecnologias:


Instruções de Instalação

1. Pré-requisitos

Certifique-se de ter instalado o Java 21 ou superior e verifique as versões:

# Verificar versão do Java
java -version

2. Clonar o Repositório

git clone https://github.com/ReceitaFederal/calculadora-rtc-simples-nacional.git
cd calculadora-rtc-simples-nacional

3. Gerar o Banco de Dados (obrigatório)

O perfil offline lê o banco ./calculadora/db/calculadora-pro.db, definido por application.db.filename em application-offline.yml. O caminho é relativo à raiz do projeto e o banco é aberto em modo somente leitura.

Atenção: use os scripts SQL para gerar o arquivo do Banco de Dados localizados no repositório https://github.com/ReceitaFederal/calculadora-rtc-simples-nacional.git

Atenção: a aplicação só funciona se o banco estiver gerado. Sem ele, o perfil offline não inicia.

Copie para a raiz deste projeto a pasta flyway/ presente no repositório https://github.com/ReceitaFederal/calculadora-rtc-simples-nacional.git

Linux/macOS:

mkdir -p ./calculadora/db
./mvnw flyway:migrate -Dflyway.configFiles=./flyway/flyway-pro.conf --batch-mode --errors

Windows:

mkdir calculadora\db
mvnw.cmd flyway:migrate -Dflyway.configFiles=flyway\flyway-pro.conf --batch-mode --errors

Confirme que o arquivo foi criado com ls -lah ./calculadora/db/calculadora-pro.db (Linux/macOS) ou dir calculadora\db\calculadora-pro.db (Windows).

4. Compilar e Executar os Testes

Os testes exigem o banco gerado no passo 3, pois a maioria são testes de integração com o perfil testes.

Executar todos os testes com relatório de cobertura (JaCoCo):

Linux/macOS:

./mvnw clean test jacoco:report

Windows:

mvnw.cmd clean test jacoco:report

O relatório de cobertura fica em target/site/jacoco/index.html.

5. Executar a Aplicação com perfil Offline (spring-boot:run)

Linux/macOS:

./mvnw spring-boot:run -Dspring-boot.run.profiles=offline

Windows:

mvnw.cmd spring-boot:run "-Dspring-boot.run.profiles=offline"

A aplicação estará disponível em http://localhost:8080/api.

6. Gerar o JAR e Executar com java -jar (perfil offline)

Linux/macOS:

./mvnw clean package
java -Dspring.profiles.active=offline -jar target/api-regime-geral.jar

Windows:

mvnw.cmd clean package
java "-Dspring.profiles.active=offline" -jar target\api-regime-geral.jar

Execute o JAR a partir da raiz do projeto, para que ./calculadora/db seja encontrado.


Referências

Licença

Este projeto é distribuído sob a licença especificada no arquivo LICENSE.

calculadora-rtc-simples-nacional (ReceitaFederal/calculadora-rtc-simples-nacional)

正在搜索数据库…

这是什么?这是一个 REST API,用于为 Simples Nacional 业务计算巴西税制改革(LC 214/2025)中的消费税 CBS 和 IBS。
有图形界面吗,还是只有 API?它只是 API,没有提到图形界面。完整的端点列表、数据结构和示例都在 Swagger(OpenAPI)中。
怎样才能让它运行起来?克隆仓库,复制 flyway/ 文件夹,并运行仓库中的 SQL 脚本,生成 ./calculadora/db/calculadora-pro.db。然后在 offline 配置下用 spring-boot:run 启动,或者构建 JAR,并在项目根目录运行 java -jar。
我需要先安装什么?Java 21 或更高版本,以及 Git。不需要安装 Maven,因为 Maven Wrapper 会在首次运行时下载它,这一步需要联网。
没有数据库文件,它能启动吗?不能。offline 配置会以只读方式打开 SQLite 文件;如果尚未生成数据库,它将无法启动。
运行时需要联网吗?完成设置后不需要,因为 offline 配置读取的是本地 SQLite 文件。只有首次下载 Maven Wrapper 时才需要联网。
CBS 和 IBS 是什么?CBS 和 IBS 是巴西税制改革(LC 214/2025)新引入的消费税。本 API 为 Simples Nacional 业务计算这两种税。
计算中某一项失败会怎样?可观测性端点会按条目报告错误,并继续处理其他条目。错误码(如 VSN-001)可以通过 /erros 端点查询。
技术栈是什么?Java 21+ 上的 Spring Boot 3.5.16,使用 SQLite 存储数据,使用 Flyway 做数据库迁移,使用 Springdoc 2.8.9 生成 OpenAPI 文档。
大小
0.7 MB
星标
503
时长
1个月
提交 · 90 天