Get facility ledger entries by UUIDs
Retrieves ledger entry details for the provided array of UUIDs within a specific facility, most recently created first
Headers
Api key required to authenticate your request. Please reach out to monument for a key.
"monument-2230012-2312321"
Path Parameters
Body
Array of ledger entry UUIDs to retrieve data for
Response
Ledger entry details retrieved successfully
UUID of the ledger entry
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
UUID of the invoice
"4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e"
UUID of the invoice item this movement refers to, for cross-referencing against the invoice items endpoint. Always present on this route, which only returns movements tied to an invoice item.
"7d8e9f0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a"
UUID of the payment this movement belongs to, for cross-referencing against the payments endpoint. On a reversal or refund movement this is the ORIGINAL payment being undone, not the reversing payment. Null when the movement has no payment linked; when present, paymentStatus and gatewayDeclineType below describe that payment.
"8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b"
Current status of the payment. COMPLETED on a payment that settled; REFUNDED, PARTIALLY_REFUNDED, CHARGEBACK, REVERSED, VOIDED and RECONCILIATION_FAILED mean it was later undone or the funds recovered.
READY, PROCESSING, COMPLETED, REFUNDED, FAILURE, REVERSED, VOIDED, RECONCILIATION_FAILED, CHARGEBACK, PARTIALLY_REFUNDED "REVERSED"
How the gateway declined the payment named by paymentUuid: SOFT is retryable (insufficient funds, temporary hold), HARD is not (closed account, stolen card). Two caveats for reporting on this pair of fields: (1) in practice this is always null here, because a payment the gateway declines throws before any invoice application and so produces no ledger movement at all — the funds-recovery signal this route can deliver is paymentStatus reading REFUNDED, PARTIALLY_REFUNDED, CHARGEBACK, REVERSED, VOIDED (a returned check) or RECONCILIATION_FAILED; (2) paymentStatus is the CURRENT status of the linked payment, so a movement that settled normally reads one of those once that payment is later undone. Null when there is no linked payment, or when the gateway reported no decline type.
SOFT, HARD "SOFT"
UUID of the rental record associated with this ledger entry
"5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f"
UUID of the item type
"5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f"
Start date of the ledger entry service period
"2024-01-15T10:30:00.000Z"
End date of the ledger entry service period
"2024-01-15T10:30:00.000Z"
Current balance of the invoice item in pennies
15000
Description of the invoice item
"Monthly Storage Fee"
Unit price of the invoice item this movement refers to, in pennies, after proration when the charge is prorated. It belongs to the invoice item, not to the movement: every movement of the item repeats the same value. It is not a balance and is not meant to be summed; for the amount a movement charged, use amountInvoicedInPennies.
15000
Date when the ledger entry was created
"2024-01-15T10:30:00.000Z"
Invoice due date
"2024-01-15T10:30:00.000Z"
Date when the ledger entry was last updated
"2024-01-20T15:45:00.000Z"
Type of transaction for this ledger entry
PAYMENT, CREDIT, BAD_DEBT_WRITE_OFF, REFUND, VOID, INVOICE, CREDIT_MEMO, TRANSFER_CREDIT, REVERSED_CREDIT, FAILED_PAYMENT_REVERSAL, VOID_INVOICE, VOID_CHECK, CHARGEBACK, DEBIT_MEMO, AUCTION_PAYMENT, AUCTION_PAYOUT, BALANCE_TRANSFER "INVOICE"
Category of the item type linked to the invoice item. Null if the invoice item has no linked item type.
"COVERAGE"
Display name of the item type linked to the invoice item.
"Rent"
Tax charged by this ledger movement, in pennies (sum of the state, city, county and special components). Signed: negative on promotion, credit memo, void and reversal movements, so summing the movements of an invoice item yields the tax actually charged. 0 when the movement carries no invoiced tax.
858
Non-tax amount this movement added to or removed from the invoice item's charge, in pennies. On the movement that bills the item it is the line total (quantity × unit price, after proration), not the unit price. Signed: a promotion movement carries its discount as a negative value, and credit memo and invoice void movements carry the credit as a negative value, so summing the movements of an invoice item yields what was charged for it, net of discounts and credits. 0 on movements that only settle a charge, such as payments, credits, write-offs and refunds. Tax is reported separately in taxInvoicedInPennies. discountInPennies reports the same promotion discount as a positive value; do not subtract it again. The credit memo, invoice void and debit memo rows returned by the payments endpoint are these same adjustments; count them in one place.
3000
Tax settled by this ledger movement, in pennies (sum of the state, city, county and special components applied from a payment). Signed: negative on unapply and reversal movements, so summing the movements yields the tax actually collected. 0 when the movement settles no tax.
400
Tax rate of the invoice item this movement refers to, as a percentage (e.g. 8.25 = 8.25%). Unlike the amounts above it is an item-level rate, not a per-movement value, so a payment movement carrying no invoiced tax still reports the rate of the charge it settles. 0 when the invoice item is untaxed.
8.25
Tax codes carried by this ledger movement, one per jurisdiction. Always present; each code is null when the movement carries none for that jurisdiction.
Tax billed on this movement, split by jurisdiction. Always present; each jurisdiction reports 0 when it carries no tax. The four values sum to taxInvoicedInPennies: a prorated line leaves fractional pennies, so the spare penny goes to the jurisdiction with the largest remainder rather than letting the parts drift from the total. They do not sum only if the total did not come from these four columns, in which case each is reported on its own rather than fabricating a split.
Tax actually settled by a payment on this movement, split by jurisdiction. Always present; each jurisdiction reports 0 when it carries no tax. The four values sum to taxAppliedFromPaymentInPennies, with the spare penny from a prorated line going to the largest remainder, under the same caveat as taxInvoicedBreakdown.
Realized discount carried by this ledger movement, in pennies. Only promotion movements carry one; signed, so a movement that reverses a promotion is negative and summing the movements yields the discount actually realized. 0 on every other movement.
1000
UUID of the promotion that drove the discount on this line. Null when no promotion-driven discount.
"6bf96c30-4fb1-11f1-a3fa-b52fba19bc64"
Payment tender/source details. Null on non-payment lines (INVOICE/CREDIT/etc.).
Status of the invoice this ledger entry belongs to
OPEN, OVERDUE, PARTIAL, PAID, VOID, WRITTEN_OFF "OPEN"
Accrual GL account this movement posts its own amount to: the account configured on the item type — revenue, or deferred revenue on a prorated recurring charge — or, on a promotion movement, the sales discount account the discount is posted to. Null when the item type has no GL account configured.
The same account as glAccount on the cash basis. Null when the item type has no cash-basis account configured, and always null on a promotion movement, since no sales discount account exists on that basis.
Accrual GL account the tax of this movement posts to (Sales Tax Payable). A movement carries revenue and tax at once, so both accounts are needed for the movements to reconcile against the ledger. Null when the movement carries no tax.
The same tax account as taxGlAccount on the cash basis. Null when the movement carries no tax.
UUID of the coverage enrollment that produced this charge — the same identifier the coverage history route reports. Resolved on read by matching the invoice due date against the enrollment periods of the tenancy, compared by calendar day in the facility time zone (UTC when the facility has none recorded) and inclusive at both ends, the later start winning when two enrollments share a day. Null in three cases: the movement is not a coverage charge; no enrollment of the tenancy covers the day the invoice falls due; or the charge was imported from SiteLink, where every coverage charge landed on a single generic item type belonging to no coverage plan, so the link does not exist in the data and cannot be reconstructed. An imported charge stays identifiable by its itemTypeName. One known limitation: when a tenant switches coverage plan mid-cycle, the already-open invoice keeps its original due date while its coverage line is repointed to the new plan, so that movement reports the enrollment in force on the due date rather than the one now billed.
"5e6f7a8b-9c0d-1e2f-3a4b-5c6d7e8f9a0b"