Search
K
Illustration

Scheduled Entry

object

Represents a limited time period for which a value is constant.

fromintegerrequired

starting point for the value, inclusive

>= 1

throughintegerrequired

ending point for the value, inclusive

>= 1

valuestringrequired
Example

Schedule

object

Represents a value that changes with time. The value is assumed to change annually and be tied to a duration unless otherwise specified via the Frequency and Basis properties

frequencystring

Indicates the interval between values for each entry. Any entry other than Annual results in multiple activities within a year.

Allowed values:ANNUALSEMI_ANNUALQUARTERLYMONTHLYBIWEEKLYWEEKLYDAILY

basisstring

Specifies how to interpret the from and through properties for each entry.

Allowed values:AGEDURATION

sequencearray[object]required

Represents a limited time period for which a value is constant.

>= 1 items

Show Child Parameters
Example

Variable Value

the value of a variable, may be constant or time-dependent

One Of

Arrangement

object

Describes an arbitrary agreement

arrangementSourcesarray[object]

A source of funding for an arrangement

Show Child Parameters
typestring

Enumeration of allowable arrangement types

Allowed values:LOANWITHDRAWALPAYMENTCONVERSION_ACTIVATION

attributesobject

A collection of uniquely named variables, must be camel-cased.

Show Child Parameters
requestedAmountOne Of

the value of a variable, may be constant or time-dependent

Variant 1string
deathClaimobject

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
feesarray[object]

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
loanSegmentsarray[object]

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
matchSegmentobject

A segment of a source of money that has some form of financial activity

Show Child Parameters
paymentsarray[object]

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
taxWithholdingsarray[object]

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
Example

Arrangements

array

An unkeyed collection of arrangement objects

arrangementSourcesarray[object]

A source of funding for an arrangement

Show Child Parameters
typestring

Enumeration of allowable arrangement types

Allowed values:LOANWITHDRAWALPAYMENTCONVERSION_ACTIVATION

attributesobject

A collection of uniquely named variables, must be camel-cased.

Show Child Parameters
requestedAmountOne Of

the value of a variable, may be constant or time-dependent

Variant 1string
deathClaimobject

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
feesarray[object]

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
loanSegmentsarray[object]

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
matchSegmentobject

A segment of a source of money that has some form of financial activity

Show Child Parameters
paymentsarray[object]

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
taxWithholdingsarray[object]

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters