Saltar al contenido principal

Empresas

Las empresas emisoras — quién cobra. Llevan el perfil fiscal usado en la emisión de nota, y una de ellas es la predeterminada.

ComandoHTTPDescripción
companies listGET /v1/companiesListar empresas
companies createPOST /v1/companiesCrear empresa
companies getGET /v1/companies/{id}Obtener empresa por ID
companies updatePATCH /v1/companies/{id}Actualizar empresa
companies deleteDELETE /v1/companies/{id}Eliminar empresa
companies deactivatePOST /v1/companies/{id}/deactivateDesactivar empresa (POST /deactivate)
companies reactivatePOST /v1/companies/{id}/reactivateReactivar empresa
companies set-defaultPOST /v1/companies/{id}/set-defaultDefinir empresa predeterminada
companies fiscal getGET /v1/companies/{id}/fiscalObtener el perfil fiscal
companies fiscal updatePATCH /v1/companies/{id}/fiscalActualizar el perfil fiscal
companies fiscal-profile getGET /v1/companies/{id}/fiscal-profileObtener el perfil fiscal (alias)
companies fiscal-profile updatePATCH /v1/companies/{id}/fiscal-profileActualizar el perfil fiscal (alias)
companies matriz listGET /v1/companies/matrizListar matrices

Ejemplos​

--params lleva parámetros de query y de ruta (id, página, filtros); --json lleva el cuerpo de la solicitud; --fields limita los campos que vuelven — vale la pena en todo list/get, para ahorrar contexto. Mira Flags globales para la referencia completa.

# Listar empresas
kobana billing companies list \
--fields "id,public_id,external_id,organization_id,person_id"

# Obtener empresa por ID
kobana billing companies get --params '{"id": "COMPANIE_ID"}'

# Crear empresa
kobana billing companies create \
--json '{"name": "NAME", "document_type": "cpf", "document_number": "DOCUMENT_NUMBER", "email": "EMAIL"}'

# Actualizar empresa
kobana billing companies update \
--params '{"id": "COMPANIE_ID"}' \
--json '{"name": "NAME", "external_id": "EXTERNAL_ID", "legal_name": "LEGAL_NAME"}'

# Desactivar empresa (POST /deactivate)
kobana billing companies deactivate --params '{"id": "COMPANIE_ID"}'

# Eliminar empresa
kobana billing companies delete --params '{"id": "COMPANIE_ID"}' --dry-run

Próximos pasos​