Lease deposits

Replace a deposit's file list

Replaces the whole list of files attached to a deposit. Send every file you want to keep — anything missing from the list is detached.

PUT

https://api.portal.magicdoor.com/company-app/leases/{leaseId}/deposits/{depositId}/files

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

leaseIdstringrequired

The lease the deposit is on. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

depositIdstringrequired

The deposit whose file list you are replacing. A Snowflake id, sent as a decimal string.

example: 1837401928475620198

Body

application/json

filesobject[]required

The complete list of files the deposit should have. At least one.

Response

200 · The deposit, with its new file list.

idstring

Id of the deposit. A Snowflake id, sent as a decimal string.

createdstring · date-time

When the deposit was created, in the company's timezone.

updatedstring · date-time

When it last changed.

billDatestring · date

The date the deposit is booked into the ledger.

dueDatestring · date

The date the tenant has to pay it by.

totalAmountnumber

How much deposit was asked for, as a decimal amount.

allocatedAmountnumber

How much has been paid towards it.

dueAmountnumber

How much is still outstanding.

memostring

Free-text note on the deposit.

referencestring

External reference carried on the deposit.

portfolioIdstring

Portfolio the deposit rolls up to. A Snowflake id, sent as a decimal string.

propertyIdstring

Property the deposit is on. A Snowflake id, sent as a decimal string.

unitIdstring

Unit the deposit is on. A Snowflake id, sent as a decimal string.

leaseIdstring

Lease the deposit is on. A Snowflake id, sent as a decimal string.

refundableboolean

Whether this deposit is refundable to the tenant.

lineItemsLeaseDepositLineItem[]

What the deposit is made up of.

filesLeaseDepositFile[]

Files attached to the deposit, by id.

metadataobject

Free-form key/value data carried on the deposit.

creatorobject

Who created the record.

portfolioobject

The portfolio the lease rolls up to.

propertyobject

The property the lease's unit sits in.

unitobject

The unit the lease is for.

leaseobject

The lease the deposit is on.

transactionsTransaction[]

The transactions referenced by the allocations above.

bankAccountsBankAccount[]

Bank accounts referenced above.

chartOfAccountsChartOfAccount[]

Chart-of-account records referenced above.

hydratedFilesFile[]

The files listed in files, resolved to full file records.

creatorInfoobject

The full record of whoever created this, under whichever one key matches the creator's type.

400 · The request failed validation. `errors` maps each field name to what was wrong with it.

401 · The access token is missing, expired, or not for this company.

404 · No deposit matched the id, or it belongs to another company.

Request

curl --request PUT \
  --url 'https://api.portal.magicdoor.com/company-app/leases/1830472847398404096/deposits/1837401928475620198/files' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "files": [
    {
      "fileId": "1838475620198404096",
      "description": "Move-out condition report"
    }
  ]
}'

Body

{
  "files": [
    {
      "fileId": "1838475620198404096",
      "description": "Move-out condition report"
    }
  ]
}

Response

{
  "id": "1837401928475620198",
  "created": "2026-02-20T15:41:02",
  "updated": "2026-03-01T09:00:00",
  "billDate": "2026-03-01",
  "dueDate": "2026-03-01",
  "totalAmount": 1850,
  "allocatedAmount": 1850,
  "dueAmount": 0,
  "memo": "Security deposit",
  "portfolioId": "1827741029384756224",
  "propertyId": "1829933847562019840",
  "unitId": "1832019384756201984",
  "leaseId": "1830472847398404096",
  "refundable": true,
  "lineItems": [
    {
      "id": "1863019384756201984",
      "order": 0,
      "chartOfAccountId": "1826638475620198401",
      "description": "Security deposit",
      "amount": 1850,
      "allocatedAmount": 1850,
      "dueAmount": 0,
      "allocations": [
        {
          "id": "1864019384756201984",
          "transactionId": "1835029384756201984",
          "amount": 1850,
          "applied": "2026-03-01T09:00:00"
        }
      ]
    }
  ],
  "files": [],
  "metadata": {},
  "creator": {
    "type": "propertyManager",
    "id": "1854019384756201984",
    "source": "direct"
  },
  "portfolio": {
    "id": "1827741029384756224",
    "active": true,
    "name": "Downtown",
    "propertyCount": 6,
    "icons": []
  },
  "property": {
    "id": "1829933847562019840",
    "name": "Elm Street Apartments",
    "displayName": "Elm Street Apartments",
    "address": {
      "streetAddress1": "418 Elm Street",
      "city": "Portland",
      "state": "OR",
      "zipCode": "97204",
      "country": "US",
      "isValid": true
    },
    "portfolioId": "1827741029384756224",
    "type": "multiFamily",
    "unitCount": 24,
    "recentRentalApplications": 3,
    "active": true,
    "icons": []
  },
  "unit": {
    "id": "1832019384756201984",
    "name": "4B",
    "address": {
      "streetAddress1": "418 Elm Street",
      "city": "Portland",
      "state": "OR",
      "zipCode": "97204",
      "country": "US",
      "isValid": true
    },
    "beds": 2,
    "baths": 1,
    "unitSizeSqft": 880,
    "marketRent": 1850,
    "floor": 4,
    "propertyId": "1829933847562019840",
    "portfolioId": "1827741029384756224",
    "active": true,
    "icons": []
  },
  "lease": {
    "id": "1830472847398404096",
    "portfolioId": "1827741029384756224",
    "propertyId": "1829933847562019840",
    "unitId": "1832019384756201984",
    "start": "2026-03-01",
    "end": "2027-02-28",
    "ended": false,
    "monthToMonth": false,
    "eviction": false,
    "chatId": "1830472847398500000",
    "balance": 1850,
    "postedBalance": 1850,
    "currentRent": 1850,
    "securityDepositPaid": 1850,
    "securityDepositRequested": 1850,
    "securityDepositDue": 0,
    "lastPaymentDate": "2026-07-01",
    "earliestUnpaidBillDueDate": "2026-08-01",
    "pastDueDays": 16,
    "icons": [],
    "draft": false,
    "status": "lease",
    "expiringStatus": "none",
    "tenants": [
      {
        "tenantId": "1831856473920184832",
        "moveIn": "2026-03-01"
      }
    ]
  },
  "transactions": [
    {
      "id": "1835029384756201984",
      "created": "2026-08-17T09:31:04",
      "updated": "2026-08-17T09:31:04",
      "creator": {
        "type": "propertyManager",
        "id": "1854019384756201984",
        "source": "direct"
      },
      "type": "payment",
      "identity": "leaseDeposit",
      "direction": "in",
      "amount": 1850,
      "paymentMethod": "check",
      "status": "success",
      "transactionDate": "2026-08-17",
      "finalizedDate": "2026-08-17",
      "reference": "4471",
      "bankAccountId": "1826774829384756224",
      "chartOfAccountId": "1826638475620198400",
      "portfolioId": "1827741029384756224",
      "propertyId": "1829933847562019840",
      "unitId": "1832019384756201984",
      "leaseId": "1830472847398404096",
      "tenantId": "1831856473920184832",
      "externalTransactionType": "offline",
      "allowedChartOfAccountIds": [
        "1826638475620198400"
      ],
      "metadata": {},
      "bankAccount": {
        "id": "1826774829384756224",
        "name": "Operating account",
        "active": true,
        "accountNumber": "4417",
        "routingNumber": "0021",
        "type": "checking",
        "scheduledSweepDays": [],
        "chartOfAccountIds": [
          "1826638475620198400"
        ],
        "companyAccount": false,
        "creator": {
          "type": "propertyManager",
          "id": "1854019384756201984",
          "source": "direct"
        }
      },
      "chartOfAccount": {
        "id": "1826638475620198400",
        "number": 4000,
        "type": "revenue",
        "name": "Rent income",
        "creator": {
          "type": "system",
          "source": "direct"
        },
        "isDefault": true
      },
      "property": {
        "id": "1829933847562019840",
        "name": "Elm Street Apartments",
        "displayName": "Elm Street Apartments",
        "address": {
          "streetAddress1": "418 Elm Street",
          "city": "Portland",
          "state": "OR",
          "zipCode": "97204",
          "country": "US",
          "isValid": true
        },
        "portfolioId": "1827741029384756224",
        "type": "multiFamily",
        "unitCount": 24,
        "recentRentalApplications": 3,
        "active": true,
        "icons": []
      },
      "unit": {
        "id": "1832019384756201984",
        "name": "4B",
        "address": {
          "streetAddress1": "418 Elm Street",
          "city": "Portland",
          "state": "OR",
          "zipCode": "97204",
          "country": "US",
          "isValid": true
        },
        "beds": 2,
        "baths": 1,
        "unitSizeSqft": 880,
        "marketRent": 1850,
        "floor": 4,
        "propertyId": "1829933847562019840",
        "portfolioId": "1827741029384756224",
        "active": true,
        "icons": []
      },
      "lease": {
        "id": "1830472847398404096",
        "portfolioId": "1827741029384756224",
        "propertyId": "1829933847562019840",
        "unitId": "1832019384756201984",
        "start": "2026-03-01",
        "end": "2027-02-28",
        "ended": false,
        "monthToMonth": false,
        "eviction": false,
        "chatId": "1830472847398500000",
        "balance": 1850,
        "postedBalance": 1850,
        "currentRent": 1850,
        "securityDepositPaid": 1850,
        "securityDepositRequested": 1850,
        "securityDepositDue": 0,
        "lastPaymentDate": "2026-07-01",
        "earliestUnpaidBillDueDate": "2026-08-01",
        "pastDueDays": 16,
        "icons": [],
        "draft": false,
        "status": "lease",
        "expiringStatus": "none",
        "tenants": [
          {
            "tenantId": "1831856473920184832",
            "moveIn": "2026-03-01"
          }
        ]
      },
      "tenant": {
        "id": "1831856473920184832",
        "active": true,
        "email": "dana.whitfield@example.com",
        "firstName": "Dana",
        "lastName": "Whitfield",
        "phone": "(503) 555-0142",
        "created": "2025-11-02T09:14:00",
        "updated": "2026-07-19T16:40:12",
        "portalStatus": "active",
        "language": "en",
        "icons": []
      },
      "creatorInfo": {
        "propertyManager": {
          "id": "1854019384756201984",
          "firstName": "Alex",
          "lastName": "Reyes"
        }
      }
    }
  ],
  "bankAccounts": [
    {
      "id": "1826774829384756224",
      "name": "Operating account",
      "active": true,
      "accountNumber": "4417",
      "routingNumber": "0021",
      "type": "checking",
      "scheduledSweepDays": [],
      "chartOfAccountIds": [
        "1826638475620198400"
      ],
      "companyAccount": false,
      "creator": {
        "type": "propertyManager",
        "id": "1854019384756201984",
        "source": "direct"
      }
    }
  ],
  "chartOfAccounts": [
    {
      "id": "1826638475620198401",
      "number": 2100,
      "type": "liability",
      "name": "Security deposits held",
      "creator": {
        "type": "system",
        "source": "direct"
      },
      "isDefault": true
    }
  ],
  "hydratedFiles": [],
  "creatorInfo": {}
}