# Activity
Activity is a representation of several ledger entries rolled up for easy correlation and usage
## Example Usage
```typescript
import { Activity } from "@apexfintechsolutions/ascend-sdk/models/components";
let value: Activity = {};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `acatsPendingOut` | [components.ActivityAcatsPendingOut](../../models/components/activityacatspendingout.md) | :heavy_minus_sign: | Used to record the movement of funds or shares to/ from the pending_acats memo location | |
| `accountId` | *string* | :heavy_minus_sign: | A globally unique identifier referencing a single account; this is the main identifier for an account used for machine-to-machine interactions | 01HBRQ5BW6ZAY4BNWP4GWRD80X |
| `accountMemo` | [components.ActivityAccountMemo](../../models/components/activityaccountmemo.md) | :heavy_minus_sign: | Indicates the memo location impacted by an entry | FREE |
| `accountTransfer` | [components.ActivityAccountTransfer](../../models/components/activityaccounttransfer.md) | :heavy_minus_sign: | Used to record the movement of funds or shares during the bookkeeping phase of an account transfer and details related to the account transfer | |
| `accruedInterest` | [components.AccruedInterest](../../models/components/accruedinterest.md)[] | :heavy_minus_sign: | Any accrued interest that has been earned but not yet paid between the last interest payment and the date of the activity | |
| `accruedInterestDesc` | [components.AccruedInterestDesc](../../models/components/accruedinterestdesc.md) | :heavy_minus_sign: | Used to record the amount of interest that has been earned but not yet paid between the last interest payment and the date of the trade | |
| `activityDate` | [components.ActivityActivityDate](../../models/components/activityactivitydate.md) | :heavy_minus_sign: | The activity date refers to the specific calendar day on which a financial transaction, such as a trade at an exchange or a deposit at a bank, was executed. This date is specific to the institution where the transaction took place, capturing the exact day on which the institution formally records and effects the transaction | {
"day": 14,
"month": 5,
"year": 2024
} |
| `activityDescription` | *string* | :heavy_minus_sign: | The description for an activity. This may include special instructions, symbol description, etc when relavant | SOFI TECHNOLOGIES INC COM |
| `activityId` | *string* | :heavy_minus_sign: | Apex-generated unique activity identifier | 01YPBW4QX6R |
| `activityTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Activity time refers to the precise moment, recorded in Coordinated Universal Time (UTC), when a financial transaction is executed as reported to Apex | 2023-12-22T05:00:00Z |
| `allocation` | [components.ActivityAllocation](../../models/components/activityallocation.md) | :heavy_minus_sign: | Object containing metadata for trade allocation | |
| `assetDescription` | *string* | :heavy_minus_sign: | Name of the issuer of a security and additional descriptive information about the particular issue | INTERNATIONAL BUSINESS MACHS COM |
| `assetId` | *string* | :heavy_minus_sign: | An Apex-provided, global identifier created on a per asset bases which provides connectivity across all areas Not populated on a currency only movement | 1000 |
| `bondDefault` | [components.ActivityBondDefault](../../models/components/activitybonddefault.md) | :heavy_minus_sign: | Object containing metadata for bond defaults | |
| `capitalGains` | [components.ActivityCapitalGains](../../models/components/activitycapitalgains.md) | :heavy_minus_sign: | Used to record a distribution of cash that an issuer has determined will be declared as income financed from capital gains and not ordinary income and details related to the capital gain | |
| `cashDividend` | [components.ActivityCashDividend](../../models/components/activitycashdividend.md) | :heavy_minus_sign: | Used to record the distribution of cash to shareholders, paid by the issuer, usually based upon current earnings and/or accumulated profits as declared by the board of directors and details related to the cash dividend | |
| `cashInLieu` | [components.ActivityCashInLieu](../../models/components/activitycashinlieu.md) | :heavy_minus_sign: | Object containing metadata for cash in lieu | |
| `commission` | [components.ActivityCommission](../../models/components/activitycommission.md) | :heavy_minus_sign: | Used to record commission charged by brokers or financial intermediaries for executing financial transactions on behalf of clients | |
| `commissions` | [components.Commission](../../models/components/commission.md)[] | :heavy_minus_sign: | Any commissions associated with the activity | |
| `conversion` | [components.ActivityConversion](../../models/components/activityconversion.md) | :heavy_minus_sign: | Used to record the conversion of securities (generally convertible bonds or preferred shares) into another form of securities (usually common shares) at a pre-stated price or rate and details related to the conversion | |
| `corporateActionMemoAdjustment` | [components.ActivityCorporateActionMemoAdjustment](../../models/components/activitycorporateactionmemoadjustment.md) | :heavy_minus_sign: | Used to record memo location adjustments initiated by the corporate action system due to reorg events | |
| `correspondentId` | *string* | :heavy_minus_sign: | A unique identifier referencing a Correspondent | 01AB2CDEAYOAK3ADJA4FJZCXZA |
| `creationTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date/time an activity was created in the ledger | 2023-12-22T05:00:00Z |
| `credit` | [components.ActivityCredit](../../models/components/activitycredit.md) | :heavy_minus_sign: | Used to disburse funds into a customer's account, typically for purposes such as refunds, interest payments, or rewards from enrolled programs and details related to the credit | |
| `currencyAssetId` | *string* | :heavy_minus_sign: | Required if any currency field like `price, gross_amount, trade.markup, fee.amount` is provided. The currency's ascend asset_id | 1 |
| `currencyCode` | *string* | :heavy_minus_sign: | The currency associated with the security Populated on a currency movement | USD |
| `deposit` | [components.ActivityDeposit](../../models/components/activitydeposit.md) | :heavy_minus_sign: | Used to record deposits of funds into an account and capture details related to the deposit | |
| `drip` | [components.ActivityDrip](../../models/components/activitydrip.md) | :heavy_minus_sign: | Used to record the movement of funds to/ from the pending_drip memo location | |
| `eventContractSettlement` | [components.ActivityEventContractSettlement](../../models/components/activityeventcontractsettlement.md) | :heavy_minus_sign: | Used to record the settlement/payout of event contracts based on real-world event outcomes | |
| `exchange` | [components.ActivityExchange](../../models/components/activityexchange.md) | :heavy_minus_sign: | Used to record the exchange of certificates for a new security or cash and details related to the exchange | |
| `fee` | [components.ActivityFee](../../models/components/activityfee.md) | :heavy_minus_sign: | Used to record Fees that have been assessed to account and capture details related to the fee | |
| `fees` | [components.Fee](../../models/components/fee.md)[] | :heavy_minus_sign: | Any fees associated with the activity | |
| `fpsl` | [components.ActivityFpsl](../../models/components/activityfpsl.md) | :heavy_minus_sign: | Used to record the movements of shares to/ from the fpsl memo location and details related to the fpsl memo | |
| `generation` | *string* | :heavy_minus_sign: | For a given set of activity that are part of the same lineage the highest generation will be the most recent activity | 1 |
| `grossAmount` | [components.ActivityGrossAmount](../../models/components/activitygrossamount.md) | :heavy_minus_sign: | The monetary value of an activity, exclusive of any fees, withholdings, accrued_interest, or commissions (First money) | {
"value": "0.25"
} |
| `interest` | [components.ActivityInterest](../../models/components/activityinterest.md) | :heavy_minus_sign: | Used to record the payment of interest to accounts that have maintained a cash balance or the charging of interest to accounts that have used margin and details related to the interest | |
| `interestPayment` | [components.ActivityInterestPayment](../../models/components/activityinterestpayment.md) | :heavy_minus_sign: | Used to record the The payment of an obligation an issuer has agreed to make to holders of an interest-bearing security and details related to the interest payment. Usually, the payment is made in cash and on a scheduled basis | |
| `liquidation` | [components.ActivityLiquidation](../../models/components/activityliquidation.md) | :heavy_minus_sign: | Used to record the dismantling of a business by an issuer, paying off debts in order of priority and distributing the remaining assets in cash and/or securities to the owners of the securities and details related to the liquidation | |
| `maturity` | [components.ActivityMaturity](../../models/components/activitymaturity.md) | :heavy_minus_sign: | Used to record he final repayment, usually in cash, by an issuer for the entire issue, or remaining outstanding securities of a specific security on a specified date and details related to the maturity | |
| `merger` | [components.ActivityMerger](../../models/components/activitymerger.md) | :heavy_minus_sign: | Used to record the exchange of one company's security for another company's security, cash, or a combination of cash and securities and details related to the merger | |
| `name` | *string* | :heavy_minus_sign: | accounts/{account_id}/activities/{activity_id} | accounts/{account_id}/activities/{activity_id} |
| `nameChange` | [components.ActivityNameChange](../../models/components/activitynamechange.md) | :heavy_minus_sign: | Used to record changes in the name of a security/securities by the issuer which result in surrendering physical securities or the assigning of a new security identifier which result in new securities being issued and details related to the name changes | |
| `netAmount` | [components.ActivityNetAmount](../../models/components/activitynetamount.md) | :heavy_minus_sign: | The monetary value of an activity, inclusive of fees, withholding, commisions, etc (Second Money) | {
"value": "0.25"
} |
| `nextActivityId` | *string* | :heavy_minus_sign: | can be an empty string if there is no next activity is populated when there is a modification resulting in a new activity | 01YPBW4QX6R |
| `nextActivityProcessDate` | [components.NextActivityProcessDate](../../models/components/nextactivityprocessdate.md) | :heavy_minus_sign: | the process date of the next activity(nil if the next_activity_id is an empty string) | {
"day": 14,
"month": 5,
"year": 2024
} |
| `none` | [components.None](../../models/components/none.md) | :heavy_minus_sign: | None | |
| `originatingResourceName` | *string* | :heavy_minus_sign: | The resource name of the API resource that originated this ledger entry or activity. This field enables clients to link ledger activities back to their source transactions for reconciliation purposes. This field will only be populated when the client has direct access to the referenced resource via the Ascend API's. | booking/v1/accounts/{account_id}/trades/{trade_id} |
| `paymentInKind` | [components.ActivityPaymentInKind](../../models/components/activitypaymentinkind.md) | :heavy_minus_sign: | Used to record payments on interest-bearing securities where the payment is made in additional securities rather than cash and details related to the payment | |
| `previousActivityId` | *string* | :heavy_minus_sign: | When populated, the activity_id of that precedes this one | 01YPBW4QX6R |
| `previousProcessDate` | [components.PreviousProcessDate](../../models/components/previousprocessdate.md) | :heavy_minus_sign: | When populated, the processing_date of the previous_activity_id | {
"day": 14,
"month": 5,
"year": 2024
} |
| `price` | [components.ActivityPrice](../../models/components/activityprice.md) | :heavy_minus_sign: | The monetary value paid for a given security in a trade Not populated on a currency only movement | {
"value": "0.25"
} |
| `processDate` | [components.ActivityProcessDate](../../models/components/activityprocessdate.md) | :heavy_minus_sign: | The date that the activity was booked to the ledger | {
"day": 14,
"month": 5,
"year": 2024
} |
| `quantity` | [components.ActivityQuantity](../../models/components/activityquantity.md) | :heavy_minus_sign: | The quantity of shares bought, sold, or moved for a given entry/activity Required if activity.state != PENDING | {
"value": "0.25"
} |
| `redemptionFull` | [components.ActivityRedemptionFull](../../models/components/activityredemptionfull.md) | :heavy_minus_sign: | Used to record the redemption of a security for cash in its entirety for which the holders receive the principal amount of the security and details related to the redemption | |
| `redemptionPartial` | [components.ActivityRedemptionPartial](../../models/components/activityredemptionpartial.md) | :heavy_minus_sign: | Used when securities are redeemed by the issuer for cash, in part, before their scheduled maturity date and details related to the redemption. The outstanding amount of securities will be proportionally reduced based on a specific percentage of holding | |
| `regionCode` | *string* | :heavy_minus_sign: | Two character region code, complies with https://cldr.unicode.org/index | US |
| `reverseStockSplit` | [components.ActivityReverseStockSplit](../../models/components/activityreversestocksplit.md) | :heavy_minus_sign: | Used to record the exchange of a company's security for the same company's new security at a preset rate and details related to the reverse stock split | |
| `rightsDistribution` | [components.ActivityRightsDistribution](../../models/components/activityrightsdistribution.md) | :heavy_minus_sign: | Used to record distributions to common stock holders of a company that grant the option to purchase new or additional securities of the same company during a predetermined time period at a predetermined price and details related to the rights distribution | |
| `rightsSubscription` | [components.ActivityRightsSubscription](../../models/components/activityrightssubscription.md) | :heavy_minus_sign: | Used to record the purchase of new or additional securities and details related to the subscription. Rights are often tradable in a secondary market | |
| `roundingAdjustment` | [components.ActivityRoundingAdjustment](../../models/components/activityroundingadjustment.md) | :heavy_minus_sign: | Used to record rounding adjustments when the sum(price x quantity) of all entries for a given activity do not equal the price x quantity of the fully formed activity record | |
| `roundingAmount` | [components.RoundingAmount](../../models/components/roundingamount.md) | :heavy_minus_sign: | the difference between the aggregation of gross_amount from the trade entries and the rounded gross_amount of the fully formed activity This amount can also be found as a rounding_adjustment entry | {
"value": "0.25"
} |
| `roundingReason` | *string* | :heavy_minus_sign: | Free form text field providing reason for rounding | Trade Rounding |
| `saleOfRights` | [components.ActivitySaleOfRights](../../models/components/activitysaleofrights.md) | :heavy_minus_sign: | Used to record payments made by the issuer to security holders when the security is subject to redemptions other than full and partial calls (e.g., early CD redemptions) and details related to the sale of rights | |
| `settleDate` | [components.ActivitySettleDate](../../models/components/activitysettledate.md) | :heavy_minus_sign: | The date a given activity will officially settle | {
"day": 14,
"month": 5,
"year": 2024
} |
| `side` | [components.ActivitySide](../../models/components/activityside.md) | :heavy_minus_sign: | Denotes whether the trade is a buy or sell | BUY |
| `sideModifier` | [components.ActivitySideModifier](../../models/components/activitysidemodifier.md) | :heavy_minus_sign: | Indicates whether the trade is opening a new position or closing an existing position | OPEN |
| `spinoff` | [components.ActivitySpinoff](../../models/components/activityspinoff.md) | :heavy_minus_sign: | Used to record a distribution of subsidiary securities to the shareholders of the parent company without a surrender of securities or payment and details related to the spinoff. A spin-off represents a form of divestiture resulting in an independent company | |
| `state` | [components.ActivityState](../../models/components/activitystate.md) | :heavy_minus_sign: | The state of the activity | PENDING |
| `stockDividend` | [components.ActivityStockDividend](../../models/components/activitystockdividend.md) | :heavy_minus_sign: | Used to record a dividend paid to shareholders in the form of shares of stock in either the issuing company or in another company and details related to the stock dividend | |
| `stockSplit` | [components.ActivityStockSplit](../../models/components/activitystocksplit.md) | :heavy_minus_sign: | Used to record the increase in a company's number of outstanding shares of stock without any change in the shareholder's equity or the aggregate market value at the time of the split and details related to the stock split | |
| `subtypeCategory` | *string* | :heavy_minus_sign: | String representation of the metadata object containing more information about an entry/ activity | TRADE |
| `sweep` | [components.ActivitySweep](../../models/components/activitysweep.md) | :heavy_minus_sign: | Used to record sweeps from a cash balance to an alternative asset or vice versa and details related to the sweep | |
| `tenderOffer` | [components.ActivityTenderOffer](../../models/components/activitytenderoffer.md) | :heavy_minus_sign: | Used to record the sale of securities for a specified price due to an offer from the issuer or a third party and details related to the tender offer | |
| `trade` | [components.ActivityTrade](../../models/components/activitytrade.md) | :heavy_minus_sign: | Used to record the the execution of a buy or sell transaction resulting in the transfer of securities and corresponding payment and details related to the trade | |
| `transfer` | [components.ActivityTransfer](../../models/components/activitytransfer.md) | :heavy_minus_sign: | Used to record more generic transfers of funds or securities and details related to the transfer. The transfer type and activity_description can be used to provide more specific context | |
| `type` | [components.ActivityType](../../models/components/activitytype.md) | :heavy_minus_sign: | The type of activity this is | TRADE |
| `unitSplit` | [components.ActivityUnitSplit](../../models/components/activityunitsplit.md) | :heavy_minus_sign: | Used to record increases in the number of units outstanding through the issuing of more units to current shareholders and details related to the unit split | |
| `warrantExercise` | [components.ActivityWarrantExercise](../../models/components/activitywarrantexercise.md) | :heavy_minus_sign: | Used to record the exchange of warrants for shares and details related to the warrant exercise. The exercise will commonly require a payment based upon a pre-determined value and time and details related to the warrant exercise | |
| `withdrawal` | [components.ActivityWithdrawal](../../models/components/activitywithdrawal.md) | :heavy_minus_sign: | Used to record withdrawals of funds from an account and capture details related to the withdrawal | |
| `withdrawalPendingReview` | [components.ActivityWithdrawalPendingReview](../../models/components/activitywithdrawalpendingreview.md) | :heavy_minus_sign: | Used to record the movement of funds to/ from the pending_withdrawal memo location | |
| `withholding` | [components.ActivityWithholding](../../models/components/activitywithholding.md) | :heavy_minus_sign: | Used to record tax withholdings and details related to the withholding | |
| `withholdings` | [components.Withholding](../../models/components/withholding.md)[] | :heavy_minus_sign: | Any withholdings associated with the activity | |
| `worthless` | [components.ActivityWorthless](../../models/components/activityworthless.md) | :heavy_minus_sign: | Used to record the removal of positions in a given security when the DTC has received formal notice that the security is worthless and details related to the worthless event | |