Accounting: Transfer

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AccountingTransfer",
  "title": "Accounting: Transfer",
  "description": "A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).",
  "allOf": [
    {
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier for the transfer."
        },
        "description": {
          "type": "string",
          "nullable": true,
          "description": "Description of the transfer."
        },
        "contactRef": {
          "$ref": "#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/contactRef",
          "description": "The customer or supplier for the transfer, if available."
        },
        "date": {
          "$ref": "#/components/schemas/DateTime",
          "description": "The day on which the transfer was made."
        },
        "from": {
          "$ref": "#/components/schemas/AccountingTransfer/definitions/transferAccount",
          "description": "The details of the accounts the transfer is moving from."
        },
        "to": {
          "$ref": "#/components/schemas/AccountingTransfer/definitions/transferAccount",
          "description": "The details of the accounts the transfer is moving to."
        },
        "status": {
          "description": "The status of the transfer in the account",
          "type": "string",
          "enum": [
            "Unknown",
            "Unreconciled",
            "Reconciled",
            "Void"
          ],
          "nullable": true
        },
        "trackingCategoryRefs": {
          "type": "array",
          "nullable": true,
          "description": "Reference to the tracking categories this transfer is being tracked against.",
          "items": {
            "$ref": "#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef"
          }
        },
        "depositedRecordRefs": {
          "type": "array",
          "nullable": true,
          "description": "List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer.",
          "items": {
            "$ref": "#/components/schemas/AccountingRecordRef"
          }
        },
        "metadata": {
          "$ref": "#/components/schemas/Metadata"
        },
        "supplementalData": {
          "$ref": "#/components/schemas/SupplementalData"
        }
      }
    },
    {
      "$ref": "#/components/schemas/CommerceOrder/allOf/3"
    }
  ],
  "definitions": {
    "transferAccount": {
      "title": "Transfer account",
      "description": "Account details of the account sending or receiving the transfer.",
      "type": "object",
      "properties": {
        "accountRef": {
          "$ref": "#/components/schemas/AccountingRecordRef",
          "description": "The account that the transfer is moving from or to."
        },
        "currency": {
          "$ref": "#/components/schemas/SourceAccount/properties/currency"
        },
        "amount": {
          "type": "number",
          "format": "decimal",
          "description": "The amount transferred between accounts."
        }
      }
    }
  },
  "type": "object"
}