Interface SimpleContract

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

interface SimpleContract {
    avatar?: null | AvatarSize[];
    contract_id?: null | string;
    contract_owner?: AccountUserPersona;
    created_at?: string;
    description?: null | string;
    end_date?: null | string;
    has_private_avatar_image?: boolean;
    header?: ContractHeader;
    id?: null | string;
    incomes?: null | Income[];
    is_active?: boolean;
    last_payment_date?: null | string;
    object?: null | string;
    other_collaborators?: null | AccountUserPersona[];
    partition_key?: null | string;
    private_avatar_image?: null | string;
    recoupables?: null | RecoupableTerm[];
    short_id?: null | string;
    split_tiers?: TieredSplitTieredGroupTerm;
    start_date?: string;
    tags?: null | string[];
    title?: null | string;
}

Properties

avatar? contract_id? contract_owner? created_at? description? end_date? has_private_avatar_image? header? id? incomes? is_active? last_payment_date? object? other_collaborators? partition_key? private_avatar_image? recoupables? short_id? split_tiers? start_date? tags? title?

Properties

Optionalavatar

avatar?: null | AvatarSize[]

contract avatar

Optionalcontract_id

contract_id?: null | string

Shared id of the contract for when multiple revisions may exist

Optionalcontract_owner

contract_owner?: AccountUserPersona

Optionalcreated_at

created_at?: string

Optionaldescription

description?: null | string

Description

Optionalend_date

end_date?: null | string

End date of the contract.

Optionalhas_private_avatar_image

has_private_avatar_image?: boolean

avatar image of contract

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

Optionallast_payment_date

last_payment_date?: null | string

Last Payment date.

Optionalobject

object?: null | string

The name of this object

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

Optionalprivate_avatar_image

private_avatar_image?: null | string

avatar image of contract

Optionalrecoupables

recoupables?: null | RecoupableTerm[]

Recoupables

Optionalshort_id

short_id?: null | string

Optionalsplit_tiers

split_tiers?: TieredSplitTieredGroupTerm

Optionalstart_date

start_date?: string

Start date of the contract

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