Sign in
contracts

Link Contract Document

Adopt a document the tenant already has as one of this contract's.

The inverse of DELETE /contracts/{id}/documents/{file_id}/link, and JSON rather than the multipart of its upload twin above because there are no bytes to send.

post/contracts/{contract_id}/documents/link

Path parameters

contract_idstring uuid required

Request body

file_idstring uuid required
role'base' | 'amendment' | 'addendum' | 'sow' | 'order_form' | 'exhibit' required

How a file relates to its parent Contract.

BASE is the root/master document (at most one per contract). All other roles hang off the agreement via parent_file_id.

parent_file_idstring uuid nullable

Response

Successful Response

contract_idstring uuid required
company_idstring uuid required
vendor_idstring uuid nullable
titlestring required
status'draft' | 'active' | 'expired' | 'terminated' required

DRAFT and TERMINATED are human judgments; the derivation in recompute_contract_status overwrites neither.

effective_datestring date nullable
expiration_datestring date nullable
auto_renewsboolean nullable
obligationsstring[]
latest_extraction_run_idstring uuid nullable
latest_summary_run_idstring uuid nullable
summary_run_status'pending' | 'running' | 'completed' | 'failed'
base_file_idstring uuid nullable
base_filenamestring nullable
base_upload_idstring uuid nullable
createdstring date-time nullable
modifiedstring date-time nullable

Changes

Changed in 1 of the 8 revisions of this API.1