Skip to main content

Companies

The companies in the group. Every account, bill and transaction belongs to one of them, and nearly every filter accepts company_id.

CommandHTTPDescription
companies listGET /v1/companiesList companies
companies createPOST /v1/companiesCreate a company
companies getGET /v1/companies/{id}Get a company by ID
companies updatePATCH /v1/companies/{id}Update a company
companies deleteDELETE /v1/companies/{id}Delete a company

Examples​

--params carries query and path parameters (id, page, filters); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List companies
kobana finance companies list --fields "id,name,cnpj,type,active"

# Get a company by ID
kobana finance companies get --params '{"id": "COMPANIE_ID"}'

# Create a company
kobana finance companies create \
--json '{"name": "ACME Comércio Ltda", "cnpj": "12345678000190"}'

# Update a company
kobana finance companies update \
--params '{"id": "COMPANIE_ID"}' \
--json '{"name": "NAME", "active": true, "trade_name": "TRADE_NAME"}'

# Delete a company
kobana finance companies delete --params '{"id": "COMPANIE_ID"}' --dry-run

Next steps​