Skip to content

Histórico de Regimes Tributários

Este endpoint gerencia o histórico de regimes tributários de uma organização. Ele é crucial para garantir que os cálculos de impostos sejam aplicados corretamente com base no regime vigente na data de cada transação.

Normalmente, você não precisará interagir com este endpoint diretamente, pois ele é gerenciado automaticamente através do endpoint de Períodos Contábeis. No entanto, ele está disponível para consultas e ajustes finos.

Objeto Histórico de Regime Tributário

AtributoTipoDescrição
idstringO ID único do registro de histórico (UUID).
organization_idstringO ID da organização.
regimestringO regime tributário (simples_nacional, lucro_presumido, lucro_real).
start_datestringA data de início de vigência do regime no formato YYYY-MM-DD.
end_datestringA data de fim de vigência do regime no formato YYYY-MM-DD.

Listar Histórico de Regimes

Retorna o histórico completo de regimes tributários para a organização ativa do usuário.

GET/api/tax-regime-history

Resposta

Retorna um array de objetos de Histórico de Regime Tributário.

Códigos de Status HTTP

  • 200 OK: Histórico de regimes tributários listado com sucesso.
  • 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
  • 500 Internal Server Error: Erro interno do servidor ao listar o histórico de regimes.

Criar um Registro de Histórico

Cria um novo registro de vigência para um regime tributário. A API valida para garantir que não haja sobreposição de datas com registros existentes.

POST/api/tax-regime-history

Corpo da Requisição

json
{
  "regime": "lucro_real",
  "start_date": "2027-01-01",
  "end_date": "2027-12-31"
}

Resposta

Retorna o objeto de histórico recém-criado.

Códigos de Status HTTP

  • 201 Created: Registro de histórico criado com sucesso.
  • 400 Bad Request: Dados da requisição inválidos (ex: datas sobrepostas, regime ausente/inválido).
  • 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
  • 500 Internal Server Error: Erro interno do servidor ao criar o registro de histórico.

Atualizar um Registro de Histórico

Atualiza um registro de histórico existente.

PUT/api/tax-regime-history/{id}

Parâmetros de URL

ParâmetroTipoDescrição
idstringO ID do registro de histórico a ser atualizado.

Corpo da Requisição

json
{
  "end_date": "2028-12-31"
}

Resposta

Retorna o objeto de histórico atualizado.

Códigos de Status HTTP

  • 200 OK: Registro de histórico atualizado com sucesso.
  • 400 Bad Request: Dados da requisição inválidos (ex: datas sobrepostas).
  • 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
  • 404 Not Found: Registro de histórico não encontrado.
  • 500 Internal Server Error: Erro interno do servidor ao atualizar o registro de histórico.

Deletar um Registro de Histórico

Exclui um registro de histórico de regime tributário.

DELETE/api/tax-regime-history/{id}

Parâmetros de URL

ParâmetroTipoDescrição
idstringO ID do registro de histórico a ser deletado.

Resposta

204 No Content em caso de sucesso.

Códigos de Status HTTP

  • 204 No Content: Registro de histórico deletado com sucesso.
  • 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
  • 404 Not Found: Registro de histórico não encontrado.
  • 500 Internal Server Error: Erro interno do servidor ao deletar o registro de histórico.