Skip to main content

Tax periods

The tax periods that group issued invoices.

CommandHTTPDescription
tax-periods listGET /v1/tax_periodsList tax periods
tax-periods createPOST /v1/tax_periodsProcess the monthly tax period
tax-periods getGET /v1/tax_periods/{id}Get a tax period
tax-periods updatePATCH /v1/tax_periods/{id}Run an action on the tax period
tax-periods deleteDELETE /v1/tax_periods/{id}Delete a tax period

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 tax periods
kobana billing tax-periods list \
--fields "id,public_id,external_id,company_id,period_type"

# Get a tax period
kobana billing tax-periods get --params '{"id": "TAX_PERIOD_ID"}'

# Process the monthly tax period
kobana billing tax-periods create --json '{"year": 2026, "month": 6}'

# Run an action on the tax period
kobana billing tax-periods update \
--params '{"id": "TAX_PERIOD_ID"}' \
--json '{"action": "recalculate"}'

# Delete a tax period
kobana billing tax-periods delete --params '{"id": "TAX_PERIOD_ID"}' --dry-run

Next steps​