Company invoices

Get a MagicDoor invoice

Fetches one invoice with every charge on it, a roll-up by service, the payments applied to it, and the invoice PDF.

GET
https://api.portal.magicdoor.com/company-app/invoices/{billId}

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

billIdstringrequired

The invoice to fetch. A Snowflake id sent as a decimal string.

example: 1833110447398404096

Response

200 · The invoice.

idstring

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

billDatestring · date-time

The date on the invoice, in the company's timezone.

dueDatestring · date-time

When MagicDoor expects to be paid, in the company's timezone.

totalAmountnumber

What the invoice comes to in dollars and cents. Positive — money the management company owes MagicDoor.

allocatedAmountnumber

How much of it has been paid or covered by credit so far.

dueAmountnumber

What is still outstanding: totalAmount less allocatedAmount. Zero means the invoice is settled.

memostring

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

referencestring

MagicDoor's reference for the invoice. Absent when none was set.

metadataobject

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

createdstring · date-time

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

updatedstring · date-time

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

creatorobject

Who created the record.

summariesobject[]

The invoice's charges rolled up by service, ordered by service name.

chargesobject[]

Every individual charge on the invoice.

allocationsobject[]

The payments applied to the invoice.

fileobject

The invoice PDF, with a signed download URL. Absent when no file is attached.

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

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