Cashfin actions

The Run a Cashfin action step, and the AI agent step, can use any of the 210 actions below. They are the same actions the AI assistant uses in the dashboard, so an automation can do anything you can ask the assistant to do.

Column	Meaning
Action	The name shown in the builder.
Key	The name to give an AI agent, or to use when building an automation through the API.
Kind	Looks up reads data and changes nothing. Creates, Changes, Acts and Generates change something or send something.

Inside an AI agent step, "Looks up" actions run on their own. Every other kind waits for approval unless you list it under Run without approval. Deletes, refunds and sending money always wait. See AI agent.

Choose an action in the builder to see its inputs: each one has its own form.

Accounting

Action	Key	Kind	What it does
Accounting period	close_accounting_period	Acts	Close an accounting period so it rejects all new ledger postings (locks the books for that month).
Journal entry	create_journal_entry	Creates	Record a manual double-entry journal (e.g.
Accounting periods	get_accounting_periods	Looks up	Retrieve the business accounting periods (monthly) with open/closed status.
Accounts payable	get_accounts_payable	Looks up	Retrieve accounts payable — money the business owes vendors, from unpaid bills, expenses, and manual payable records, with balances and due dates.
Accounts receivable	get_accounts_receivable	Looks up	Retrieve accounts receivable — money customers owe the business, from unpaid invoices, sales orders, and manual receivable records, with balances and due dates.
Balance sheet	get_balance_sheet	Looks up	Retrieve the balance sheet as of a date: assets, liabilities, equity, and current earnings.
Cash flow	get_cash_flow	Looks up	Retrieve the cash flow report for a date range: opening cash, inflows and outflows grouped by activity (payments, vendor payments, etc.), and closing cash across the mapped bank/wallet accounts.
Chart of accounts	get_chart_of_accounts	Looks up	Retrieve the business chart of accounts (ledger accounts) with codes, titles, types, and categories.
Contact statement	get_contact_statement	Looks up	Retrieve a statement of account for one customer or vendor: opening balance, every transaction with a running balance, and the closing balance for a date range.
General ledger	get_general_ledger	Looks up	Retrieve posted general ledger lines (every debit and credit on the books), filterable by account, source type, and date range.
Journals	get_journals	Looks up	Retrieve all accounting journals in one feed: the balanced double-entry records behind every invoice, payment, bill, expense, and manual entry (including reversals), plus draft manual entries awaiting posting.
Payables aging	get_payables_aging	Looks up	Retrieve the accounts payable aging summary: total owed to vendors and overdue amounts bucketed by age (1-30, 31-60, 61-90, 91-120, 120+ days).
Profit and loss	get_profit_and_loss	Looks up	Retrieve the profit & loss statement (income statement) for a date range: revenue, expenses, and net income per account.
Receivables aging	get_receivables_aging	Looks up	Retrieve the accounts receivable aging summary: total outstanding and overdue amounts bucketed by age (1-30, 31-60, 61-90, 91-120, 120+ days).
Trial balance	get_trial_balance	Looks up	Retrieve the trial balance: every ledger account with its total debits, credits, and net balance as of a date.
Journal entry	post_journal_entry	Acts	Post a draft manual journal entry to the general ledger.
Accounting period	reopen_accounting_period	Acts	Reopen a closed accounting period so postings dated inside it are accepted again.
Journal entry	reverse_journal_entry	Acts	Reverse a posted manual journal entry by posting a new journal with the debit and credit sides swapped.
Journal entry	update_journal_entry	Changes	Edit a DRAFT manual journal entry — its date, notes, reference number, or replace its line set.

Analytics and reports

Action	Key	Kind	What it does
Accounts report	generate_accounts_report	Generates	Generate an AI-assisted branded PDF Accounts report for the selected period.
CRM report	generate_crm_report	Generates	Generate an AI-assisted branded PDF CRM report for the selected period.
Marketing report	generate_marketing_report	Generates	Generate an AI-assisted branded PDF Marketing report for the selected period.
Payments report	generate_payments_report	Generates	Generate an AI-assisted branded PDF Payments report for the selected period.
Purchases report	generate_purchases_report	Generates	Generate an AI-assisted branded PDF Purchases report for the selected period.
Shop report	generate_shop_report	Generates	Generate an AI-assisted branded PDF Shop report for the selected period.
Accounts analytics	get_accounts_analytics	Looks up	Retrieve accounts analytics (KPIs, trends, distributions) for the given date range.
CRM analytics	get_crm_analytics	Looks up	Retrieve crm analytics (KPIs, trends, distributions) for the given date range.
Marketing analytics	get_marketing_analytics	Looks up	Retrieve marketing analytics (KPIs, trends, distributions) for the given date range.
Payments analytics	get_payments_analytics	Looks up	Retrieve payments analytics (KPIs, trends, distributions) for the given date range.
Purchases analytics	get_purchases_analytics	Looks up	Retrieve purchases analytics (KPIs, trends, distributions) for the given date range.
Shop analytics	get_shop_analytics	Looks up	Retrieve shop analytics (KPIs, trends, distributions) for the given date range.

Audit

Action	Key	Kind	What it does
Duplicate bills	get_duplicate_bills	Looks up	Scan for potential duplicate bills: groups of bills from the SAME vendor with the SAME amount within the window — double-payment risk.
Duplicate invoices	get_duplicate_invoices	Looks up	Scan for potential duplicate invoices: groups of invoices to the SAME customer with the SAME amount within the window.
Large stock adjustments	get_large_stock_adjustments	Looks up	List the biggest NEGATIVE manual stock adjustments within the window (most stock written off first) — shrinkage/leakage candidates.
Off-hours transactions	get_offhours_transactions	Looks up	List successful transactions recorded outside business hours (22:00-05:59 local) within the window, largest first — activity worth a second look.

Branches

Action	Key	Kind	What it does
Branch performance	get_branch_performance	Looks up	Compare all branches (territories) over a window: money in (successful transactions), transaction count, and order count/total per branch, with branch names.

Business and workspace

Action	Key	Kind	What it does
API key	create_api	Creates	Create a new API key or integration for external service access.
Task	create_task	Creates	Create a task with optional due date, status, and references to leads or customers.
Activities	get_activities	Looks up	Retrieve business activities and timeline events with optional filtering and pagination.
Automation settings	get_automation_settings	Looks up	Get the business's automation settings: customersenddailycap (how many customer-facing messages automations may send per day), its default and maximum.
Balances	get_balances	Looks up	Retrieve account balances with optional filtering and pagination.
Dashboard stats	get_dashboard_stats	Looks up	Retrieve the business dashboard headline stats: sales, collections, orders, and key metric cards with period-over-period change.
Money in and out	get_money_in_out	Looks up	Retrieve the money-in vs money-out chart data (cash inflows and outflows over time).
Notifications	get_notifications	Looks up	Retrieve in-app business notifications (orders, payments, bookings, system events) with optional filtering and pagination.
Pipelines	get_pipelines	Looks up	Retrieve sales pipelines.
Stages	get_stages	Looks up	Retrieve pipeline stages.
Tags	get_tags	Looks up	Retrieve available tags.
Tasks	get_tasks	Looks up	Retrieve tasks with optional filtering and pagination.
Taxes	get_taxes	Looks up	Retrieve tax configurations.
Users	get_users	Looks up	Retrieve business users with optional filtering and pagination.
Workflow	get_workflow	Looks up	Get one automation with its flow chart (nodes and edges; simple automations are returned as an equivalent flow chart).
Automation catalogue	get_workflow_catalog	Looks up	List what automations can use: triggers (with their typed fields and the actions each allows), step kinds (filter, if/else, switch, action), actions with their config fields, operators per field type, agent keys, and ...
Workflow runs	get_workflow_runs	Looks up	List an automation's recent runs, newest first: status (succeeded, failed, skipped), each step's outcome, branch taken and error.
Automation step inputs	get_workflow_step_inputs	Looks up	Get the inputs (JSON schema) of one Cashfin action for a tool step, e.g.
Workflows	get_workflows	Looks up	List the business's automations: trigger event, enabled state, run count, last run time and last run status.
Automation settings	update_automation_settings	Changes	Change the daily cap on customer-facing messages (email, SMS, WhatsApp, sent documents) from automations.
References	update_references	Changes	Link or unlink related records on a host document (invoice, quote, sales order, task, bill, expense, purchase order, booking, contract, subscription, receipt, deal, campaign...).
Task	update_task	Changes	Update an existing task's title, description, status, dates, assignees, or linked records.

CRM

Action	Key	Kind	What it does
Leads	bulk_create_leads	Creates	Bulk-create multiple leads at once from a list.
Customers	bulk_import_customers	Creates	Import multiple customers at once (e.g.
Lead	close_lead	Acts	Close a lead as lost or unqualified with a close reason.
Lead	convert_lead	Acts	Convert a won lead into a customer.
Appointment	create_appointment	Creates	Create a new appointment type or booking slot.
Assignment rule	create_assignment_rule	Creates	Create a lead routing rule: leads arriving WITHOUT an assignee (API capture, imports, web forms) are matched against rules in priority order; the first match picks an owner from the user pool.
Booking	create_booking	Creates	Create a new booking with scheduling, guests, location, billing, and customer references.
Calendar event	create_calendar_event	Creates	Create a new calendar event or meeting.
Contract	create_contract	Creates	Create a new contract with billing details, items, terms, and customer references.
Customer	create_customer	Creates	Create a new customer with contact information, company details, and assignment.
Deal	create_deal	Creates	Create a sales deal (revenue opportunity) with a value, expected close date, and optional customer/lead links.
Lead	create_lead	Creates	Create a new lead with contact information, company details, and assignment.
Quote	create_quote	Creates	Create a new quote with line items, tax calculation, customer references, and expiry date.
Sequence	create_sequence	Creates	Create a multi-step nurture sequence (cadence) for leads: ordered email/SMS/WhatsApp/task steps with delays between them.
Sequence	enroll_in_sequence	Acts	Enroll one or more leads into a nurture sequence — the first step is scheduled immediately per the sequence's delays.
Appointments	get_appointments	Looks up	Retrieve appointment types/slots that can be booked by customers.
Assignment rules	get_assignment_rules	Looks up	List the business's lead routing rules: priority, conditions, strategy, user pool, enabled state, run count, and last run time.
Bookings	get_bookings	Looks up	Retrieve bookings and scheduled appointments with optional filtering and pagination.
Calendar events	get_calendar_events	Looks up	Retrieve calendar events with optional filtering and pagination.
Contracts	get_contracts	Looks up	Retrieve contracts with optional filtering and pagination.
Calls	get_crm_calls	Looks up	Retrieve logged phone calls with outcome and duration.
Emails	get_crm_emails	Looks up	Retrieve outbound CRM emails with optional filtering.
Messages	get_crm_messages	Looks up	Retrieve outbound CRM SMS and WhatsApp messages with optional filtering.
Customers	get_customers	Looks up	Retrieve customers with optional filtering and pagination.
Deals	get_deals	Looks up	Retrieve sales deals (revenue opportunities) with amount, stage, probability and expected close date.
Close reasons	get_lead_close_reasons	Looks up	List the close reasons available when closing a lead as lost or unqualified.
Leads	get_leads	Looks up	Retrieve leads with optional filtering and pagination.
Projects	get_projects	Looks up	Retrieve projects with optional filtering and pagination.
Quotes	get_quotes	Looks up	Retrieve quotations with optional filtering and pagination.
Sequences	get_sequences	Looks up	List the business's nurture sequences: steps, enabled state, and enrolled/completed/exited counters.
Call	log_call	Creates	Log a phone call against a lead, customer or deal — outcome, duration and what was discussed.
Deal	lose_deal	Acts	Close a deal as lost with a close reason.
Email	send_crm_email	Acts	Send a transactional CRM email to a single recipient.
Message	send_crm_message	Acts	Send an outbound SMS or WhatsApp message from the CRM.
Quote	send_quote	Acts	Send a quote to the customer by email.
Deal	transition_deal	Acts	Move an open deal to a different sales stage (get_stages with type='sales' for stage IDs).
Pipeline	transition_pipeline	Acts	Move a lead or customer to a different pipeline stage.
Appointment	update_appointment	Changes	Update an appointment type's duration, availability, or settings.
Assignment rule	update_assignment_rule	Changes	Update a lead routing rule — only provided fields change; sending conditions/userPool replaces the whole list.
Booking	update_booking	Changes	Update a booking's status, time, or notes.
Calendar event	update_calendar_event	Changes	Update a calendar event's title, dates, color, priority, description, or assignees.
Contract	update_contract	Changes	Update an existing contract's status, dates, or value.
CRM settings	update_crm_settings	Changes	Update the CRM automation thresholds: firstResponseSlaHours flags leads with no first outbound touch within N hours (lead_sla_breached event, hourly sweep); leadIdleDays flags open leads untouched for N days (lead_idl...
Customer	update_customer	Changes	Update an existing customer's contact details, company info, or assigned users.
Deal	update_deal	Changes	Update a deal's title, value, expected close date, forecast category or assignment.
Lead	update_lead	Changes	Update a lead's details or status.
Project	update_project	Changes	Update a project's title, description, status, dates, or assignees.
Quote	update_quote	Changes	Update an existing quote's status, title, dates, or line items.
Sequence	update_sequence	Changes	Update a sequence: rename, pause/resume (enabled), or replace its steps (the list is replaced whole).
Deal	win_deal	Acts	Close a deal as won, recording the won amount (defaults to the deal value).

Data quality

Action	Key	Kind	What it does
Duplicate customers	get_duplicate_customers	Looks up	Scan for customer records sharing a phone number or email address — merge candidates.
Lead gaps	get_lead_gaps	Looks up	List open leads missing a phone number or email — records outreach and deduplication cannot work with (usually imports/legacy rows).
Product gaps	get_product_gaps	Looks up	List active products missing a SKU, cost price, or category (flags per product).

Marketing

Action	Key	Kind	What it does
List contact	add_list_contact	Creates	Add one contact to a marketing list.
List contacts	bulk_import_list_contacts	Creates	Import multiple contacts into a marketing list (e.g.
Campaign	create_campaign_manual	Creates	Create a new marketing campaign manually with subject, type, medium, and recipient configuration.
Marketing list	create_list	Creates	Create a new marketing list for email, SMS, or WhatsApp campaigns.
Social post	create_social_post	Creates	Publish or schedule a social media post with one image to connected Facebook, Instagram or LinkedIn accounts.
Campaigns	get_campaigns	Looks up	Retrieve marketing campaigns with optional filtering and pagination.
Email templates	get_email_templates	Looks up	Retrieve email templates with optional filtering and pagination.
List contacts	get_list_contacts	Looks up	Retrieve the contacts on one marketing list, with optional search and pagination.
Marketing lists	get_lists	Looks up	Retrieve marketing lists/segments with optional filtering and pagination.
Post insights	get_social_post_insights	Looks up	How a published social post is doing per account: views/impressions, reach, likes, comments, shares and saves, as last synced from the platform.
Social posts	get_social_posts	Looks up	List the business's social media posts (drafts, scheduled, published, failed) with the accounts each was sent to.
Canva design	import_canva_design	Generates	Bring a Canva design into the Content Lab as a PNG so it can be posted.
Social accounts	list_social_accounts	Looks up	List the business's connected social accounts (Facebook pages, Instagram accounts, LinkedIn pages, and Canva).
Social comments	list_social_comments	Looks up	List comments people left on the business's Facebook, Instagram and LinkedIn posts (the social inbox), newest first.
Comment moderation	moderate_social_comment	Acts	Hide, unhide or delete a comment on a Facebook or Instagram post.
Comment reply	reply_to_social_comment	Acts	Publicly reply to a comment on a social post as the business.
Send campaign	send_campaign	Acts	Queue an existing email campaign for sending to its recipients.
Campaign	update_campaign	Changes	Update a campaign's title, description, subject line, schedule time, or assignees.
Email campaign	update_email_campaign	Changes	Change an EXISTING email campaign's email itself, in place: copy, headline, subject, title, button text and links, images, colours.
Marketing list	update_list	Changes	Update a marketing list's name, description, or type.
List contact	update_list_contact	Changes	Update a contact on a marketing list: name, email, phone, company, or subscribed (false unsubscribes them from campaigns and automations).

Payments

Action	Key	Kind	What it does
Customer credit	apply_customer_credit	Acts	Use a customer's credit balance to settle one of their unpaid invoices, or an open sales order that has no invoice (give exactly one of invoiceId / orderId).
Transactions	bulk_import_transactions	Creates	Import multiple transactions at once (e.g.
Invoice	cancel_invoice	Acts	Cancel an invoice that has NO payments and NO credit notes (draft, unpaid or overdue).
Sales order	cancel_sales_order	Acts	Cancel a sales order that has NO payments, NO credit notes and NO invoice.
Subscription	cancel_subscription	Acts	Cancel an active subscription.
Credit note	create_credit_note	Creates	Issue a credit note that reverses all or part of an invoice.
Invoice	create_invoice	Creates	Create a new invoice with line items, tax calculation, payment terms, and customer details.
Credit note	create_order_credit_note	Creates	Issue a credit note that reverses all or part of a SALES ORDER that has no invoice.
Payment link	create_payment_link	Creates	Create a new payment link for collecting payments.
Receipt	create_receipt	Creates	Create a new receipt for a payment transaction.
Subscription	create_subscription	Creates	Create a new subscription for recurring billing.
Transaction	create_transaction	Creates	Record a payment transaction, matching the UI transaction form.
Credit notes	get_credit_notes	Looks up	Retrieve credit notes (reversals of all or part of an invoice, or of a sales order that has no invoice).
Invoices	get_invoices	Looks up	Retrieve invoices with optional filtering and pagination.
Payment links	get_payment_links	Looks up	Retrieve payment links with optional filtering and pagination.
Payment terms	get_payment_terms	Looks up	List the business's payment terms (e.g.
POS session summary	get_pos_session_summary	Looks up	Retrieve the summary for one POS session (shift): totals by payment method, refunds, discounts, cash movements, and expected vs counted cash variance.
POS sessions	get_pos_sessions	Looks up	Retrieve POS register sessions (shifts) with optional filtering and pagination.
Receipts	get_receipts	Looks up	Retrieve receipts with optional filtering and pagination.
Refunds	get_refunds	Looks up	Retrieve refunds (money paid back to customers).
Subscriptions	get_subscriptions	Looks up	Retrieve subscriptions with optional filtering and pagination.
Transactions	get_transactions	Looks up	Retrieve payment transactions with optional filtering and pagination.
Subscription	pause_subscription	Acts	Pause an active subscription temporarily.
Refund	record_refund	Creates	Record money paid back to a customer out of their credit balance (credit comes from credit notes on money they had already paid).
Subscription	resume_subscription	Acts	Resume a paused subscription.
Invoice	send_invoice	Acts	Send an invoice to the customer by email.
Invoice	send_invoice_whatsapp	Acts	Send an invoice to the customer via WhatsApp.
Receipt	send_receipt	Acts	Send a receipt to the customer by email.
Invoice	update_invoice	Changes	Update an existing invoice: title, due date, tax, or status.
Payment link	update_payment_link	Changes	Update an existing payment link's title, description, or amount.
Receipt	update_receipt	Changes	Update an existing receipt's details.
Subscription	update_subscription	Changes	Update a subscription's billing cycle, dates, or other details.

Purchases

Action	Key	Kind	What it does
Bill	create_bill	Creates	Create a new bill with line items, tax calculation, and vendor details.
Expense	create_expense	Creates	Create a new expense with line items, tax calculation, and vendor details.
Purchase order	create_purchase_order	Creates	Create a new purchase order with line items and vendor details.
Vendor	create_vendor	Creates	Create a new vendor with contact information and company details.
Bills	get_bills	Looks up	Retrieve bills from vendors with optional filtering and pagination.
Expenses	get_expenses	Looks up	Retrieve expenses with optional filtering and pagination.
Purchase orders	get_purchase_orders	Looks up	Retrieve purchase orders with optional filtering and pagination.
Purchase requisitions	get_purchase_requisitions	Looks up	Retrieve purchase requisitions: internal requests to buy that are approved before a purchase order is raised.
Vendors	get_vendors	Looks up	Retrieve vendors and suppliers with optional filtering and pagination.
Purchase order	receive_purchase_order	Acts	Mark purchase order goods as received, adding them to inventory.
Purchase order	send_purchase_order	Acts	Send a purchase order to the vendor by email.
Bill	update_bill	Changes	Update a bill's status, amounts, or dates.
Expense	update_expense	Changes	Update an expense's status, amount, or details.
Purchase order	update_purchase_order	Changes	Update a purchase order's status, dates, or details.
Vendor	update_vendor	Changes	Update a vendor's contact details or company information.

Shop

Action	Key	Kind	What it does
Stock	adjust_stock	Acts	Adjust the stock level of a product or one of its variants.
Products	bulk_import_products	Creates	Import multiple products at once (e.g.
Stock take	cancel_stock_take	Acts	Cancel a stock take without applying any quantity changes to inventory.
Stock take	complete_stock_take	Acts	Complete a stock take, applying all counted quantities to the actual product inventory.
Discount	create_discount	Creates	Create a new discount code or coupon with percentage or flat amount off.
Product	create_product	Creates	Create a new product with pricing, inventory, categories, attributes, variants, and attachments.
Product category	create_product_category	Creates	Create a new product category with optional parent, tags, attachments, and assigned users.
Sale campaign	create_sale	Creates	Put products on sale: a bulk markdown (percentage or amount off each product's list price) over selected products, categories, brands or the whole catalogue, optionally scheduled and optionally labelled with a badge.
Sales order	create_sales_order	Creates	Create a new sales order with line items, customer details, and payment terms.
Stock take	create_stock_take	Creates	Create a stock take (inventory count) listing expected vs counted quantities per product/variant.
Sale campaign	end_sale	Acts	End a sale campaign now: its products go back to their list price (or to another live campaign that covers them).
Discounts	get_discounts	Looks up	Retrieve discount codes and coupons with optional filtering and pagination.
Inventory	get_inventory	Looks up	Retrieve current inventory levels per product (stock on hand, reserved, and per-territory buckets).
Orders	get_orders	Looks up	Retrieve sales orders with optional filtering and pagination.
POS transactions	get_pos_transactions	Looks up	Retrieve point-of-sale transactions with optional filtering and pagination.
Product categories	get_product_categories	Looks up	Retrieve product categories with optional filtering and pagination.
Products	get_products	Looks up	Retrieve a list of products with optional filtering and pagination.
Sale campaigns	get_sales	Looks up	Retrieve sale campaigns (bulk markdowns across products, categories, brands or the whole catalogue) with their rule, window, product count and status.
Stock movements	get_stock_movements	Looks up	Retrieve the stock movement ledger (sales, purchases, adjustments, transfers, stock takes) with optional filtering and pagination.
Stock takes	get_stock_takes	Looks up	Retrieve stock takes (inventory counts) with their status and counted items.
Product reviews	list_product_reviews	Looks up	List the reviews customers left on products, newest first.
Review reply	reply_to_product_review	Acts	Publicly reply to a customer's product review as the business.
Sales order	send_sales_order	Acts	Send a sales order to the customer by email.
Product variants	set_product_variants	Changes	Change the variants of an EXISTING product (variants CAN be changed after creation — never recreate, copy or hide a product to change them).
Discount	update_discount	Changes	Update a discount code's value, dates, or usage limits.
Product	update_product	Changes	Update a product's title, description, status, price, cost price, category, brand, SKU, barcode, or reorder point.
Product category	update_product_category	Changes	Update a product category's title or description.
Product variant	update_product_variant	Changes	Update one variant of a product — its title, SKU, price, cost price, reorder point, or active flag.
Sales order	update_sales_order	Changes	Update a sales order's status, dates, or details.

Web

Action	Key	Kind	What it does
Read a web page	read_web_page	Looks up	Read one public web page and return its title and main text (markdown, long pages are cut).
Search the web	web_search	Looks up	Search the internet for current public information (news, prices, rates, a company's website or contacts).