> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lead.bank/llms.txt
> Use this file to discover all available pages before exploring further.

# Transactions Update Schema

<Info>
  Used when the settlement date differs from the one submitted in the Transactions files.
</Info>

<Check>
  **Applicable to Balance Type = Deposit Only**\
  This file captures transactions where the actual settlement date differs from the one submitted in the Transactions file. It provides the updated `settlement_date` and supports financial reconciliation by ensuring accurate alignment of transaction timing.\
  \
  Inaccurate data may risk proper account funding and disrupt program operations.
</Check>

## Overview

The purpose of this file is so that you can report when the `settlement_date` of a transaction previously reported in a Transaction file was different than initially forecasted.

As an example, an ACH or Wire transaction can be initiated and reported as a transaction, but actual money movement may not always be deterministic (e.g., it may be held in manual review and not posted at the time you initially predicted).

By reporting an updated `settlement_date`, this allows Lead to run reconciliation of bank accounts (typically an FBO) with the latest information of when funds should have been sitting in the account.

In contrast, `effective_at` dates reported in the Transaction file cannot be updated. `effective_at` represents when the available balance for an end-user was updated. This is a deterministic timestamp and is independent of when underlying funds settle, which cannot always be accurately forecasted.

<Check>
  For all optional fields where you do not plan to pass through data, please include the header and an empty value.
</Check>

## Schema

### IDS & Details

| **Field**       | **Description**                                                                                                                                                                                         | **Required** | **Data Type** |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------- |
| transaction\_id | The unique ID for the transaction.  Before including an ID in this file, please ensure that it has previously been submitted in the Transactions File so that Lead has an existing awareness of the ID. | Required     | string        |

### Transaction Information

| **Field**        | **Description**                                                                                                                       | **Required**                                                           | **Data Type**          |
| :--------------- | :------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------- | :--------------------- |
| settlement\_date | The updated settlement date of this transaction.                                                                                      | Required                                                               | date<br />`YYYY-MM-DD` |
| transfer\_id     | The unique IDs for the related transfer object, if applicable (e.g. the ACH ID or Wire ID or Internal Transfer ID generated by Lead). | Required if `transfer_type` = `ach` `wire` `internal_transfer` at Lead | string                 |

### Other

| **Field**     | **Description**                                                                                     | **Required** | **Data Type**                                                                   |
| :------------ | :-------------------------------------------------------------------------------------------------- | :----------- | :------------------------------------------------------------------------------ |
| generated\_at | The day this file is generated. This should always be the date the file is sent to Lead Bank.       | Required     | datetime<br />[ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) |
| effective\_at | The timestamp of when the related object(s) were polled to collect the information for this record. | Required     | datetime<br />[ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) |

## Transaction Type

<Warning>
  Since the timing of certain transaction and transfer types are more deterministic than others, only the below combinations of transaction and transfer types should be included in this file. Any other combinations not listed below are not permitted or supported.
</Warning>

| **Transaction Type**            | **Transfer Type**                                                                          |
| ------------------------------- | ------------------------------------------------------------------------------------------ |
| debit                           | `ach`, `wire`, `check`, `internal_transfer`, `external_transfer`, `out_of_bank_settlement` |
| credit                          | `ach`, `wire`, `check`, `internal_transfer`, `external_transfer`, `out_of_bank_settlement` |
| dispute\_provisional            | `internal_transfer`, `external_transfer`, `out_of_bank_settlement`                         |
| dispute\_lost                   | All available transfer types                                                               |
| escheatment                     | `ach`, `wire`, `check`, `internal_transfer`, `external_transfer`, `out_of_bank_settlement` |
| charge\_off\_recovery           | All available transfer types                                                               |
| rewards\_redeemed               | All available transfer types                                                               |
| fee (overdraft)                 | All available transfer types                                                               |
| fee (periodic maintenance)      | All available transfer types                                                               |
| fee (card)                      | All available transfer types                                                               |
| fee (international transaction) | All available transfer types                                                               |
| fee (other)                     | All available transfer types                                                               |
| interest\_paid                  | All available transfer types                                                               |
| adjustment                      | All available transfer types                                                               |