Service bills

Adjust a service bill

Changes a service bill's amount, charge date, unit, lease, memo or chart of accounts, and returns it as it now stands. Properties left out are unchanged.

PUT
https://api.portal.magicdoor.com/company-app/service-bills/{serviceBillId}

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

serviceBillIdstringrequired

The service bill to adjust. A Snowflake id sent as a decimal string.

example: 1836110447398404096

Body

application/json

Only the properties you send are changed.

amountnumber

The new amount, in dollars and cents. At least 1.00.

chargeDatestring · date

The day to date the charge.

unitIdstring

The unit the charge relates to.

leaseIdstring

The lease the charge relates to.

propertyChartOfAccountIdstring

The chart of account the charge is booked to on the property's books.

companyChartOfAccountIdstring

The chart of account the charge is booked to on the company's books.

memostring

A note on the bill. At most 500 characters — note the create endpoint allows only 200.

Response

200 · The adjusted service bill.

idstring

The service bill. A Snowflake id sent as a decimal string.

chargeDatestring · date

The day the charge is dated.

totalAmountnumber

What the bill comes to in dollars and cents. Positive — money the property owes the management company for work beyond the management agreement.

paidAmountnumber

How much of it has been drawn out to the company.

outstandingAmountnumber

What is left: totalAmount less paidAmount.

memostring

A note on the bill. Absent when none was set.

referencestring

A reference on the bill. Absent when none was set.

companyVendorIdstring

The vendor record standing for the management company itself, which the bill is billed from.

lineItemsobject[]

The bill broken down by property, in display order.

filesobject[]

Files attached to the bill.

metadataobject

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

createdstring · date-time

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

updatedstring · date-time

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

creatorobject

Who created the bill.

vendorobject

The vendor record standing for the management company, resolved.

portfoliosobject[]

The portfolios the lines belong to, resolved.

propertiesobject[]

The properties the lines charge, resolved.

unitsobject[]

The units the lines refer to, resolved.

leasesobject[]

The leases the lines refer to, resolved.

transactionsobject[]

The accounting transactions behind the payouts, resolved.

bankAccountsobject[]

The bank accounts those transactions moved money through, resolved. Account and routing numbers are masked to their last four digits.

chartOfAccountsobject[]

The chart of accounts the bill books to, resolved.

hydratedFilesobject[]

The attachments in files, resolved to full file records with signed download URLs.

creatorInfoobject

The person behind creator, resolved. Exactly one of propertyManager, vendor, tenant and owner is present, matching creator.type.

400 · `amount` is below 1.00, or `memo` is longer than 500 characters.

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

404 · No service bill with that id exists for the caller's company, or a unit, lease or chart of account in the request does not.

422 · The bill cannot be adjusted — for example because it has already been paid out to the company.