Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.
API Key · Connector Profile
Uses a Tabs API key sent as-is in the Authorization header. Each key is scoped to a single Tabs entity and stays valid u…
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
API Key · Link Account
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
63 actions
Action
Description
List Billing Terms
Retrieve a paginated list of billing terms from Tabs
List Customer Contacts
Retrieve a paginated list of customer contacts from Tabs
Create Customer Contacts
Create customer contacts in Tabs
Update Customer Contact
Update customer contact in Tabs
List Contracts
Retrieve a paginated list of contracts from Tabs
Create Contract
Create a new contract for an existing Tabs customer, with an optional close date and external CRM ID
List Deleted Contracts
Retrieve a paginated list of deleted contracts from Tabs
Get Contract By ID
Get contract by ID from Tabs
Update Contract
Update a contract’s name, close date, external ID or external source type
Download Contract File
Download contract file from Tabs
Upload Contract File
Upload contract file in Tabs
Delete Contract File
Delete contract file from Tabs
Get Contract Obligation By ID
Get contract obligation by ID from Tabs
Perform Contract Action
Perform contract action in Tabs
Upsert Obligation Custom Revenue
Upsert obligation custom revenue in Tabs
List Contract Billing Terms
Retrieve a paginated list of contract billing terms from Tabs
Create Contract Billing Term
Create contract billing term in Tabs
Update Contract Billing Term
Update contract billing term in Tabs
Create Commitments For A Contract
Create commitments for a contract in Tabs
Create Contract From File
Uploads a contract PDF and creates a new contract for it in one call
Create Contract Obligation
Returns 202 once the change is saved
Delete Contract Billing Term
Returns 202 once the change is saved
Delete Contract Metadata
Delete contract metadata from Tabs
Get Contract Metadata
Get contract metadata from Tabs
Update Contract Metadata
Updates a contract’s metadata by merging the provided top-level keys with the existing metadata
Delete Contract Obligation
Returns 202 once the change is saved
Terminate Billing Term
Terminates a billing term as of the given end date
Update Contract Obligation
Returns 202 once the change is saved
Get Credit Memo By ID
Get credit memo by ID from Tabs
List Credit Memos
Retrieve a paginated list of credit memos from Tabs
Create Credit Memo
Create credit memo in Tabs
Apply Credit Memo
Apply credit memo in Tabs
Get Customer By ID
Get customer by ID from Tabs
Delete Customer
Delete customer from Tabs
List Customers
Retrieve a paginated list of customers from Tabs
Create Customer
Create a new customer in Tabs with billing contact, addresses, default currency, custom fields and tax details
Update Customer Names
Update customer names in Tabs
List Event Types
Retrieve a paginated list of event types from Tabs
Create Event Type
Create an event type in Tabs
Create An Event
Creates a new usage event
Get All Events
Fetches all usage events, and can be filtered as needed
Delete An Event
Deletes a usage event by creating a new deletion event that links back to the original event
Get Customer Invoice By ID
Get customer invoice by ID from Tabs
Get Invoice Generation Status
Check whether invoices are still generating for a customer
Download Invoice PDF
Download invoice PDF from Tabs
Perform Invoice Action
Performs an action on an invoice
Get Invoice Payment By ID
Get invoice payment by ID from Tabs
Create Invoice Payment
Create invoice payment in Tabs
List Invoices
Retrieve a paginated list of invoices from Tabs
Get Job By ID
Check the status of an asynchronous Tabs job, such as an invoice send or void started by perform_invoice_action
Get Merchant Info
Retrieve the Tabs merchant (entity) that the API key is scoped to
List Obligations
Retrieve a paginated list of obligations from Tabs
List Payments
Retrieve a paginated list of payments from Tabs
Get A Product By ID
Get a product by ID from Tabs
Update A Product
Update a product’s name, display name, status, ARR default, description or linked ERP item and class
List All Products For Merchant
Retrieve a paginated list of all products for merchant from Tabs
Create A New Product
Create a new product in Tabs
List Renewals
Retrieve a paginated list of renewals from Tabs
Create A Renewal For A Contract
Creates a
DRAFT renewal for a processed contract. All terms are optional. A contract can have at most one renewalExecute A Renewal
Starts executing the renewal asynchronously: the excluded billing terms are removed from the draft renewal contract, the…
Get A Renewal
Retrieve a single contract renewal with its terms, notice period, length and price increase settings
Get ARR Report
Retrieve the annual recurring revenue (ARR) report, paginated and filterable by customer and period
List Revenue
Cursor-paginated customer × month revenue rows