Management fees

Update a management fee credit

Changes a credit's amount, issue date or description. Properties left out are unchanged. Reducing the amount below what has already been used is refused.

PUT
https://api.portal.magicdoor.com/company-app/management-fees/credits/{managementFeeCreditId}

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

managementFeeCreditIdstringrequired

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

example: 1835110447398404096

Body

application/json

Only the properties you send are changed.

amountnumber

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

issueDatestring · date

The day the credit is issued.

descriptionstring

Why the credit was issued. At most 1000 characters.

Response

200 · The updated credit.

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, resolved.

400 · `amount` is below 1.00, or `description` is longer than 1000 characters.

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

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

422 · The change is not allowed — for example lowering the amount below what has already been used.