# Finput Docs ## Instructions for AI Agents - For clean Markdown of any page, append `.md` to the page URL - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.finput.com.au/_mcp/server ## Docs - [Welcome to Finput](https://docs.finput.com.au/overview/introduction.md): Equipment finance comparison platform for brokers - [Authentication and sessions](https://docs.finput.com.au/overview/building-a-client/authentication-and-sessions.md): JWT sessions with an idle timeout and a hard cap, rotating refresh, and long-lived API tokens - [Gating features in a client](https://docs.finput.com.au/overview/building-a-client/gating-features-in-a-client.md): Surfaces say what to show; entitlements say how much the plan allows - [Connect an AI assistant](https://docs.finput.com.au/overview/connect-an-ai-assistant.md): Give Claude, ChatGPT or Cursor access to your own Finput account ## API Docs - Endpoints [Price a deal and find where it can be approved](https://docs.finput.com.au/api/endpoints/matrix-calculator.md) - Endpoints > Authentication [Register a new user](https://docs.finput.com.au/api/endpoints/authentication/register.md) - Endpoints > Authentication [Log in and obtain JWT tokens](https://docs.finput.com.au/api/endpoints/authentication/login.md) - Endpoints > Authentication [Verify email address](https://docs.finput.com.au/api/endpoints/authentication/verify-email.md) - Endpoints > Authentication [Request password reset](https://docs.finput.com.au/api/endpoints/authentication/forgot-password.md) - Endpoints > Authentication [Reset password](https://docs.finput.com.au/api/endpoints/authentication/reset-password.md) - Endpoints > Authentication [Exchange a refresh token for a new token pair](https://docs.finput.com.au/api/endpoints/authentication/refresh-token.md) - Endpoints > Authentication [End a session](https://docs.finput.com.au/api/endpoints/authentication/logout.md) - Endpoints > Authentication [Verify an email and set the first password](https://docs.finput.com.au/api/endpoints/authentication/verify-and-set-password.md) - Endpoints > Authentication [Re-send a verification email](https://docs.finput.com.au/api/endpoints/authentication/resend-verification.md) - Endpoints > Users [List all users](https://docs.finput.com.au/api/endpoints/users/list-users.md) - Endpoints > Users [Get user by ID](https://docs.finput.com.au/api/endpoints/users/get-user.md) - Endpoints > Users [Update user (full)](https://docs.finput.com.au/api/endpoints/users/update-user.md) - Endpoints > Users [Delete user](https://docs.finput.com.au/api/endpoints/users/delete-user.md) - Endpoints > Users [Update user (partial)](https://docs.finput.com.au/api/endpoints/users/patch-user.md) - Endpoints > Calculator [Calculate repayments](https://docs.finput.com.au/api/endpoints/calculator/calculate.md) - Endpoints > Calculator [Recalculate repayments](https://docs.finput.com.au/api/endpoints/calculator/recalculate.md) - Endpoints > Calculator [Look up ABN status](https://docs.finput.com.au/api/endpoints/calculator/abn-lookup.md) - Endpoints > Calculator [List the financiers a run on a surface can be narrowed to](https://docs.finput.com.au/api/endpoints/calculator/list-picker-financiers.md) - Endpoints > Scenarios [List your saved and recent calculator scenarios](https://docs.finput.com.au/api/endpoints/scenarios/list-calculator-scenarios.md) - Endpoints > Scenarios [Save a calculator scenario](https://docs.finput.com.au/api/endpoints/scenarios/save-calculator-scenario.md) - Endpoints > Scenarios [Delete one scenario](https://docs.finput.com.au/api/endpoints/scenarios/delete-calculator-scenario.md) - Endpoints > Scenarios [Promote a recent scenario to a saved one](https://docs.finput.com.au/api/endpoints/scenarios/promote-calculator-scenario.md) - Endpoints > Scenarios [List your saved and recent Matrix searches](https://docs.finput.com.au/api/endpoints/scenarios/list-matrix-scenarios.md) - Endpoints > Scenarios [Save a Matrix search](https://docs.finput.com.au/api/endpoints/scenarios/save-matrix-scenario.md) - Endpoints > Scenarios [Delete one Matrix scenario](https://docs.finput.com.au/api/endpoints/scenarios/delete-matrix-scenario.md) - Endpoints > Scenarios [Promote a recent Matrix search to a saved one](https://docs.finput.com.au/api/endpoints/scenarios/promote-matrix-scenario.md) - Endpoints > Approval Matrix [Find where a deal can be approved](https://docs.finput.com.au/api/endpoints/approval-matrix/matrix.md) - Endpoints > Approvals [List approvals](https://docs.finput.com.au/api/endpoints/approvals/list-approvals.md) - Endpoints > Approvals [Create an approval](https://docs.finput.com.au/api/endpoints/approvals/create-approval.md) - Endpoints > Approvals [Set the display order of a financier's approvals](https://docs.finput.com.au/api/endpoints/approvals/reorder-approvals.md) - Endpoints > Approvals [Approval form vocabulary](https://docs.finput.com.au/api/endpoints/approvals/approval-options.md) - Endpoints > Approvals [Get an approval](https://docs.finput.com.au/api/endpoints/approvals/get-approval.md) - Endpoints > Approvals [Update an approval](https://docs.finput.com.au/api/endpoints/approvals/update-approval.md) - Endpoints > Approvals [Delete an approval](https://docs.finput.com.au/api/endpoints/approvals/delete-approval.md) - Endpoints > API Tokens [List your API tokens](https://docs.finput.com.au/api/endpoints/api-tokens/list-api-tokens.md) - Endpoints > API Tokens [Mint an API token](https://docs.finput.com.au/api/endpoints/api-tokens/create-api-token.md) - Endpoints > API Tokens [Revoke an API token](https://docs.finput.com.au/api/endpoints/api-tokens/revoke-api-token.md) - Endpoints > Organisations [List the organisations the caller may see](https://docs.finput.com.au/api/endpoints/organisations/list-organisations.md) - Endpoints > Organisations [Get organisation by ID](https://docs.finput.com.au/api/endpoints/organisations/get-organisation.md) - Endpoints > Organisations [Set your organisation's BID status](https://docs.finput.com.au/api/endpoints/organisations/patch-organisation.md) - Endpoints > Products [List products](https://docs.finput.com.au/api/endpoints/products/list-products.md) - Endpoints > Products [Create a product](https://docs.finput.com.au/api/endpoints/products/create-product.md) - Endpoints > Products [Get product by ID](https://docs.finput.com.au/api/endpoints/products/get-product.md) - Endpoints > Products [Update product (full)](https://docs.finput.com.au/api/endpoints/products/update-product.md) - Endpoints > Products [Delete product](https://docs.finput.com.au/api/endpoints/products/delete-product.md) - Endpoints > Products [Update product (partial)](https://docs.finput.com.au/api/endpoints/products/patch-product.md) - Endpoints > Rate Brackets [List rate brackets](https://docs.finput.com.au/api/endpoints/rate-brackets/list-rate-brackets.md) - Endpoints > Rate Brackets [Create a rate bracket](https://docs.finput.com.au/api/endpoints/rate-brackets/create-rate-bracket.md) - Endpoints > Rate Brackets [Get rate bracket by ID](https://docs.finput.com.au/api/endpoints/rate-brackets/get-rate-bracket.md) - Endpoints > Rate Brackets [Update rate bracket (full)](https://docs.finput.com.au/api/endpoints/rate-brackets/update-rate-bracket.md) - Endpoints > Rate Brackets [Delete rate bracket](https://docs.finput.com.au/api/endpoints/rate-brackets/delete-rate-bracket.md) - Endpoints > Rate Brackets [Update rate bracket (partial)](https://docs.finput.com.au/api/endpoints/rate-brackets/patch-rate-bracket.md) - Endpoints > Rate Brackets [Get rate brackets by product](https://docs.finput.com.au/api/endpoints/rate-brackets/get-rate-brackets-by-product.md) - Endpoints > Uplifts [List uplifts](https://docs.finput.com.au/api/endpoints/uplifts/list-uplifts.md) - Endpoints > Uplifts [Create an uplift](https://docs.finput.com.au/api/endpoints/uplifts/create-uplift.md) - Endpoints > Uplifts [Get uplift by ID](https://docs.finput.com.au/api/endpoints/uplifts/get-uplift.md) - Endpoints > Uplifts [Update uplift (full)](https://docs.finput.com.au/api/endpoints/uplifts/update-uplift.md) - Endpoints > Uplifts [Delete an uplift](https://docs.finput.com.au/api/endpoints/uplifts/delete-uplift.md) - Endpoints > Uplifts [Update uplift (partial)](https://docs.finput.com.au/api/endpoints/uplifts/patch-uplift.md) - Endpoints > Uplifts [Assign an uplift to a rate bracket](https://docs.finput.com.au/api/endpoints/uplifts/assign-uplift-bracket.md) - Endpoints > Uplifts [Remove an uplift from a rate bracket](https://docs.finput.com.au/api/endpoints/uplifts/unassign-uplift-bracket.md) - Endpoints > Uplifts [Detach a bracket from a shared uplift](https://docs.finput.com.au/api/endpoints/uplifts/detach-uplift-bracket.md) - Endpoints > Assets [Get asset tree](https://docs.finput.com.au/api/endpoints/assets/get-asset-tree.md) - Endpoints > Assets [Update asset](https://docs.finput.com.au/api/endpoints/assets/update-asset.md) - Endpoints > Assets [List asset-rate bracket relations](https://docs.finput.com.au/api/endpoints/assets/list-asset-relations.md) - Endpoints > Assets [Get asset hierarchy structure](https://docs.finput.com.au/api/endpoints/assets/get-asset-structure.md) - Endpoints > Assets [Get asset rate bracket ID mappings](https://docs.finput.com.au/api/endpoints/assets/get-asset-mappings.md) - Endpoints > Assets [The asset tree the asset picker searches](https://docs.finput.com.au/api/endpoints/assets/search-assets.md) - Endpoints > Assets [Get organisations by product](https://docs.finput.com.au/api/endpoints/assets/get-organisations-by-product.md) - Endpoints > Assets [Fetch one asset-rate bracket relation](https://docs.finput.com.au/api/endpoints/assets/get-asset-relation.md) - Endpoints > Feature Flags [Read the caller's evaluated feature flags](https://docs.finput.com.au/api/endpoints/feature-flags/get-feature-flags.md) - Endpoints > Client Versions [Check whether this app version may run](https://docs.finput.com.au/api/endpoints/client-versions/check-client-version.md) - Endpoints > Notifications [Register an install for push](https://docs.finput.com.au/api/endpoints/notifications/register-push-device.md) - Endpoints > Notifications [Unregister an install from push](https://docs.finput.com.au/api/endpoints/notifications/unregister-push-device.md) - Endpoints > Notifications [Read the caller's notification preferences](https://docs.finput.com.au/api/endpoints/notifications/get-notification-preferences.md) - Endpoints > Notifications [Update the caller's notification preferences](https://docs.finput.com.au/api/endpoints/notifications/update-notification-preferences.md) - Endpoints > Billing [Read the caller's entitlements and usage](https://docs.finput.com.au/api/endpoints/billing/get-entitlements.md) - Endpoints > Billing [List purchasable plans](https://docs.finput.com.au/api/endpoints/billing/list-plans.md) - Endpoints > Billing [Read the organisation's subscription](https://docs.finput.com.au/api/endpoints/billing/get-subscription.md) - Endpoints > Billing [List recent invoices](https://docs.finput.com.au/api/endpoints/billing/list-invoices.md) - Endpoints > Billing [Start a subscription](https://docs.finput.com.au/api/endpoints/billing/create-checkout-session.md) - Endpoints > Billing [Upgrade or downgrade an existing subscription](https://docs.finput.com.au/api/endpoints/billing/change-plan.md) - Endpoints > Billing [Open the Stripe customer portal](https://docs.finput.com.au/api/endpoints/billing/create-portal-session.md) - Endpoints > Billing [Schedule cancellation at period end](https://docs.finput.com.au/api/endpoints/billing/cancel-subscription.md) - Endpoints > Billing [Undo a scheduled cancellation](https://docs.finput.com.au/api/endpoints/billing/reactivate-subscription.md) - Endpoints > Mcp Connections [List your connected AI assistants](https://docs.finput.com.au/api/endpoints/mcp-connections/list-mcp-connections.md) - Endpoints > Mcp Connections [Disconnect an AI assistant](https://docs.finput.com.au/api/endpoints/mcp-connections/disconnect-mcp-connection.md) - Endpoints > Rate Card Versions [List an organisation's restore points](https://docs.finput.com.au/api/endpoints/rate-card-versions/list-rate-card-versions.md) - Endpoints > Rate Card Versions [Compare a restore point against the card today](https://docs.finput.com.au/api/endpoints/rate-card-versions/diff-rate-card-version.md) - Endpoints > Deletions [Preview what a delete would destroy](https://docs.finput.com.au/api/endpoints/deletions/preview-deletion.md) - Endpoints > Issue Reports [Report a wrong criterion or a wrong figure](https://docs.finput.com.au/api/endpoints/issue-reports/create-issue-report.md) - Endpoints > Issue Reports [Count open reports that already say this](https://docs.finput.com.au/api/endpoints/issue-reports/count-duplicate-reports.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.finput.com.au/openapi.json) - [OpenAPI YAML](https://docs.finput.com.au/openapi.yaml)