Property charges

Adjust a property charge

Changes a recorded charge — its amount, date, memo, ledger account or bank account. Send only the fields you want changed; at least one must actually differ.

PUT

https://api.portal.magicdoor.com/company-app/properties/{propertyId}/bills/{propertyChargeId}

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

propertyIdstringrequired

Snowflake id of the property the charge belongs to.

example: 1830472847398404097

propertyChargeIdstringrequired

Snowflake id of the property charge.

example: 1830472847398404101

Body

application/json

At least one field must be present and different from what is stored.

amountnumber

The new amount. A decimal with at most two places, and it must be greater than zero.

bankAccountIdstring

Move the charge to a different bank account.

chartOfAccountIdstring

Book the amount to a different revenue account.

cashChartOfAccountIdstring

Use a different cash asset account for the other side of the entry.

chargeDatestring · date

The new charge date, as YYYY-MM-DD, read in the company's timezone.

memostring

New free text, up to 200 characters.

externalTransactionIdstring

Your own reference for the payment, up to 100 characters.

Response

200 · The adjusted charge, hydrated.

idstring

Snowflake id of the charge.

createdstring · date-time

When the charge was recorded, as a wall clock in the company's timezone with no offset.

updatedstring · date-time

When it last changed.

chargeDatestring · date

The date the charge is booked against, in the company's timezone.

amountnumber

How much, as a decimal amount such as 45.00. Always greater than zero.

memostring

Free text on the charge, up to 200 characters. Absent when none was written.

referencestring

A reference carried on the charge from the accounting side. Absent when there is none — no field on this API sets it.

chartOfAccountIdstring

The revenue account the amount was booked to.

transactionIdstring

The transaction this charge created. Read it from transactions on this same response to see the bank account and status.

portfolioIdstring

The portfolio behind the property. Derived, not supplied.

propertyIdstring

The property the charge is booked against.

unitIdstring

The unit the charge is narrowed to. Absent when the charge is against the whole property.

leaseIdstring

The lease the charge is narrowed to. Absent when it is not tied to one.

returnedTransactionIdstring

The transaction that pulled the money back. Absent unless the charge was returned.

returnedAmountnumber

How much came back. Absent unless the charge was returned.

returnedDatestring · date-time

When it came back. Absent unless the charge was returned.

returnedReasonstring

Why it came back. Absent unless the charge was returned.

filesobject[]

Documents attached to the charge. Empty in practice — this API has no endpoint that attaches one.

metadataobject

Whatever you passed as metadata when the charge was created, as a map of string keys to string values. Empty when none was given.

creatorobject

Who recorded the charge.

portfolioobject

The portfolio behind the property, expanded.

propertyobject

The property the charge is booked against, expanded.

unitobject

The unit the charge is narrowed to, expanded. Absent when the charge is against the whole property.

leaseLease

The lease the charge is narrowed to, in the same shape the leases endpoints return. Absent when it is not tied to one.

transactionsTransaction[]

The transaction this charge created, and the returning transaction if there is one, in the same shape the transactions endpoints return.

bankAccountsBankAccount[]

The bank accounts those transactions touch.

chartOfAccountsChartOfAccount[]

The ledger accounts those transactions touch.

creatorInfoobject

The record behind creator, expanded. Exactly one of the four is present, matching creator.type; all four are absent for system and magicDoor.

400 · Nothing in the body differs from the stored charge, `amount` is zero or negative or has more than two decimal places, or the memo is over 200 characters. The response carries an `errors` member mapping each rejected field name to its message.

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

404 · No charge with that id, or it belongs to another company.

The same operation answers on two paths

This controller is registered on both /company-app/properties/{propertyId}/bills and /company-app/properties/{propertyId}/charges. Both paths reach the same code and behave identically. The pages here document the /bills form.

This one really is a partial update

Unlike the property and unit update endpoints, this body only touches the fields you send. Anything you leave out keeps its current value. A body that changes nothing is rejected.