Skip to main content

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.

CommandHTTPDescription
receivables listGET /v1/receivablesList receivables
receivables createPOST /v1/receivablesCreate a receivable
receivables getGET /v1/receivables/{id}Get a receivable by ID
receivables updatePATCH /v1/receivables/{id}Update or settle a receivable
receivables deleteDELETE /v1/receivables/{id}Delete a receivable
receivables aggregates listGET /v1/receivables/aggregatesAggregate receivable totals
receivables charge createPOST /v1/receivables/{id}/chargeIssue a charge for a receivable
receivables charge cancel createPOST /v1/receivables/{id}/charge/cancelCancel a receivable's charge
receivables ids listGET /v1/receivables/idsList 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​