Management fees

Create a management fee credit

Issues a credit against a property that future management fees can be set off against. The credit starts fully available and is drawn down oldest first when fees are charged.

POST
https://api.portal.magicdoor.com/company-app/management-fees/credits

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.

Body

application/json

propertyIdstringrequired

The property the credit applies to. Must belong to the caller's company and be active.

amountnumberrequired

What the credit is worth, in dollars and cents. At least 1.00.

issueDatestring · daterequired

The day the credit is issued. Returned as creditDate.

descriptionstring

Why the credit is being issued. At most 1000 characters. Returned as memo.

Response

200 · The credit that was created.

idstring

The credit. A Snowflake id sent as a decimal string.

propertyIdstring

The property whose management fees this credit can offset.

portfolioIdstring

The portfolio that property belongs to.

amountnumber

What the credit is worth, in dollars and cents. Positive — money that reduces what the property owes in management fees.

appliedAmountnumber

How much of it has already been used against fees.

availableAmountnumber

What is left to use: amount less appliedAmount.

creditDatestring · date

The day the credit was issued.

memostring

Why the credit was issued. Absent when none was recorded.

bankAccountIdstring

The bank account the credit is booked against.

chartOfAccountIdstring

The chart of account the credit is booked to.

appliedManagementFeesobject[]

Which management fees the credit has been used against.

metadataobject

Free-form key-value pairs kept on the credit.

createdstring · date-time

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

updatedstring · date-time

When it last changed, in the company's timezone.

creatorobject

Who created the record.

bankAccountobject

The bank account the credit is booked against.

chartOfAccountobject

The chart of account the credit is booked to.

portfolioobject

The portfolio the property belongs to.

propertyobject

The property the credit is for.

managementFeesobject[]

The management fees the credit has been applied to. Empty on a new credit.

400 · `amount` is below 1.00, `description` is longer than 1000 characters, or a required field is missing.

401 · The access token is missing, expired, or does not belong to a property manager.

404 · No property with that id exists for the caller's company.

422 · The property is deactivated.