Tabs

Get a single item by its unique ID

items_get

Get information about the specified merchant

merchants_info_get

Get a single payment by its ID, requires customer and invoice IDs

payments_get

Get performance obligations for a specific contract

contracts_performance_obligations_get

Get a single product by its unique ID

products_get

List billing terms — the billing lines on contracts that define what gets invoiced, how much, and how often. Filter by contract, customer, billing term group, product, or billing dates. For seat-based terms, `currentSeatCount` is the number of seats effective today (seat amendments applied); it is null for non-seat-based terms.

billing_terms_list

List usage commitments — agreements that a customer will use a set amount of a product/service over a period, tracking usage against the commitment with overages and true-ups. Filter by customer or contract.

commitments_list

List contracts with optional filtering by name, external ID, source, status, customer, or last updated date.

contracts_list

List credit memos with optional filtering by number, customer, issue date range, status, or ERP sync status. For incremental export use lastUpdatedAt with an ISO 8601 timestamp, e.g. lastUpdatedAt:gte:2026-01-01.

credit_memos_list

List contacts for a specific customer

customers_contacts_list

List customers with optional filtering by name, external ID, or last updated date.

customers_list

List invoices with optional filtering by customer, contract, status, dates, and more.

invoices_list

List items — catalog entities mapped to the merchant's accounting/ERP system (e.g. QuickBooks, NetSuite) for GL mapping, identified by external IDs. Filter by name, external ID, or external ID type.

items_list

List journal entries — the individual accounting records behind billing and revenue recognition. Each entry traces back to its source (invoice, credit memo, or revenue schedule) and to a customer and contract. Filter by journalDate range for period analyses (e.g. flux/month-over-month comparisons). externalId is set once an entry has been pushed to the merchant's ERP (use externalId:isnotnull).

journal_entries_list

List all merchants the authenticated user has access to. Call this first to discover available merchant IDs.

list_merchants

List obligations — billing terms with their service period and recognition category. Filter by contract, customer, billing dates (startDate/endDate), or service dates. For per-month recognized revenue use contracts_performance_obligations_get (single contract) or revenue_list (portfolio rollup). Note: contracts with many-to-many billing-term-to-obligation relationships are excluded from results.

obligations_list

List payments with optional filtering by received date, status, type, invoice, or customer.

payments_list

List product catalog entries — the merchant's central list of what they sell (internal name, customer-facing display name, active/inactive status). Catalog definitions only; pricing and billing live on contracts/billing terms. Filter by name or status.

products_list

List renewals with optional filtering by contract, type, status, or contract end date

renewals_list

List recognized, deferred, and unbilled revenue per customer per month. Set startMonth and endMonth to the months you need — one row per customer per month in range; omitting them defaults to the whole current calendar year. Months are YYYY-MM, e.g. startMonth:gte:2026-01. Currency is an ISO 4217 code (e.g. USD).

revenue_list