Financial accounts
The accounts money moves through — checking, cash, card. Every transaction, payable and receivable points at a financial account, and it is that balance the cash flow projects.
| Command | HTTP | Description |
|---|---|---|
financial-accounts list | GET /v1/financial-accounts | List financial accounts |
financial-accounts create | POST /v1/financial-accounts | Create a financial account |
financial-accounts get | GET /v1/financial-accounts/{id} | Get a financial account by ID |
financial-accounts update | PATCH /v1/financial-accounts/{id} | Update a financial account |
financial-accounts delete | DELETE /v1/financial-accounts/{id} | Delete a financial account |
financial-accounts adjust-balance | POST /v1/financial-accounts/{id}/adjust-balance | Adjust the account balance |
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 financial accounts
kobana finance financial-accounts list \
--fields "id,company_id,name,type,bank_id"
# Get a financial account by ID
kobana finance financial-accounts get \
--params '{"id": "FINANCIAL_ACCOUNT_ID"}'
# Create a financial account
kobana finance financial-accounts create \
--json '{"company_id": "COMPANY_ID", "name": "NAME", "type": "checking"}'
# Update a financial account
kobana finance financial-accounts update \
--params '{"id": "FINANCIAL_ACCOUNT_ID"}' \
--json '{"company_id": "COMPANY_ID", "name": "NAME", "type": "checking"}'
# Adjust the account balance
kobana finance financial-accounts adjust-balance \
--params '{"id": "FINANCIAL_ACCOUNT_ID"}' \
--json '{"target_balance": "1500.00", "category_id": "CATEGORY_ID"}'
# Delete a financial account
kobana finance financial-accounts delete \
--params '{"id": "FINANCIAL_ACCOUNT_ID"}' \
--dry-run
Next steps
- Transactions
- Schema introspection — every parameter this resource accepts.