Contracts

A Contract in Tabs represents a document that helps define the billing arrangement with your customer. It typically outlines billing terms, obligations, and other relevant details that guide your revenue operations. By centralizing Contracts in Tabs, you can easily track contract status, link them to specific customers, and maintain a clear audit trail.

Any time you have an amendment to a billing relationship with a customer, you should create a new contract to represent the amendment.

Files

With most contracts, you will want to push or pull the associated document/file. We have separated that endpoint from the initial creation of the file. First, you create the metadata in our system, and separately, you send the file for upload. When pulling the file, you can use the contractId to grab the associated file.

Contract Object

Field	Type	Description	Required
id	`string`	Unique identifier for the contract.	Yes
fileName	`string`	The name of the contract file (e.g., a PDF or Docx).	Yes
name	`string`	Display name for this contract (visible in the UI).	Yes
status	`string`	Current status of the contract (e.g., `ACTIVE`, `DRAFT`, `EXPIRED`).	Yes
customerId	`string`	Identifier of the customer associated with this contract.	Yes
customerName	`string`	(Optional) Name of the associated customer.	No
uploaderId	`string`	(Optional) Identifier of the user who uploaded the contract.	No
createdAt	`Date`	(Optional) Timestamp when the contract was created.	No
lastUpdatedAt	`Date`	(Optional) Timestamp when the contract was last updated.	No
deletedAt	`Date`	(Optional) Timestamp when the contract was deleted (if applicable).	No

ExternalId Object

You may also reference an ExternalIdDto if you need to link contracts to third-party systems.

Field	Type	Description	Required
externalId	`string`	The external identifier (e.g., ID from a CRM or ERP).	Yes
sourceType	`enum`	Source type for the external ID (e.g., `Salesforce`, `NetSuite`).	Yes
metadata	`object`	Additional metadata or context related to the external ID.	No