Skip to main content

Taxes

The taxes withheld or payable attached to a bill.

CommandHTTPDescription
taxes listGET /v1/taxesList taxes
taxes createPOST /v1/taxesCreate a tax
taxes getGET /v1/taxes/{id}Get a tax by ID
taxes updatePATCH /v1/taxes/{id}Update a tax
taxes deleteDELETE /v1/taxes/{id}Delete a tax

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 taxes
kobana finance taxes list \
--fields "id,name,default_rate,default_withholding,active"

# Get a tax by ID
kobana finance taxes get --params '{"id": "TAXE_ID"}'

# Create a tax
kobana finance taxes create --json '{"name": "IRRF"}'

# Update a tax
kobana finance taxes update \
--params '{"id": "TAXE_ID"}' \
--json '{"name": "IRRF", "default_rate": "1.50", "default_withholding": true}'

# Delete a tax
kobana finance taxes delete --params '{"id": "TAXE_ID"}' --dry-run

Next steps​