Interface SimpleContract

The SimpleContract is a simplified version of the advanced Contract export SimpleContract

interface SimpleContract {
    contract_id?: null | string;
    created_at?: string;
    description?: null | string;
    header?: ContractHeader;
    id?: null | string;
    incomes?: null | Income[];
    is_active?: boolean;
    other_collaborators?: null | AccountUserPersona[];
    partition_key?: null | string;
    recoupables?: null | RecoupableTerm[];
    short_id?: null | string;
    split_tiers?: TieredSplitTieredGroupTerm;
    tags?: null | string[];
    title?: null | string;
}

Properties

contract_id? created_at? description? header? id? incomes? is_active? other_collaborators? partition_key? recoupables? short_id? split_tiers? tags? title?

Properties

Optionalcontract_id

contract_id?: null | string

Shared id of the contract for when multiple revisions may exist

Optionalcreated_at

created_at?: string

Optionaldescription

description?: null | string

Description

Optionalheader

header?: ContractHeader

Optionalid

id?: null | string

Unique Id and primary key of this Contract

Optionalincomes

incomes?: null | Income[]

One ore more Income terms which help provide scope on how funds flow through the Contract

Optionalis_active

is_active?: boolean

Optionalother_collaborators

other_collaborators?: null | AccountUserPersona[]

A list of collaborators who are not recieving splits but are a part of the Contract

Optionalpartition_key

partition_key?: null | string

Optionalrecoupables

recoupables?: null | RecoupableTerm[]

Recoupables

Optionalshort_id

short_id?: null | string

Optionalsplit_tiers

split_tiers?: TieredSplitTieredGroupTerm

Optionaltags

tags?: null | string[]

Tags to help set and identify the type of SimpleContract

Optionaltitle

title?: null | string

Display title

Settings

Member Visibility

On This Page

Properties