@argantom/argantom
    Preparing search index...

    Interface Record

    An accounting record.

    interface Record {
        date: StrDate;
        durationSecs?: number;
        expense?: Val;
        fee?: Val;
        income?: Val;
        metadata?: any;
        occurredAt?: string;
        quantity?: number;
        recordId: string;
        unitPrice?: Val;
    }
    Index

    Properties

    date durationSecs? expense? fee? income? metadata? occurredAt? quantity? recordId unitPrice?

    Properties

    date: StrDate

    The date for this record.

    durationSecs?: number

    An f64 representation of time spent performing an activity.

    This value is in seconds, but generally a UI should clamp this to a larger value, such as quarter hours.

    A UI can choose to record this as a part of an income or expense record, or as a separate record, leaving income and expense undefined.

    expense?: Val

    Any expenses associated with this record.

    fee?: Val

    Any transaction fee associated with this record.

    This can be positive (a fee) or negative (a maker rebate, which shows up as a negative fee in the API).

    income?: Val

    Any income associated with this record.

    metadata?: any

    Any free-form metadata associated with this record.

    occurredAt?: string

    The exact occurrence timestamp (as an ISO string) for this record.

    This is useful for cost basis calculations when there are multiple sequential fills on a single order at different millisecond / price points.

    quantity?: number

    The number of contracts purchased / sold / redeemed for this record.

    recordId: string

    The identifier for this record. Set this to empty string ("") when creating a new record.

    unitPrice?: Val

    The per-contract price, used together with quantity to derive the total transaction cost.

    Settings

    Member Visibility

    On This Page

    Properties