Pular para o conteúdo principal

Empresas

As empresas emissoras — quem cobra. Carregam o perfil fiscal usado na emissão de nota, e uma delas é a padrão.

ComandoHTTPDescrição
companies listGET /v1/companiesListar empresas
companies createPOST /v1/companiesCriar empresa
companies getGET /v1/companies/{id}Obter empresa por ID
companies updatePATCH /v1/companies/{id}Atualizar empresa
companies deleteDELETE /v1/companies/{id}Excluir empresa
companies deactivatePOST /v1/companies/{id}/deactivateDesativar empresa (POST /deactivate)
companies reactivatePOST /v1/companies/{id}/reactivateReativar empresa
companies set-defaultPOST /v1/companies/{id}/set-defaultDefinir empresa padrão
companies fiscal getGET /v1/companies/{id}/fiscalObter perfil fiscal
companies fiscal updatePATCH /v1/companies/{id}/fiscalAtualizar perfil fiscal
companies fiscal-profile getGET /v1/companies/{id}/fiscal-profileObter perfil fiscal (alias)
companies fiscal-profile updatePATCH /v1/companies/{id}/fiscal-profileAtualizar perfil fiscal (alias)
companies matriz listGET /v1/companies/matrizListar 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​