# TransferScheduleSummary

A transfer schedule summary that contains all of the common properties a schedules across rails

## Example Usage

```typescript
import { TransferScheduleSummary } from "@apexfintechsolutions/ascend-sdk/models/components";

let value: TransferScheduleSummary = {};
```

## Fields

| Field                                                                                                                                | Type                                                                                                                                 | Required                                                                                                                             | Description                                                                                                                          | Example                                                                                                                              |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| `amount`                                                                                                                             | [components.TransferScheduleSummaryAmount](../../models/components/transferschedulesummaryamount.md)                                 | :heavy_minus_sign:                                                                                                                   | A cash amount in the format of decimal value. An unset or empty value represents a full disbursement                                 | {<br/>"value": "100.00"<br/>}                                                                                                        |
| `clientScheduleId`                                                                                                                   | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | External identifier supplied by the API caller. Each request must have a unique pairing of client_schedule_id and account            | ABC-123                                                                                                                              |
| `direction`                                                                                                                          | [components.Direction](../../models/components/direction.md)                                                                         | :heavy_minus_sign:                                                                                                                   | Flag indicating whether this is a deposit or withdrawal transfer                                                                     | DEPOSIT                                                                                                                              |
| `mechanism`                                                                                                                          | [components.TransferScheduleSummaryMechanism](../../models/components/transferschedulesummarymechanism.md)                           | :heavy_minus_sign:                                                                                                                   | The mechanism used for this transfer schedule                                                                                        | ACH                                                                                                                                  |
| `retirementContribution`                                                                                                             | [components.TransferScheduleSummaryRetirementContribution](../../models/components/transferschedulesummaryretirementcontribution.md) | :heavy_minus_sign:                                                                                                                   | The contribution info for a retirement account                                                                                       |                                                                                                                                      |
| `retirementDistribution`                                                                                                             | [components.TransferScheduleSummaryRetirementDistribution](../../models/components/transferschedulesummaryretirementdistribution.md) | :heavy_minus_sign:                                                                                                                   | The distribution info for a retirement account                                                                                       |                                                                                                                                      |
| `scheduleProperties`                                                                                                                 | [components.ScheduleProperties](../../models/components/scheduleproperties.md)                                                       | :heavy_minus_sign:                                                                                                                   | Common schedule properties                                                                                                           |                                                                                                                                      |
| `transferSchedule`                                                                                                                   | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | The name of the schedule resource this detail represents                                                                             | accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/{transferScheduleType}/40eb6b6f-76ff-4dc9-b8a0-b65a7658f8b1                                      |