Lease charges

Get a credit

Fetches one credit, including how much of it is still unused and which charges it has been applied to.

GET

https://api.portal.magicdoor.com/company-app/leases/{leaseId}/charges/credits/{creditId}

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 credit is on. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

creditIdstringrequired

The credit to fetch. A Snowflake id, sent as a decimal string.

example: 1836114029384756224

Response

200 · The credit.

idstring

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

createdstring · date-time

When the credit was issued, in the company's timezone.

updatedstring · date-time

When it last changed.

bankAccountIdstring

Bank account the credit is booked against. A Snowflake id, sent as a decimal string.

chartOfAccountIdstring

Account the credit is booked to. A Snowflake id, sent as a decimal string.

portfolioIdstring

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

propertyIdstring

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

unitIdstring

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

leaseIdstring

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

amountnumber

How much credit was issued, as a decimal amount.

appliedAmountnumber

How much of it has been used against charges.

availableAmountnumber

How much of it is still unused.

creditDatestring · date

The date the credit counts from.

appliedLeaseChargesAppliedLeaseCharge[]

Which charges the credit has been used against.

metadataobject

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

creatorobject

Who created the record.

bankAccountobject

The bank account the credit is booked against.

chartOfAccountobject

The account the credit is booked to.

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 credit is on.

leaseChargesLeaseCharge[]

The charges named in appliedLeaseCharges.

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

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

Request

curl --request GET \
  --url 'https://api.portal.magicdoor.com/company-app/leases/1830472847398404096/charges/credits/1836114029384756224' \
  --header 'Authorization: Bearer <token>'

Response

{
  "id": "1836114029384756224",
  "created": "2026-08-05T11:02:44",
  "updated": "2026-08-05T11:02:44",
  "bankAccountId": "1826774829384756224",
  "chartOfAccountId": "1826638475620198400",
  "portfolioId": "1827741029384756224",
  "propertyId": "1829933847562019840",
  "unitId": "1832019384756201984",
  "leaseId": "1830472847398404096",
  "amount": 200,
  "appliedAmount": 200,
  "availableAmount": 0,
  "creditDate": "2026-08-05",
  "appliedLeaseCharges": [
    {
      "leaseChargeId": "1834920184756201984",
      "appliedAmount": 200,
      "applied": "2026-08-05"
    }
  ],
  "metadata": {},
  "creator": {
    "type": "propertyManager",
    "id": "1854019384756201984",
    "source": "direct"
  },
  "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
  },
  "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"
      }
    ]
  },
  "leaseCharges": [
    {
      "id": "1834920184756201984",
      "created": "2026-08-01T00:03:11",
      "updated": "2026-08-01T00:03:11",
      "companyCharge": false,
      "billDate": "2026-08-01",
      "dueDate": "2026-08-01",
      "totalAmount": 1850,
      "allocatedAmount": 1850,
      "dueAmount": 0,
      "memo": "Monthly rent",
      "portfolioId": "1827741029384756224",
      "propertyId": "1829933847562019840",
      "unitId": "1832019384756201984",
      "leaseId": "1830472847398404096",
      "recurringChargeId": "1840193847562019840",
      "lineItems": [
        {
          "id": "1858019384756201984",
          "order": 0,
          "chartOfAccountId": "1826638475620198400",
          "description": "Monthly rent",
          "amount": 1850,
          "allocatedAmount": 1850,
          "dueAmount": 0,
          "allocations": [
            {
              "id": "1859019384756201984",
              "transactionId": "1835029384756201984",
              "amount": 1850,
              "applied": "2026-08-03T14:12:00"
            }
          ]
        }
      ],
      "files": [],
      "metadata": {},
      "creator": {
        "type": "system",
        "source": "recurring"
      }
    }
  ]
}