activate_subscription
ChatGPTManually activate a pending subscription, starting its first billing period immediately.
apply_agent_default_plan
ChatGPTApply the workspace's default AI agent billing plan to one customer (by id or external id). Idempotent; refuses (409) if the customer already has a different billing policy, 404 when no default plan is set.
approve_quote
ChatGPTApprove a quote as the account owner. This is a prerequisite before sending the quote for customer signature.
archive_customer
ChatGPTArchive a customer by ID. Archived customers are hidden from default list views but can be restored.
archive_feature
ChatGPTArchive a feature definition.
archive_product
ChatGPTArchive a product by ID. Archived products cannot be added to new subscriptions but remain on existing ones.
attach_spend_contract_file
ChatGPTAttach an already-uploaded file to a contract. Returns the updated contract with its files.
bulk_confirm_spend_charges
ChatGPTConfirm many suggested charges at once. Each id behaves like the single confirm (learns the transaction label as the supplier's matching pattern); ids that aren't a still-suggested charge of this client are silently skipped. Returns the number of charges confirmed.
bulk_dismiss_spend_charges
ChatGPTDismiss many suggested charges at once. Each dismissed row stays as permanent memory so its transaction is never re-suggested; ids that aren't a still-suggested charge of this client are silently skipped. Returns the number of charges dismissed.
bulk_match_spend_transactions
ChatGPTAttribute up to 500 transactions to ONE supplier — an existing one (supplier_id) or one created on the fly (new_supplier, deduped by name) — with an optional contract. Replace semantics per row; ineligible rows (missing, foreign, inflows) are silently skipped. No look-alike sweeping. matched_count reports the rows actually attributed.
bulk_set_spend_transactions_accounting_category
ChatGPTSet (or clear with null) the accounting-software category (provider category id + display label) on the live charge of up to 500 transactions. Charge-less transactions are skipped. updated_count reports the rows written.
bulk_set_spend_transactions_category
ChatGPTSet (or clear with null) the per-payment category override on the live charge of up to 500 transactions. Charge-less transactions are skipped. updated_count reports the rows written.
bulk_set_spend_transactions_pnl_flags
ChatGPTSet the P&L flags (excluded_from_pnl, is_one_off) on the live charge of up to 500 transactions. An omitted field is left untouched. Charge-less transactions are skipped. updated_count reports the rows written.
bulk_update_customers_providers
ChatGPTBulk update provider mappings for multiple customers. Optionally sync payment methods from connected PSPs. Check the response for per-customer success/failure status.
cancel_spend_contract
ChatGPTCancel a supplier contract. A future ends_at schedules the end; omitted or past ends_at ends it now.
cancel_subscription
ChatGPTCancel a subscription. Supports immediate or end-of-period cancellation. Optionally specify a cancellation reason.
cancel_subscription_transition
ChatGPTCancel a scheduled subscription transition before it is applied.
charge_invoice
ChatGPTManually trigger payment collection for an invoice. Optionally specify a payment_method_id to charge.
clear_agent_default_plan
ChatGPTClear the workspace's default AI agent billing plan marker. The plan itself is untouched. 404 when none is set.
clear_product_ai_rate_card
ChatGPTDetach a credit product's default AI rate card without deleting the card, or return 404 when none is attached.
close_ledger_period
ChatGPTClose every month of a ledger through an ended month, after posting the revenue recognition due by its end; a user token needs the accounting_close permission.
confirm_spend_charge
ChatGPTConfirm a suggested charge. Learns the transaction label as a matching pattern for the supplier.
count_spend_contracts_by_status
ChatGPTReturn the count of supplier contracts grouped by status.
create_accounting_rule
ChatGPTCreate a new accounting rule for account code routing or journal posting, with the filters, accounts and required fields the rule editor applies to its category.
create_agent_cost_catalog_item
ChatGPTCreate a custom provider/item cost; an existing pair returns 200 with its unchanged rates, so use PUT /v1/ai/billing/costs/items/:id to edit it.
create_agent_plan
ChatGPTCreate an AI agent billing plan: name, billing mode (wallet/credits/windows), rate card reference, allowance windows, markups, per-seat credit grants and overage stance. Past-limit usage is priced EITHER by overage_markup_percent over the base rates OR by overage_rate_card_id, a currency rate card whose own rates are the overage price — never both. Metered overage mints the plan's invoice container.
create_agent_rate_card
ChatGPTCreate an AI rate card with llm rows (per-1M input/output token rates) and item rows (per-unit rates), a denomination (credits/units/currency) and an optional USD fallback conversion.
create_aggregator
ChatGPTCreate a new aggregator that counts or sums billable events. Aggregators can then be linked to products via aggregator_id.
create_company
ChatGPTCreate a new company. The authentication token will automatically get access to the newly created company.
create_contract_clause
ChatGPTCreate a contract clause in the contract library, with a default text and optional translations keyed by language code.
create_contract_document
ChatGPTCreate a contract document in the contract library. Its files are added afterwards per language with create_contract_document_content.
create_contract_document_content
ChatGPTAdd a content to a contract document: its files for one language (default as fallback) and optional countries, sent as a comma-separated list. At least one PDF or Word file is required.
create_coupon
ChatGPTCreate a new coupon with discount rules. Supports percentage or fixed amount discounts, duration limits, and redemption restrictions.
create_credit_note
ChatGPTCreate a credit note for an existing invoice by ID. Credit notes partially or fully reverse an invoice amount. Optionally trigger a refund via wallet, original payment method, or external settlement.
create_custom_property
ChatGPTCreate a new custom property definition with a name, type (string, number, boolean, date, select), and optional default value.
create_customer
ChatGPTCreate a new customer with billing details, address, currency, and optional provider mappings. Returns the full customer object.
create_customer_address
ChatGPTCreate a shipping address with type shipping; billing creation is rejected because a customer can have at most one billing address, managed through the customer endpoint.
create_customer_credit
ChatGPTCreate a credit entity for a customer linked to a specific product with an optional initial balance.
create_customer_credits_usage
ChatGPTRecord credit usage for a customer's credit product. Deducts the specified usage_retained amount from the balance.
create_customer_payment_method
ChatGPTImport an existing payment method from a connected payment provider (e.g. Stripe) for a customer.
create_customers
ChatGPTCreate up to 50 customers in a single batch request. Returns successes and errors separately for each customer in the batch.
create_customers_segment
ChatGPTCreate a new customer segment.
create_data_loader_query
ChatGPTCreate a data loader query after verifying it against the warehouse.
create_export
ChatGPTPrepare a data export (customers, invoices, etc.) for download. Check export status via get_export, then download via download_export once ready.
create_feature
ChatGPTCreate a feature definition.
create_file
ChatGPTUpload a new file (max 10MB). Requires multipart form data with a file field and metadata (name, optional customer_id).
create_file_upload
ChatGPTStage a file for upload instead of inlining it as base64. Returns upload_url and id. Send the raw bytes with curl -T <local_path> "<upload_url>" (HTTP PUT, no extra headers) within 15 minutes, then pass { "upload_id": "<id>" } in place of { filename, mime_type, content_base64 } in any tool that accepts files (e.g. quote attachments). Prefer this over inline base64 for any file you have on disk.
create_general_ledger_export
ChatGPTQueue an XLSX general-ledger export for a ledger and inclusive period.
create_income_statement_export
ChatGPTQueue an XLSX income-statement export for a ledger and inclusive period.
create_invoice
ChatGPTCreate a new invoice for a customer with line items, due date, and billing configuration. Returns the full invoice object.
create_invoice_transaction
ChatGPTRecord a payment transaction on an invoice. May update the invoice status to paid or partially_paid depending on the amount.
create_invoices
ChatGPTCreate multiple invoices asynchronously in batch. Track results via webhooks (invoice.batch.creation_succeeded / invoice.batch.creation_failed). Returns a batch_id.
create_invoicing_entity
ChatGPTCreate a new invoicing entity with company details, address, and tax configuration. Used as the sender on invoices.
create_ledger
ChatGPTCreate an accounting ledger for an invoicing entity.
create_ledger_account
ChatGPTCreate an account in an accounting ledger.
create_manual_journal_entry
ChatGPTCreate and post a balanced manual journal entry attributed to the current user or API credential.
create_payment
ChatGPTInitiate a one-time payment: generates an invoice and charges it directly or via a checkout session. Returns references to the created invoice and optional checkout URL.
create_price_configuration
ChatGPTCreate a new price configuration on an existing product. Specify the product_id, pricing type (fee, volume, bulk, packaged, bps, bundle), currency, billing interval, and price tiers. Supports metering_filter for dynamic products.
create_product
ChatGPTCreate a new product with name, type (flat_fee, per_unit, usage, seat, etc.), and pricing configuration.
create_promotion_code
ChatGPTCreate a new promotion code linked to an existing coupon. The code can be shared with customers for self-service discount application.
create_quote
ChatGPTCreate a new quote for a customer. Use subscription (or template_id) for subscription quotes; use invoice for one-off quotes backed by a draft invoice with line items. Quotes can be sent for signature and converted to subscriptions or one-off invoices.
create_rev_rec_recognized_summary_export
ChatGPTQueue an XLSX or CSV summary of recognized revenue for a month range.
create_rev_rec_waterfall_export
ChatGPTQueue an XLSX waterfall export for a ledger and year.
create_spend_category
ChatGPTAdd a category to the client's taxonomy. Its key is derived from the name and then frozen, so renaming the category later never breaks a filter or an integration. The new category sorts last and is usable everywhere a platform category is.
create_spend_contract
ChatGPTCreate a supplier contract, attaching to an existing supplier (supplier_id) or a new one (new_supplier). Optionally attach already-uploaded files.
create_spend_manual_charge
ChatGPTRecord a supplier charge that has no bank transaction (e.g. a past charge declared manually), attached to a contract and confirmed on creation.
create_spend_supplier
ChatGPTCreate a supplier for the client.
create_subscription
ChatGPTCreate a new subscription from a template, plan, or manually with products and phases. Requires a customer_id and at least one of: template_id, template_configuration_id, products, or phases.
create_subscription_transition
ChatGPTCreate a transition from one subscription to another, configured from a subscription, plan, or template. Can be applied immediately or scheduled.
create_subscription_update
ChatGPTApply a single update to an existing subscription (e.g. change quantity, add/remove product, modify price).
create_subscription_updates
ChatGPTApply multiple updates at once to an existing subscription in a single atomic operation.
create_transaction
ChatGPTRecord an offline payment, refund, or chargeback; this records money already moved and does not initiate a payment.
create_wallet
ChatGPTCreate a new prepaid wallet for a customer with an initial balance and currency.
create_webhook_endpoint
ChatGPTCreate a new webhook endpoint with a URL and list of event types to subscribe to.
delete_accounting_rule
ChatGPTSoft-delete an accounting rule.
delete_agent_cost_catalog_item
ChatGPTClose a custom AI cost item by its custom_item_id. History is kept; new calls on that pair go back to unpriced. An override id passed here is a 404.
delete_agent_cost_catalog_override
ChatGPTClose this workspace's negotiated price override by its override.id; pricing falls back to the global registry rate. A custom cost item id passed here is a 404.
delete_agent_customer_billing_policy
ChatGPTDelete one customer's AI billing policy scope. Refused (409) while it owes unsettled consumption or while agent overrides still depend on it.
delete_agent_plan
ChatGPTDelete an AI agent billing plan. Refused (409, plan_in_use) while any customer is still attached to it.
delete_agent_rate_card
ChatGPTDelete an AI rate card. Refused (409, rate_card_in_use) while any plan, credit product or customer policy still uses it.
delete_aggregator
ChatGPTDelete an aggregator by ID. Will fail if the aggregator is linked to a product.
delete_billable_events
ChatGPTDelete existing billable events.
delete_contract_clause
ChatGPTDelete a contract clause from the contract library. Existing quotes keep their copy of the clause.
delete_contract_document
ChatGPTDelete a contract document from the contract library. Existing quotes keep their copy of the files.
delete_contract_document_content
ChatGPTDelete a content (one language and countries version) of a contract document.
delete_coupon
ChatGPTPermanently delete a coupon by ID. This cannot be undone.
delete_custom_property
ChatGPTDelete an existing custom property definition by ID. This removes the property from all entities.
delete_customer
ChatGPTPermanently delete a customer by ID. The customer must be archived first. This cannot be undone.
delete_customer_address
ChatGPTDelete an address. To delete the default shipping address, first select another shipping address or use the billing address.
delete_customer_feature
ChatGPTDelete a feature override from a customer.
delete_customer_payment_method
ChatGPTRemove a payment method from a customer. The payment method is deleted permanently.
delete_data_loader_query
ChatGPTSoft-delete a data loader query and return the deleted record.
delete_default_customer_billing_policy
ChatGPTDelete one customer's AI billing policy scope. Refused (409) while it owes unsettled consumption or while agent overrides still depend on it.
delete_feature
ChatGPTDelete an archived feature definition that is not in use.
delete_file
ChatGPTPermanently delete a file by ID.
delete_invoice
ChatGPTDelete a draft or externally-imported invoice. For finalized invoices, use void_invoice instead.
delete_invoice_transaction
ChatGPTDelete a scheduled transaction from an invoice. Only applies to transactions that haven't been processed yet.
delete_invoicing_entity
ChatGPTSoft-delete an invoicing entity by ID. Existing invoices linked to it are preserved.
delete_ledger
ChatGPTPermanently delete a ledger with its accounts, rules, journal entries and revenue recognition schedules, and unlink the suppliers, supplier contracts and accounting settings that reference it.
delete_ledger_account
ChatGPTDelete an unused accounting ledger account.
delete_price_configuration
ChatGPTDelete a price configuration by ID. This removes the pricing option from the product.
delete_product
ChatGPTPermanently delete an archived product by ID. Products attached to subscriptions, plans, or templates cannot be deleted.
delete_product_feature
ChatGPTDelete a feature value from a product.
delete_promotion_code
ChatGPTPermanently delete a promotion code by ID. This cannot be undone.
delete_spend_category
ChatGPTRemove a category. ARCHIVES it whenever deleting it would orphan spend — any supplier, contract or charge still classified under it — and always for the 14 platform categories. An archived category stops being offered for new assignments but keeps classifying the spend already attributed to it, so reports do not change. Only a custom category nothing references is actually deleted. The response says which happened.
delete_spend_charge
ChatGPTSoft-delete (detach) a charge.
delete_spend_contract
ChatGPTSoft-delete a supplier contract by id.
delete_spend_supplier
ChatGPTSoft-delete a supplier by id. Fails with 409 while it still has active contracts.
delete_transaction
ChatGPTDelete an unallocated offline transaction with no wallet funding or dependent transactions; this does not reverse a payment.
delete_webhook_endpoint
ChatGPTDelete a webhook endpoint. No further events will be delivered to it.
detach_spend_contract_file
ChatGPTDetach a file from a contract. Returns the updated contract with its remaining files.
discard_catalog_draft
ChatGPTDiscard the pending product catalog draft without publishing it.
disconnect_spend_payroll_integration
ChatGPTDisconnect the Payfit payroll integration and delete its stored credentials. Already-pulled payroll periods are kept.
dismiss_spend_charge
ChatGPTDismiss a suggested charge. The row stays as permanent memory so the transaction is never re-suggested.
download_export
ChatGPTDownload the file for a completed export. Supports CSV, JSON, and XLSX formats depending on the export type.
download_file
ChatGPTDownload the raw content of a file by ID. Returns the file binary with appropriate content type.
download_invoice
ChatGPTDownload the PDF of an invoice. For draft/open invoices, generates the PDF on the fly. Supports lang/locale params for localization.
download_quote
ChatGPTDownload the PDF of a quote. Supports locale parameter for localization.
download_quote_file
ChatGPTDownload an attachment or manually signed PDF file from a quote.
duplicate_quote
ChatGPTCreate a draft duplicate of an existing quote, including its linked invoice or subscription configuration.
finalize_quote
ChatGPTFinalize a draft quote. The quote is submitted for approval when approval is required, otherwise it becomes approved and ready to be sent for signature.
get_accounting_rule
ChatGPTRetrieve a single accounting rule by its identifier.
get_accounting_rule_tree
ChatGPTRetrieve accounting rules organized as a filter tree. Accounting software sync rules are excluded.
get_agent_customer_balance
ChatGPTGet one customer's live AI balance, shaped by their billing mode: wallet shadow balance, credit pot, or rolling window meters with reset times. Includes per-agent scopes and overage state.
get_agent_customer_billing_policy
ChatGPTGet the exact customer billing policy addressed by this resource; agent policies never fall back to the shared pool.
get_agent_default_plan
ChatGPTGet the workspace's default AI agent billing plan marker (plan id and auto_apply flag). 404 when none is set.
get_agent_plan
ChatGPTGet one AI agent billing plan by id, with its embedded rate card, window definitions, markups, per-seat grants and minted catalog object ids.
get_agent_rate_card
ChatGPTGet one AI rate card by id with all its pricing rows and usage counts (plans, policies, credit product).
get_aggregator
ChatGPTRetrieve a specific aggregator by ID.
get_aggregator_usage
ChatGPTRetrieve a usage row for an aggregator. Use the timeseries, group-by-customer or events endpoints to query metering data.
get_aggregator_usage_events
ChatGPTList raw billable events for an aggregator across every customer of the client. Paginated with take/skip.
get_aggregator_usage_group_by_customer
ChatGPTPer-customer total usage for an aggregator over a period, ranked by total. Paginated with take/skip.
get_aggregator_usage_timeseries
ChatGPTGet client-wide usage for an aggregator bucketed by month/day/hour over a period.
get_analytics
ChatGPTRetrieve pre-computed account analytics including ARR, MRR, revenues, churn rate, and other key billing metrics. Optionally filter by invoicing_entity_id. Use this to get a high-level financial overview.
get_bank_account
ChatGPTRetrieve a specific bank account by its ID. Returns bank account details including IBAN, BIC, and currency.
get_catalog_context
ChatGPTCompact, bounded summary of the live product catalog: products with their pricing model, usage meter, and nested price configurations and prices. Use it to discover the product IDs and price configuration IDs that subscription and quote payloads reference, instead of paging through list_products and get_product. Filter with query (substring on ID, configuration key, and name) and page size with limit; truncated: true means more products matched than were returned.
get_catalog_draft
ChatGPTGet the pending product catalog draft (null when there is none).
get_contract_clause
ChatGPTRetrieve a contract clause by ID.
get_contract_document
ChatGPTRetrieve a contract document by ID, with its contents and their files.
get_coupon
ChatGPTRetrieve a specific coupon by ID including its discount configuration, redemption count, and deletion status.
get_customer
ChatGPTRetrieve full details of a customer by ID including billing info, address, subscriptions, custom properties, integrations, payment method, and bank account.
get_customer_arr_history
ChatGPTList every subscription-level ARR evolution for a customer, including previous and current fixed, variable, and total annual values in each subscription currency. Results are latest-first and paginated with limit/cursor.
get_customer_credit
ChatGPTRetrieve details of a specific credit product for a customer, including current balance, configuration, and product info.
get_customer_credit_portal_settings
ChatGPTGet whether a customer can top up a credit product from the customer portal, at which price, and which prices can be selected.
get_customer_payment_method
ChatGPTRetrieve details of a specific payment method by ID including type, last4, expiry, and default status.
get_customer_portal_url
ChatGPTGet a portal URL for a customer. The portal allows the customer to view invoices, update payment methods, and manage their account.
get_customer_shipping_destination
ChatGPTGet the billing or shipping destination and its resolved address object, or null if no address exists.
get_customer_tax_rates
ChatGPTRetrieve the eligible tax rates for a specific customer based on their location and tax configuration.
get_customer_usage
ChatGPTGet the usage of a customer for a specific aggregator over a period.
get_customer_usage_events
ChatGPTList raw billable events for a customer + aggregator over a period. Paginated with take/skip.
get_customer_usage_timeseries
ChatGPTGet per-bucket usage for a customer + aggregator (month/day/hour).
get_customer_valuation
ChatGPTCompute aggregated valuation metrics for a customer across all active subscriptions, grouped by currency. Returns contract value, recurring contract value, and ARR for each subscription and aggregated totals. Optionally pass granularity (year/quarter/month) for period breakdown.
get_data_loader_connection
ChatGPTGet a single data loader connection by id.
get_data_loader_query
ChatGPTGet a single data loader query by id.
get_default_customer_billing_policy
ChatGPTGet the exact customer billing policy addressed by this resource; agent policies never fall back to the shared pool.
get_events
ChatGPTRetrieve billable events filtered by event type.
get_export
ChatGPTCheck the status of an export by ID. Status can be pending, processing, or completed. Use download_export to get the file once completed.
get_feature
ChatGPTRetrieve a feature definition.
get_invoice
ChatGPTRetrieve the details of an invoice by ID including line items, transactions, customer info, and billing metadata.
get_invoicing_entity
ChatGPTRetrieve a specific invoicing entity by ID with its full configuration (address, tax ID, branding, payment settings).
get_journal_entry
ChatGPTRetrieve a journal entry and its lines by identifier.
get_ledger
ChatGPTRetrieve an accounting ledger by its identifier.
get_ledger_account
ChatGPTRetrieve a ledger account by its identifier.
get_ledger_close_state
ChatGPTRetrieve the last closed month of a ledger and the latest month that can be closed.
get_monitoring_analysis
ChatGPTGet one customer health analysis by ID: health score (0-100), tier, summary, per-dimension scores, risk factors and positive signals.
get_organisation
ChatGPTRetrieve details of an organisation by ID. Organisations group customers and can have their own billing configuration.
get_price_configuration
ChatGPTRetrieve a price configuration by ID, including its prices and external integration references.
get_product
ChatGPTRetrieve full details of a product by ID including up to 50 price configurations. Use list_price_configurations for the complete list. Optionally filter by price_book_id.
get_product_ai_rate_card
ChatGPTGet the default AI rate-card reference for a credit product, or 404 when none is attached.
get_promotion_code
ChatGPTRetrieve a specific promotion code by ID with its linked coupon details.
get_quote
ChatGPTRetrieve full details of a quote by ID including line items, status, signature info, and linked subscription.
get_quote_approvals
ChatGPTRead quote approvals without submitting the quote. Returns a newest-first array, currently containing one element. Draft and changes-requested quotes return current approval routing in preview mode; other statuses return the recorded request, ordered steps and decisions in execution mode. A null request means no workflow execution was recorded, including automatic and legacy approval.
get_quote_template
ChatGPTRetrieve a quote template by ID with quote defaults, display options, attachments, and linked contract template/clause IDs.
get_quote_valuation
ChatGPTCompute valuation metrics for a quote: contract value (total/invoiced/remaining), recurring contract value, and ARR (fixed + variable). Optionally pass granularity (year/quarter/month) for period breakdown. Returns 404 if the quote has no subscription or is not a subscription-type quote.
get_rev_rec_schedule
ChatGPTRetrieve a revenue-recognition schedule with its slices.
get_rev_rec_slice
ChatGPTRetrieve a tenant-scoped revenue-recognition slice.
get_rev_rec_waterfall
ChatGPTAggregate revenue-recognition schedules into a booked-by-recognition month matrix.
get_rev_rec_waterfall_cell
ChatGPTList the schedules and slices contributing to a waterfall cell.
get_rule_defaults
ChatGPTPreview default account values and priority for a new accounting rule.
get_spend_cashflow
ChatGPTMonthly cashflow timeline (past + current + future, ascending) combining real bank inflow actuals and committed inflow run-rate with real bank outflow actuals and the contract billing projection, plus committed monthly run-rate summary, in the client's reporting currency.
get_spend_cashflow_month
ChatGPTDrill-down for one month of the cashflow grid, powering the side panel: the month's KPI numbers (identical to GET /spend/cashflow for that month) plus the per-occurrence detail behind outflow_projected (each projected contract billing occurrence with its date, native + reporting amount, contract and supplier). month is a first-of-month key YYYY-MM-01 within ±24 months of the current month. Money-in detail is served separately by the open-banking transactions endpoint.
get_spend_contract
ChatGPTRetrieve a single supplier contract by id with its supplier and attached files.
get_spend_payroll_integration
ChatGPTThe client's connected payroll integration (Payfit), or null when none is connected. The stored API key is never returned — only api_key_set.
get_spend_pnl
ChatGPTMonthly profit & loss statement over the trailing months window (ending on the current month), in the client's reporting currency: revenue (recurring / one-off / variable, service-period bucketed from the MRR financials), expense sections built from ALL bank outflows categorized through the spend taxonomy (COGS, OpEx, non-operating, plus an uncategorized row), the computed gross-profit / EBITDA / net lines with margins, and a reconciliation block proving the rows tie back to total bank outflows. mode=cash (default) books an expense in the month the money left the bank; mode=smoothed amortizes contracted confirmed charges evenly over the contract billing period they pay for (an annual prepayment becomes 12 monthly slices) — revenue and payroll are identical in both modes.
get_spend_settings
ChatGPTThe module-wide spend settings (projected-growth rates for the cashflow projections, external cash balance, P&L category overrides, CAC payroll allocation) plus the observed monthly inflow growth over the trailing 12 complete months as a hint.
get_spend_stats
ChatGPTAggregate spend KPIs (monthly spend, annual run rate, active contracts, upcoming renewals) in the client's reporting currency.
get_spend_supplier
ChatGPTRetrieve a single supplier by id, enriched with its spend aggregates (active contract count, trailing-12-month spend per currency and folded to the reporting currency, all-time folded total, and a zero-filled trailing-12-month reporting-currency grid).
get_spend_transaction
ChatGPTFetch a single outgoing bank transaction by id, enriched exactly like a list row: its live charge overlay, resolved supplier / contract / category / owner, newest invoice file and the accounting-provider (Pennylane) category / note / receipt. Returns 404 when the id doesn't exist or isn't an outgoing spend candidate for the client.
get_spend_transaction_counts
ChatGPTReturn the transaction triage counts for the default 90-day window (no other filters, and payroll-classified transactions excluded exactly as the default list excludes them): all (total outgoing candidates), matched / suggested / unmatched by live charge state (summing to all), uncategorized (no resolved contract/supplier category and no accounting-provider category label) and needs_review (the triage inbox — everything that is not a confirmed AND categorized transaction). Powers the match-state filter badges.
get_subscription
ChatGPTRetrieve full details of a subscription by ID including phases, products, billing dates, and status. Optionally include live_billing data.
get_subscription_arr_history
ChatGPTList every ARR evolution for a subscription, including previous and current fixed, variable, and total annual values in the subscription currency. Results are latest-first and paginated with limit/cursor.
get_subscription_phase
ChatGPTRetrieve details of a specific phase within a subscription, including its products and billing configuration.
get_subscription_template
ChatGPTRetrieve a subscription template by ID with its full configuration including products, phases, and pricing details.
get_subscription_transition
ChatGPTRetrieve details of a subscription transition by ID including source/target subscriptions and schedule.
get_subscription_valuation
ChatGPTCompute valuation metrics for a subscription: contract value (total/invoiced/remaining), recurring contract value, and ARR (fixed + variable). Optionally pass granularity (year/quarter/month) for period breakdown.
get_tax_rate
ChatGPTRetrieve details of a custom tax rate by ID including rate percentage, applicable countries, and linked invoicing entity.
get_transaction
ChatGPTRetrieve a transaction by ID, including its current invoice allocations.
get_unbilled_revenue
ChatGPTGet revenue accrued on a subscription's current open invoice.
get_wallet
ChatGPTRetrieve details of a wallet by ID including current balance, currency, and linked customer.
get_wallet_settings
ChatGPTRetrieve global wallet settings for the account (e.g. default currency, auto-topup configuration).
get_webhook_endpoint
ChatGPTRetrieve details of a webhook endpoint by ID including URL, subscribed events, and status.
ingest_billable_event
ChatGPTIngest a new billable event. This endpoint is idempotent, an event with the same id will be updated if it already exists.
ingest_billable_events
ChatGPTIngest several billable events in batch (limited to max 5000 events per request). This endpoint is idempotent, an event with the same id, will be updated if it already exists.
list_accounting_rules
ChatGPTRetrieve existing accounting rules with optional filtering.
list_agent_cost_catalog
ChatGPTList the AI cost catalog: registry model prices merged with this workspace's negotiated overrides, its own custom cost items (source custom), and the unpriced pairs its telemetry has carried (source unlisted). Rates are USD decimal strings. Pass enabled_only=true for just the enabled catalog.
list_agent_customer_consumption
ChatGPTList one customer's AI consumption ledger entries, newest first, with amounts, denominations and overage flags. Filter by agent scope, overage, and from/to time range; paginated with take/skip.
list_agent_customer_policies
ChatGPTList all AI billing policies (scopes) for one customer: the default shared pool plus per-agent overrides. Accepts Hyperline or external customer ids.
list_agent_plans
ChatGPTList AI agent billing plans: workspace-level offers carrying a billing mode (wallet/credits/windows), rate card, allowance windows, markups and per-seat credit grants. Filter by mode; paginated with take/skip.
list_agent_rate_cards
ChatGPTList AI rate cards: named pricing row sets in credits, window units or currency. Shows what plans/policies/products depend on each. Filter by denomination, currency or name search; paginated with take/skip.
list_aggregators
ChatGPTList all aggregators with pagination. Aggregators define how billable events are counted or summed to compute usage.
list_bank_account_transactions
ChatGPTList open banking transactions for a specific bank account. Paginated with limit/cursor.
list_bank_accounts
ChatGPTList all bank accounts configured on the account. Returns paginated results with take/skip.
list_catalog_versions
ChatGPTList product catalog versions (pending draft and published history). Catalog versioning must be enabled for the organisation.
list_companies
ChatGPTList all companies accessible to the current authentication token. A company represents an organizational unit.
list_contract_clauses
ChatGPTList the contract clauses of the contract library, with their texts and translations. Use the returned IDs in contract_clause_ids when creating a quote. Paginated with take/skip.
list_contract_documents
ChatGPTList the contract documents of the contract library (terms of service, DPA, SLA...), with their contents per language and countries and the files of each content. Paginated with take/skip.
list_coupons
ChatGPTList all coupons with pagination (take/skip). Coupons define discount rules (percentage or fixed amount) that can be applied to subscriptions or invoices.
list_custom_properties
ChatGPTList all custom properties defined on the account. Custom properties are user-defined fields that can be attached to customers, subscriptions, and other entities.
list_customer_addresses
ChatGPTList active addresses: at most one billing address and multiple shipping addresses per customer.
list_customer_credit_transactions
ChatGPTList all transactions (purchases, topups, usages) for a specific credit product. Paginated with take/skip and optional filters.
list_customer_credits
ChatGPTList credit products attached to a specific customer. Paginated with take/skip.
list_customer_payment_methods
ChatGPTList all payment methods attached to a specific customer (cards, SEPA mandates, etc.).
list_customer_usage
ChatGPTList one usage row per aggregator for a single customer over a period (total + event count per aggregator).
list_customers
ChatGPTList customers with optional filters for name, type, status, currency, country, external_id, billing_email, search, tax_id, subscription_status, invoicing_entity_id, segment_id, custom_properties, payment_method_type, integration_entity_id, created_at, and updated_at. Sortable by created_at or updated_at. Paginated with limit/cursor.
list_customers_credits
ChatGPTList credit products across all customers with optional filters for product_id, customer_id, and updated_at. Paginated with take/skip.
list_customers_segments
ChatGPTRetrieve all customer segments.
list_data_loader_connections
ChatGPTList the client's data loader connections with their non-deleted queries.
list_data_loader_queries
ChatGPTList the client's data loader queries, optionally filtered by a sentinel task.
list_exports
ChatGPTList the client's data exports (customers, invoices, etc.) with pagination. Use take/skip to page through results.
list_features
ChatGPTList feature definitions.
list_files
ChatGPTList uploaded files with optional filters for name and customer_id. Paginated with take/skip.
list_invoices
ChatGPTList invoices with filters for type, status, customer_id, customer_external_id, subscription_id, invoicing_entity_id, invoice_number, period dates, emission_date, due_date, and updated_at. Sortable by created_at or emitted_at. By default, open invoices are excluded. Paginated with limit/cursor.
list_invoicing_entities
ChatGPTList all invoicing entities (legal entities that issue invoices). Each has its own address, tax ID, and branding. Paginated with take/skip.
list_journal_entries
ChatGPTList accounting journal entries with optional filters.
list_journal_entry_lines
ChatGPTList journal entry lines with optional filters.
list_ledger_accounts
ChatGPTList accounting ledger accounts with optional balances.
list_ledger_close_events
ChatGPTList the closes and reopens of a ledger, newest first, with who did them and why.
list_ledgers
ChatGPTList accounting ledgers for the authenticated client.
list_monitoring_analyses
ChatGPTList customer health analyses from the monitoring agent, newest first: health score (0-100), tier, summary, per-dimension scores, risk factors and positive signals. Filter by customer (Hyperline or external ID) with limit=1 to get a customer's current health score. Only completed analyses unless status is set.
list_organisations
ChatGPTRetrieve organisations with their billing details and child customer IDs.
list_price_configurations
ChatGPTList price configurations with optional filters for product_id and price_book_id. Price configurations define how a product is priced (tiers, volume, graduated, etc.). Paginated with take/skip.
list_primary_ledger_accounts
ChatGPTList accounts from the primary ledger of an invoicing entity.
list_product_features
ChatGPTList feature values assigned to a product.
list_products
ChatGPTList products with optional filters for id, status, name, description, type, and price_book_id. Products define what is being sold (flat fee, per-unit, usage-based, etc.). Paginated with take/skip.
list_promotion_codes
ChatGPTList promotion codes with optional filter by coupon_id. Promotion codes are shareable codes that reference a coupon. Paginated with take/skip.
list_quote_signers
ChatGPTList the signers of a quote in signing order, with each signer's status (pending, notified, viewed, signed, declined). An empty list means the quote uses the single-signer flow of send_quote.
list_quote_templates
ChatGPTList quote templates with pagination and optional filters for id, name, subscription_template_id, and search. Use template IDs to create quotes from reusable quote defaults.
list_quotes
ChatGPTList quotes with optional filters for id, number, status, customer_id, template_id, crm_opportunity_id, type, and updated_at. Paginated with take/skip.
list_rev_rec_schedule_adjustments
ChatGPTList the audit trail for manual schedule adjustments.
list_rev_rec_schedules
ChatGPTList revenue-recognition schedules with embedded slices.
list_similar_spend_transactions
ChatGPTPreview the outgoing transactions similar to an anchor — same merchant key, last 90 days, excluding the anchor — so a user can validate before re-pointing them all to one supplier. Includes transactions that already carry a live charge, overlaying their current supplier so wrong attributions surface. Returns merchant_key: null with no data when the anchor has no viable merchant key.
list_spend_accounting_categories
ChatGPTList the client's accounting-software categories live from their accounting integration (the taxonomy the transactions panel's category selector offers). Empty when no supported verified integration is connected.
list_spend_categories
ChatGPTList the client's spend categories in render order. Every client starts with the 14 platform categories and can rename, re-section, reorder, archive and add to them; the key of a platform category never changes, so it stays the stable value in filters and reports. Archived categories are excluded unless include_archived is set — they still classify existing spend, so pass it whenever you need to label historical rows. Distinct from the accounting-software categories on /spend/accounting-categories, which are pulled read-only from the client's accounting integration.
list_spend_charges
ChatGPTList supplier charges with pagination and filters (supplier, contract, status, date range).
list_spend_contract_charges
ChatGPTList the charges attached to a contract, suggested first then most recent charge first.
list_spend_contracts
ChatGPTList supplier contracts with pagination, filters, sorting and the embedded supplier slice.
list_spend_payroll_collaborators
ChatGPTThe collaborators imported from the payroll provider, alphabetical, with the department their payroll cost is attributed to. department_source is auto when it was inferred from the job title and manual when an operator set it; null means untagged. active is true when the contract covers today. NO compensation data is imported or returned.
list_spend_payroll_periods
ChatGPTMonthly payroll aggregates pulled from the payroll provider, oldest first, optionally windowed with from/to (any day inside a month selects that month). Amounts are minor units of currency, employer-cost view: total_employer_cost = gross_salaries + employer_contributions + other_costs.
list_spend_suppliers
ChatGPTList suppliers for the client with pagination, filters, active contract counts and trailing 12-month spend.
list_spend_top_categories
ChatGPTSpend per resolved category (charge override, else contract, else supplier) over the trailing months window (default 3), folded into the reporting currency, the top top descending plus one aggregated category: null bucket (everything else + uncategorized) last.
list_spend_top_suppliers
ChatGPTSupplier spend ranking over the trailing months window (default 3): confirmed charges folded into the reporting currency, ranked by total descending. Paginated (take/skip); count is the number of ranked suppliers.
list_spend_transactions
ChatGPTList outgoing bank transactions (last 90 days by default, or a from/to window) overlaid with their live charge state, resolved supplier / contract / category / owner and newest invoice file. Filterable by supplier, contract, category, one-off flag (one_off), match state, currency, amount magnitude (amount_min/amount_max, positive minor units), bank account (bank_account_id) and search; sortable by date or amount. With internal, lists the flagged internal transfers instead (either direction) so they can be reviewed and un-marked. Payroll-classified transactions are HIDDEN by default (the P&L reports their cost from the payroll journal); pass class=payroll to list only those.
list_spend_upcoming_renewals
ChatGPTList active contracts due to renew within the window (default 60 days, max 365), ordered by their renewal deadline ascending.
list_subscription_phases
ChatGPTList all phases of a subscription. Phases define time-bound product configurations within a subscription.
list_subscription_templates
ChatGPTList subscription templates with pagination. Templates define reusable subscription configurations with pre-configured products, phases, and billing settings.
list_subscription_transitions
ChatGPTList subscription transitions (migrations from one subscription to another). Filterable and paginated with take/skip.
list_subscriptions
ChatGPTList subscriptions with filters for activation_strategy, status, currency, plan_id, original_quote_id, integration_entity_id, customer_id, invoicing_entity_id, purchase_order, updated_at, custom_properties. Draft, voided, and cancelled excluded by default. Paginated with take/skip.
list_tax_rates
ChatGPTList custom tax rates with optional filters for id, name, description, and invoicing_entity_id. Paginated with take/skip.
list_transactions
ChatGPTList transactions across all invoices, including transactions without an invoice allocation. Paginated with take/skip.
list_wallet_transactions
ChatGPTList all transactions (loads, usages, refunds) for a wallet. Paginated with take/skip.
list_wallets
ChatGPTList wallets with optional customer_id filter. Wallets hold prepaid credit balances that are drawn down during invoicing. Paginated with take/skip.
list_webhook_endpoints
ChatGPTList all webhook endpoints configured on the account. Endpoints receive event notifications via HTTP POST.
list_webhook_messages
ChatGPTList webhook messages sent across all endpoints. Filterable by event_types, before/after dates. Payloads are expunged after 90 days. Uses cursor-based pagination.
load_wallet
ChatGPTAdd credits to a wallet by charging the customer's payment method. The customer must have an active payment method.
mark_invoice_as_uncollectible
ChatGPTMark an invoice as uncollectible for accounting write-off purposes. The invoice remains in the system for record keeping.
mark_spend_transaction_internal
ChatGPTFlag a transaction as an internal transfer between the client's own accounts (e.g. a top-up of a Mercury account). This removes it from the payments list, bank views and cashflow actuals. For an outgoing transaction it also dismisses any suggested charge and learns the counterparty (its merchant key) so future transfers to the same account are auto-hidden on ingestion; with apply_to_similar, the flag is extended to the other charge-less transactions sharing the merchant key in the 90-day window. An inflow (the incoming leg) is flagged only. applied_count reports the extra rows flagged (always 0 for inflows).
mark_spend_transaction_payroll
ChatGPTClassify an outgoing transaction as payroll (a salary batch, an URSSAF or tax-withholding debit, the payroll provider's direct debit). The transaction stays a real cash movement — the cashflow page and bank views are unchanged — but it leaves the payments list and the P&L expense rows, where the payroll journal (or, with no payroll integration connected, the classified cash itself) reports the cost. Its merchant key is learned so future payments to the same counterparty are classified on ingestion; with apply_to_similar the classification is extended to the other transactions sharing that key in the 90-day window. applied_count reports the extra rows classified.
match_spend_transaction
ChatGPTManually match an outgoing transaction to a supplier — an existing one (supplier_id) or one created on the fly (new_supplier, deduped by name) — with an optional contract. Replaces any previous attribution on the transaction and teaches the matcher: the merchant key is learned on the new supplier and removed from the old one. With apply_to_similar, the same confirmed supplier is applied to the other unmatched transactions sharing the merchant key in the 90-day window. similar_transaction_ids (a validated selection from /similar) takes precedence: the server re-validates each id and applies the same attribution with REPLACE semantics, re-pointing even transactions that already carry a wrong charge. applied_count reports the rows written.
merge_spend_supplier
ChatGPTMerge the supplier into target_supplier_id (dedupe): its contracts, charges, learned matching patterns and bank account numbers move to the target, the target's empty website/legal name/category/notes are backfilled from it, and it is soft-deleted. Returns the merged target supplier.
patch_organisation
ChatGPTUpdate an existing organisation's details by ID.
pause_subscription
ChatGPTPause a subscription. Billing stops while paused. Optionally specify a reactivate_at date for automatic resumption.
ping
ChatGPTCheck if the hyperline MCP server is running
preview_data_loader_query
ChatGPTRun a query against the connection's warehouse and return the first rows.
preview_manual_journal_entry_recognition
ChatGPTPreview revenue-recognition slices for a manual journal entry without writing data.
preview_reshape_rev_rec_schedule
ChatGPTPreview the exact reshape plan without writing data.
publish_catalog_draft
ChatGPTPublish the pending product catalog draft: its changes become the live catalog.
purchase_customer_credits
ChatGPTPurchase credits for a customer. This generates an invoice and charges the customer. Returns the invoice ID and new balance.
reactivate_subscription
ChatGPTResume a paused subscription, restarting billing from the current date.
redraft_quote
ChatGPTSwitch a quote back to draft so its subscription or invoice configuration can be updated. Works on quotes pending approval, with changes requested, approved, or awaiting signature. Cancels pending approval requests and the signature request; the quote must then be finalized again.
refresh_subscription_seat_products
ChatGPTTrigger a count update on seat-based products within a subscription using the configured dataloader query.
refund_transaction
ChatGPTRefund a settled banking transaction for its full amount. The related invoice will switch back to to pay status. Use the create credit note endpoint if you want to cancel (and optionally refund) the initial invoice.
reinstate_subscription
ChatGPTReinstate a subscription that is scheduled for cancellation, reverting it to active status.
renew_subscription
ChatGPTFast-forward a subscription to a specific date, generating all intermediate invoices. Useful for pre-billing. Activates pending subscriptions. Max 36 renewals.
reopen_ledger_period
ChatGPTReopen a closed month of a ledger and every later month, with a mandatory reason; a user token needs the accounting_close permission.
reorder_spend_categories
ChatGPTSet the render order of the client's categories — the order the settings editor lists them in and the P&L prints its expense rows in. Categories omitted from category_ids keep their relative order after the listed ones.
replace_agent_cost_catalog_item
ChatGPTReplace a custom item's provider, item and dimensions, preserving historical prices and returning the new active custom_item_id.
replace_agent_plan
ChatGPTReplace an AI agent billing plan (whole-row semantics). Changes take effect on the next call for every customer on the plan; mode is immutable. Overage is priced by overage_markup_percent or by overage_rate_card_id, never both.
replace_agent_rate_card
ChatGPTReplace an AI rate card's rows, name and USD fallback (whole-card semantics). Denomination and currency are immutable.
reset_agent_customer_windows
ChatGPTReset one customer's open AI allowance windows so their next call starts a fresh full allowance. Windows-mode scopes only.
reshape_rev_rec_schedule
ChatGPTRecognize an amount now and optionally spread the remainder over a new window.
resolve_accounting_rule
ChatGPTPreview which account codes would be resolved for a given context.
resolve_customer_features
ChatGPTResolve feature values for a customer.
revert_wallet_load
ChatGPTRevert a wallet credit transaction: voids the related credit note and creates a debit transaction to undo the load.
run_spend_matching
ChatGPTEnqueue an asynchronous auto-matching pass over all of the client's recent outgoing transactions.
run_spend_payroll_periods_pull
ChatGPTEnqueue an asynchronous pull of the current and previous payroll month from the connected payroll provider. Returns the number of connections enqueued.
run_spend_payroll_sync
ChatGPTEnqueue a full 12-month payroll re-import from the connected payroll provider, ending with a collaborator import and department tagging. This is the manual counterpart of the backfill the connect flow runs — use it to pull historical months after connecting, or after fixing the API key's scopes. Returns the number of connections enqueued.
run_spend_provider_transactions_pull
ChatGPTEnqueue an asynchronous pull of the client's accounting-provider (Pennylane) bank transactions, matched to internal transactions to surface provider categorization and receipts. Returns the number of provider connections enqueued.
send_invoice_emails
ChatGPTSend a specific email (email_type, e.g. invoice_ready for the to-pay email) to the customer for a list of invoice IDs, asynchronously in batch. Returns a batch_id only; outcomes arrive via webhooks (invoice.batch.email_succeeded / invoice.batch.email_skipped / invoice.batch.email_failed). An invoice whose status doesn't match the email (e.g. a draft or an invoice still pending approval after validate_invoice) is skipped, so check each invoice's status with get_invoice first. Every call sends the emails again: never re-call it to retry or check status.
send_quote
ChatGPTSend a quote by email for customer signature. Requires the quote to be approved first.
set_agent_default_plan
ChatGPTMark one plan as the workspace's default AI agent billing plan (body: plan_id, optional auto_apply). Replaces the previous marker; 404 when the plan is not this workspace's.
set_customer_feature
ChatGPTSet a feature override for a customer.
set_customer_shipping_destination
ChatGPTSelect a saved shipping address or use the billing address.
set_product_ai_rate_card
ChatGPTAttach a credits-denominated AI rate card with complete fallback pricing as the credit product's default.
set_product_feature
ChatGPTSet a feature value for a product.
set_quote_signers
ChatGPTReplace the full list of signers of a quote. Signers with the same step_order sign in parallel; steps sign in ascending order. Requires at least one external signer, and a countersigner must sign after an external step. Set signers before calling send_quote, which then emails the signers of the first step and no longer needs email. Pass an empty list to go back to the single-signer flow.
set_spend_charge_accounting_category
ChatGPTSet (or clear with null) the accounting-software category assigned to a payment: the provider's category id plus its display label. Local-only — never written back to the accounting provider.
set_spend_charge_category
ChatGPTSet (or clear with null) a payment's per-charge category override, which takes precedence over the supplier/contract category.
set_spend_charge_pnl_flags
ChatGPTFlag a payment for the P&L. excluded_from_pnl drops it out of the P&L expense rows entirely (a provision, an exceptional item) — the payment stays matched and confirmed, and its cash is still reported in the statement's reconciliation block. is_one_off keeps it in the P&L but moves it to the dedicated one-off OpEx row whatever its category, and never smooths it. An omitted field is left untouched.
set_spend_payroll_collaborator_department
ChatGPTTag one collaborator's department by hand. The tag is stored as manual and is never overwritten by the automatic job-title classification. Sending null clears the tag: the collaborator goes back to untagged and becomes eligible for automatic tagging again.
set_spend_supplier_recurring
ChatGPTON derives a recurring charge stream from the supplier's uncontracted confirmed charges (detected cadence + median amount; falls back to a monthly stream on the last charge when the history is too thin) and marks it manual so detection never overwrites it. OFF clears the stream and remembers the dismissal so detection never re-suggests it. The stream feeds the cashflow outflow projections and the committed run-rate.
sign_quote
ChatGPTManually mark a quote as signed externally. Optionally upload a signed PDF. Bypasses the built-in Hyperline signature flow.
simulate_create_invoice
ChatGPTValidate a create_invoice payload without persisting anything: the invoice is created through the exact same validation and pricing path inside a rolled-back transaction, then returned with its computed amounts. No events, webhooks, or jobs are emitted. Call this to check a payload before create_invoice; the input schema is identical.
simulate_create_quote
ChatGPTValidate a create_quote payload without persisting anything: the quote (and its draft subscription or invoice) is created through the exact same validation path inside a rolled-back transaction, then returned. No events, webhooks, or jobs are emitted, and file attachments are not supported here. Call this to check a payload before create_quote; the input schema is identical.
simulate_create_subscription
ChatGPTValidate a create_subscription payload without persisting anything: the subscription is created through the exact same validation and pricing path inside a rolled-back transaction, then returned. No events, webhooks, or jobs are emitted. Call this to check a payload before create_subscription; the input schema is identical.
simulate_subscription_updates
ChatGPTPreview the effect of updates on a subscription without applying them. Returns simulated invoice and billing impact.
topup_customer_credits
ChatGPTAdd free credits to a customer's balance. Unlike purchase, this does not generate an invoice or charge the customer.
transition_subscription
ChatGPTTransition a subscription to its next configured phase at a specified date.
unarchive_customer
ChatGPTRestore a previously archived customer by ID, making it visible again in default list views.
unarchive_feature
ChatGPTUnarchive a feature definition.
unarchive_product
ChatGPTRestore a previously archived product, making it available for new subscriptions again.
unmark_spend_transaction_internal
ChatGPTReverse an internal marking: un-flag the transaction so it reappears in the payments list, and forget its learned internal counterparty so matching transfers stop being auto-hidden.
unmark_spend_transaction_payroll
ChatGPTReverse a payroll classification: the transaction reappears in the payments list and in the P&L expense rows, and its counterparty is forgotten — which also switches off the built-in payroll detection for that counterparty, so the transaction is not re-classified on the next matching pass.
update_accounting_rule
ChatGPTUpdate an existing accounting rule, with the filters, accounts and required fields the rule editor applies to its category.
update_aggregator
ChatGPTUpdate an existing aggregator's configuration.
update_contract_clause
ChatGPTUpdate the name, text, translations or invoicing entities of a contract clause. Sending translations replaces all existing translations.
update_contract_document
ChatGPTUpdate the name or invoicing entities of a contract document. Its files are updated per content with update_contract_document_content.
update_contract_document_content
ChatGPTUpdate a contract document content. Sent files replace all its existing files: use it to publish a new version of a document. Existing quotes keep their copy of the previous files.
update_coupon
ChatGPTUpdate an existing coupon's name, discount rules, or restrictions.
update_credit_note_allocations
ChatGPTReplace a credit note's invoice allocations, including imported invoices, without changing its original invoice reference.
update_custom_property
ChatGPTUpdate an existing custom property definition by ID.
update_customer
ChatGPTUpdate a customer's details including name, billing email, address, currency, tax ID, and custom properties.
update_customer_address
ChatGPTUpdate a billing or shipping address by ID; billing changes also update the customer billing-address projection.
update_customer_credit
ChatGPTUpdate the configuration of a customer's credit product (e.g. balance thresholds, auto-topup settings).
update_customers_segment
ChatGPTUpdate an existing customer segment.
update_data_loader_query
ChatGPTUpdate a data loader query after verifying it against the warehouse.
update_feature
ChatGPTUpdate a feature definition.
update_invoice
ChatGPTUpdate a draft or grace_period invoice. Allows modifying line items, dates, and metadata before finalization.
update_invoicing_entity
ChatGPTUpdate an existing invoicing entity's details (address, tax ID, branding, etc.).
update_ledger
ChatGPTUpdate an existing accounting ledger.
update_ledger_account
ChatGPTUpdate an existing ledger account.
update_prices
ChatGPTUpdate the prices of an existing price configuration by ID. Allows changing tier thresholds, unit prices, and flat fees.
update_product
ChatGPTUpdate a product's name, description, type, or configuration by ID.
update_promotion_code
ChatGPTUpdate an existing promotion code's configuration (excluding the linked coupon).
update_quote
ChatGPTUpdate quote-level fields before a quote is finalized. On draft quotes, pass subscription to create or replace the draft subscription configuration, or pass invoice on a one-off quote to replace the linked draft invoice.
update_spend_category
ChatGPTRename a category, move it to another P&L section, or restore it from the archive with archived: false. Applies to platform categories exactly as it does to custom ones. Sending label: null clears the name so the category falls back to its translated key. The key is immutable.
update_spend_contract
ChatGPTUpdate a supplier contract by id. Derived period/deadline dates are recomputed when term fields change.
update_spend_settings
ChatGPTSet the module-wide spend settings. Full replace: send every field. Growth rates are monthly compounding percents (null = flat) and the outflow one only compounds contracts without their own renewal escalator. P&L sections are no longer set here — they live on each spend category. cac_payroll_allocation_percent is the share of payroll (0-100) counted as sales & marketing spend in the P&L's CAC block.
update_spend_supplier
ChatGPTUpdate a supplier by id.
update_subscription
ChatGPTComprehensive subscription update: modify fields, manage phases (add/update/delete pending phases), update products within phases, and manage coupons. Draft quote subscription configuration must be updated through PATCH /v1/quotes/{id}.
update_wallet
ChatGPTUpdate a wallet's configuration (e.g. name, auto-topup settings).
update_wallet_settings
ChatGPTUpdate global wallet settings for the account.
update_webhook_endpoint
ChatGPTUpdate a webhook endpoint's URL, subscribed events, or enabled status.
upload_pdf_to_invoice
ChatGPTUpload a custom PDF file (max 5MB) to attach to an existing invoice, replacing the auto-generated PDF.
upsert_agent_cost_catalog_override
ChatGPTSet this workspace's negotiated price for a registry AI model (input/output/cached/cache-write USD per 1M tokens, plus optional dimensions). Replaces any open override immediately; historical calls keep their original rate. A pair the registry does not know is refused — create a custom cost item instead.
upsert_agent_customer_billing_policy
ChatGPTReplace customer billing settings while preserving omitted plan_id and rate_card_id references; null detaches them, and a shared policy enables automatic telemetry billing.
upsert_default_customer_billing_policy
ChatGPTReplace customer billing settings while preserving omitted plan_id and rate_card_id references; null detaches them, and a shared policy enables automatic telemetry billing.
validate_invoice
ChatGPTFinalize a draft invoice: sets its status to to_pay, assigns an invoice number, and makes it immutable. This action is irreversible.
void_invoice
ChatGPTVoid an invoice in to_pay status. Automatically generates a corresponding credit note. Optionally send an email notification.
void_quote
ChatGPTVoid an existing quote, canceling it and preventing further actions.