Interface Contract

export Contract

interface Contract {
    activated_at?: null | string;
    activated_by?: AccountUserPersona;
    batch_runs?: null | BatchRun[];
    bulk_id?: null | string;
    contract_id?: null | string;
    contract_owner?: AccountUserPersona;
    description?: null | string;
    end_date?: null | string;
    header?: ContractHeader;
    id?: null | string;
    incomes?: null | Income[];
    is_active?: boolean;
    is_derived?: boolean;
    last_payment_date?: null | string;
    start_date?: string;
    title?: null | string;
}

Properties

activated_at? activated_by? batch_runs? bulk_id? contract_id? contract_owner? description? end_date? header? id? incomes? is_active? is_derived? last_payment_date? start_date? title?

Properties

Optionalactivated_at

activated_at?: null | string

The date and time the Contract was most recently activated

Optionalactivated_by

activated_by?: AccountUserPersona

Optionalbatch_runs

batch_runs?: null | BatchRun[]

Optionalbulk_id

bulk_id?: null | string

Optionalcontract_id

contract_id?: null | string

Shared id of the contract for when multiple revisions may exist

Optionalcontract_owner

contract_owner?: AccountUserPersona

Optionaldescription

description?: null | string

Description

Optionalend_date

end_date?: null | string

End date of the 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

True if this Contract is active; otherwise false. Contracts must be active in order to process funds

Optionalis_derived

is_derived?: boolean

True if this Contract is derived from another one, otherwise false

Optionallast_payment_date

last_payment_date?: null | string

Last Payment date.

Optionalstart_date

start_date?: string

Start date of the contract

Optionaltitle

title?: null | string

Display title

Settings

Member Visibility

On This Page

Properties