Pular para o conteúdo principal

Períodos fiscais

As competências fiscais que agrupam as notas emitidas.

ComandoHTTPDescrição
tax-periods listGET /v1/tax_periodsListar períodos tributários
tax-periods createPOST /v1/tax_periodsProcessar período tributário mensal
tax-periods getGET /v1/tax_periods/{id}Obter período tributário
tax-periods updatePATCH /v1/tax_periods/{id}Executar ação no período tributário
tax-periods deleteDELETE /v1/tax_periods/{id}Excluir período tributário

Exemplos​

--params carrega parâmetros de query e de caminho (id, página, filtros); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.

# Listar períodos tributários
kobana billing tax-periods list \
--fields "id,public_id,external_id,company_id,period_type"

# Obter período tributário
kobana billing tax-periods get --params '{"id": "TAX_PERIOD_ID"}'

# Processar período tributário mensal
kobana billing tax-periods create --json '{"year": 2026, "month": 6}'

# Executar ação no período tributário
kobana billing tax-periods update \
--params '{"id": "TAX_PERIOD_ID"}' \
--json '{"action": "recalculate"}'

# Excluir período tributário
kobana billing tax-periods delete --params '{"id": "TAX_PERIOD_ID"}' --dry-run

Próximos passos​