Property charges

Get a property charge

Fetches one charge with the property, unit, lease and transactions behind it, and who recorded it.

GET

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

Response

200 · The 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.

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.

`propertyId` is not checked here

The charge is found by propertyChargeId alone. propertyId has to be in the URL because the route requires it, but the handler ignores it — a charge on one property fetched through another property's path still comes back. Read propertyId from the response if you need the real one.