Empresas
As empresas emissoras — quem cobra. Carregam o perfil fiscal usado na emissão de nota, e uma delas é a padrão.
| Comando | HTTP | Descrição |
|---|---|---|
companies list | GET /v1/companies | Listar empresas |
companies create | POST /v1/companies | Criar empresa |
companies get | GET /v1/companies/{id} | Obter empresa por ID |
companies update | PATCH /v1/companies/{id} | Atualizar empresa |
companies delete | DELETE /v1/companies/{id} | Excluir empresa |
companies deactivate | POST /v1/companies/{id}/deactivate | Desativar empresa (POST /deactivate) |
companies reactivate | POST /v1/companies/{id}/reactivate | Reativar empresa |
companies set-default | POST /v1/companies/{id}/set-default | Definir empresa padrão |
companies fiscal get | GET /v1/companies/{id}/fiscal | Obter perfil fiscal |
companies fiscal update | PATCH /v1/companies/{id}/fiscal | Atualizar perfil fiscal |
companies fiscal-profile get | GET /v1/companies/{id}/fiscal-profile | Obter perfil fiscal (alias) |
companies fiscal-profile update | PATCH /v1/companies/{id}/fiscal-profile | Atualizar perfil fiscal (alias) |
companies matriz list | GET /v1/companies/matriz | Listar matrizes |
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 empresas
kobana billing companies list \
--fields "id,public_id,external_id,organization_id,person_id"
# Obter empresa por ID
kobana billing companies get --params '{"id": "COMPANIE_ID"}'
# Criar empresa
kobana billing companies create \
--json '{"name": "NAME", "document_type": "cpf", "document_number": "DOCUMENT_NUMBER", "email": "EMAIL"}'
# Atualizar empresa
kobana billing companies update \
--params '{"id": "COMPANIE_ID"}' \
--json '{"name": "NAME", "external_id": "EXTERNAL_ID", "legal_name": "LEGAL_NAME"}'
# Desativar empresa (POST /deactivate)
kobana billing companies deactivate --params '{"id": "COMPANIE_ID"}'
# Excluir empresa
kobana billing companies delete --params '{"id": "COMPANIE_ID"}' --dry-run
Próximos passos
- Organização
- Introspecção de schema — todos os parâmetros que este recurso aceita.