Receivables
What you have coming in, with charge issuing and cancellation through the Banking Gateway straight from the receivable. Moving the money is the charge command — the record itself lives here.
| Command | HTTP | Description |
|---|---|---|
receivables list | GET /v1/receivables | List receivables |
receivables create | POST /v1/receivables | Create a receivable |
receivables get | GET /v1/receivables/{id} | Get a receivable by ID |
receivables update | PATCH /v1/receivables/{id} | Update or settle a receivable |
receivables delete | DELETE /v1/receivables/{id} | Delete a receivable |
receivables aggregates list | GET /v1/receivables/aggregates | Aggregate receivable totals |
receivables charge create | POST /v1/receivables/{id}/charge | Issue a charge for a receivable |
receivables charge cancel create | POST /v1/receivables/{id}/charge/cancel | Cancel a receivable's charge |
receivables ids list | GET /v1/receivables/ids | List receivable IDs |
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 receivables
kobana finance receivables list \
--fields "id,company_id,description,amount,interest_amount"
# Get a receivable by ID
kobana finance receivables get --params '{"id": "RECEIVABLE_ID"}'
# Create a receivable
kobana finance receivables create \
--json '{"company_id": "COMPANY_ID", "description": "DESCRIPTION", "amount": "1500.00", "due_date": "2026-01-31T12:00:00Z"}'
# Update or settle a receivable
kobana finance receivables update \
--params '{"id": "RECEIVABLE_ID"}' \
--json '{"description": "DESCRIPTION", "amount": "1500.00", "due_date": "2026-01-31T12:00:00Z"}'
# Delete a receivable
kobana finance receivables delete --params '{"id": "RECEIVABLE_ID"}' --dry-run
Next steps
- Cash flow
- Schema introspection — every parameter this resource accepts.