# Monument Public API

## Docs

- [Cancel Auction](https://api.monument.io/api-reference/auctions/cancel-auction.md): Cancels an auction. Only auctions in SCHEDULED, PAYMENT_PENDING, or UNSOLD stage can be canceled.
- [Get Auction UUIDs](https://api.monument.io/api-reference/auctions/get-auction-uuids.md): Retrieves the UUIDs of all auctions for the facility, optionally filtered by date and auction criteria.
- [Get auctions by UUIDs](https://api.monument.io/api-reference/auctions/get-auctions-by-uuids.md): Retrieves auction details for the provided array of UUIDs, most recently updated first.
- [Update Auction Buyer Details](https://api.monument.io/api-reference/auctions/update-auction-buyer-details.md): Updates buyer details for an auction. Transitions SCHEDULED auctions to PAYMENT_PENDING.
- [Archive coverage plan](https://api.monument.io/api-reference/coverage/archive-coverage-plan.md): Archives a coverage plan, removing it from active use
- [Create coverage option](https://api.monument.io/api-reference/coverage/create-coverage-option.md): Creates a coverage option for the portfolio
- [Get coverage history details by UUIDs](https://api.monument.io/api-reference/coverage/get-coverage-history-details-by-uuids.md): Retrieves coverage history details for the provided array of UUIDs within a specific facility, most recently created first
- [Get coverage history UUIDs for a facility](https://api.monument.io/api-reference/coverage/get-coverage-history-uuids-for-a-facility.md): Retrieves the coverageHistoryUuids of all unitRentalRecords in facility identified by facilityUuid
- [Get coverage options for a facility](https://api.monument.io/api-reference/coverage/get-coverage-options-for-a-facility.md): Retrieves all non-archived coverage plans configured for the specified facility.
- [Get coverage options for the portfolio](https://api.monument.io/api-reference/coverage/get-coverage-options-for-the-portfolio.md): Retrieves all coverage options for the portfolio
- [Update coverage option](https://api.monument.io/api-reference/coverage/update-coverage-option.md): Updates a specified coverage option for the portfolio
- [Get delinquencies by UUIDs](https://api.monument.io/api-reference/delinquencies/get-delinquencies-by-uuids.md): Retrieve delinquency details for specified UUIDs
- [Get delinquency UUIDs](https://api.monument.io/api-reference/delinquencies/get-delinquency-uuids.md): Retrieve delinquency UUIDs based on specified filters
- [Get scheduled ECRIs](https://api.monument.io/api-reference/ecri/get-scheduled-ecris.md): Retrieves scheduled ECRIs with optional filters. Returns all scheduled ECRIs if no filters are provided.
- [Schedule ECRI for unit rental records](https://api.monument.io/api-reference/ecri/schedule-ecri-for-unit-rental-records.md): Schedules an Effective Current Rent Increase (ECRI) for one or more unit rental records, up to 1 day delay
- [Unschedule ECRI for unit rental records](https://api.monument.io/api-reference/ecri/unschedule-ecri-for-unit-rental-records.md): Unschedules an Effective Current Rent Increase (ECRI) for one or more unit rental records
- [Get facilities by UUIDs](https://api.monument.io/api-reference/facilities/get-facilities-by-uuids.md): Retrieves facility details for the provided array of UUIDs, most recently updated first
- [Get Facility UUIDs](https://api.monument.io/api-reference/facilities/get-facility-uuids.md): Retrieves the UUIDs of all facilities, optionally filtered by date.
- [Update facility coverage options](https://api.monument.io/api-reference/facilities/update-facility-coverage-options.md): Updates coverage options available for a facility, including default selection and enrollment availability
- [Get item types by UUIDs for a facility](https://api.monument.io/api-reference/item-types/get-item-types-by-uuids-for-a-facility.md): Retrieves item type details for the provided array of UUIDs, with organization tax rate information
- [Get ItemType UUIDs from Facility](https://api.monument.io/api-reference/item-types/get-itemtype-uuids-from-facility.md): Retrieves the UUIDs of all ItemTypes that have active organization item tax rates for the given facility, optionally filtered by date.
- [Get Lead Source Options](https://api.monument.io/api-reference/lead-source-options/get-lead-source-options.md): Retrieves all available lead source descriptions from the LeadSource table.
- [Get lead details by UUIDs](https://api.monument.io/api-reference/leads/get-lead-details-by-uuids.md): Returns details for specified leads associated with a facility, including primary person information and lead source.
- [Get lead UUIDs for a facility](https://api.monument.io/api-reference/leads/get-lead-uuids-for-a-facility.md): Retrieves the leadUuids of all leads in the facility identified by facilityUuid. Can be filtered by lead status and standard date filters.
- [Send a lease to a lead for signature](https://api.monument.io/api-reference/leads/send-a-lease-to-a-lead-for-signature.md): Validates lead information, checks for an existing signable lease (creating one if needed), and sends it via the specified contact method.
- [Get facility ledger entries by UUIDs](https://api.monument.io/api-reference/ledger-entries/get-facility-ledger-entries-by-uuids.md): Retrieves ledger entry details for the provided array of UUIDs within a specific facility, most recently created first
- [Get rental record ledger entries by UUIDs](https://api.monument.io/api-reference/ledger-entries/get-rental-record-ledger-entries-by-uuids.md): Retrieves ledger entry details for the provided array of UUIDs within a specific facility and rental record, most recently created first
- [List facility ledger entry UUIDs](https://api.monument.io/api-reference/ledger-entries/list-facility-ledger-entry-uuids.md): Retrieves a list of Ledger Entry UUIDs for a facility, optionally filtered by date ranges.
- [List rental record ledger entry UUIDs](https://api.monument.io/api-reference/ledger-entries/list-rental-record-ledger-entry-uuids.md): Retrieves a list of Ledger Entry UUIDs associated with a specific Rental Record, optionally filtered by date ranges.
- [Create note for lead](https://api.monument.io/api-reference/notes/create-note-for-lead.md): Creates a note for the specified lead
- [Create note for tenant](https://api.monument.io/api-reference/notes/create-note-for-tenant.md): Creates a note for the specified tenant account
- [Get notes by UUIDs](https://api.monument.io/api-reference/notes/get-notes-by-uuids.md): Retrieves note details for the provided array of UUIDs, most recently updated first
- [List note UUIDs](https://api.monument.io/api-reference/notes/list-note-uuids.md): Retrieves a list of Note UUIDs, optionally filtered by date ranges.
- [Create payment profile](https://api.monument.io/api-reference/payments/create-payment-profile.md): Creates a payment profile and links it to the given unit rental record. Use this to attach a payment method to a tenant's unit. See the Credit Card Integrations Guide for tokenization and processor setup details.
- [Get person details by UUIDs](https://api.monument.io/api-reference/people/get-person-details-by-uuids.md): Returns details for specified persons
- [Get person UUIDs](https://api.monument.io/api-reference/people/get-person-uuids.md): Retrieves the personUuids of all persons based on the applied filters
- [Assign a physical lock to a unit](https://api.monument.io/api-reference/physical-locks/assign-a-physical-lock-to-a-unit.md): Registers a physical lock assignment to a unit, creating a historical record, note, and unified inbox entry if applicable
- [Unassign a physical lock from a unit](https://api.monument.io/api-reference/physical-locks/unassign-a-physical-lock-from-a-unit.md): Registers a physical lock unassignment from a unit by setting the dateUnassigned field
- [List portfolios](https://api.monument.io/api-reference/portfolios/list-portfolios.md): Retrieves the values of portfolios, portfolioId can be used for :portfolio in other requests
- [Get promotions by UUIDs](https://api.monument.io/api-reference/promotions/get-promotions-by-uuids.md): Retrieves promotion details for the provided array of UUIDs that are assigned to the facility, most recently updated first. Only returns promotions that have not been archived.
- [List promotion UUIDs](https://api.monument.io/api-reference/promotions/list-promotion-uuids.md): Retrieves a list of Promotion UUIDs for a facility, optionally filtered by date ranges and unit group UUID.
- [Add a fee or service to monthly billing](https://api.monument.io/api-reference/rental-records/add-a-fee-or-service-to-monthly-billing.md): Adds a recurring fee or service to the unit rental record's billing template. The fee will appear on the **next** monthly invoice **generated** by the invoice generation job. If the next invoice has already been generated, it will not be updated. Only item types where `isRecurring` is true can be ad…
- [Create a one-time fee for a rental record](https://api.monument.io/api-reference/rental-records/create-a-one-time-fee-for-a-rental-record.md): Creates a one-time fee invoice for the specified rental record using the given fee or service item type.
- [Enable autopay for a unit rental record](https://api.monument.io/api-reference/rental-records/enable-autopay-for-a-unit-rental-record.md): Sets the specified payment profile as the autopay method for a unit rental record.       Validates that the payment profile belongs to the merchant account assigned to the facility       and that the payment profile is associated with the same account as the rental record.       If a previous autopa…
- [Get available fees for a unit rental record](https://api.monument.io/api-reference/rental-records/get-available-fees-for-a-unit-rental-record.md): Retrieves available fee and service item types applicable to the facility, with amounts pre-calculated based on the rental record's current rent.
- [Get gate access code for a unit rental record](https://api.monument.io/api-reference/rental-records/get-gate-access-code-for-a-unit-rental-record.md): Retrieves the gate access code for a unit rental record
- [Get rental records by UUIDs for a facility](https://api.monument.io/api-reference/rental-records/get-rental-records-by-uuids-for-a-facility.md): Retrieves rental record details for the provided array of UUIDs, most recently updated first.
- [Get rental records UUIDs from Facility](https://api.monument.io/api-reference/rental-records/get-rental-records-uuids-from-facility.md): Retrieves the UUIDs of all rental records by facilityUuid, optionally filtered by date, rental record status, amenities, and item types.
- [Remove coverage from a unit rental](https://api.monument.io/api-reference/rental-records/remove-coverage-from-a-unit-rental.md): Ends coverage for a customer, applying a prorated credit memo for their current or future invoices
- [Send payment link to a tenant](https://api.monument.io/api-reference/rental-records/send-payment-link-to-a-tenant.md): Sends a one-off payment link to the primary contact of a unit rental record via email or SMS.
- [Update coverage selection for a unit rental](https://api.monument.io/api-reference/rental-records/update-coverage-selection-for-a-unit-rental.md): Updates coverage to the new selection, ending current coverage for the unit rental, applying a prorated credit memo for their current or future invoices
- [Action to take when a lead is fully filled out and is ready to generate a lease. Will mark a unit in the unit group they've selected as reserved.](https://api.monument.io/api-reference/shoppingapi/action-to-take-when-a-lead-is-fully-filled-out-and-is-ready-to-generate-a-lease-will-mark-a-unit-in-the-unit-group-theyve-selected-as-reserved.md)
- [Authenticates that the verification code matches the one sent to the tenants email. If successful, creates a new lead pre-assocatiated with this tenant.](https://api.monument.io/api-reference/shoppingapi/authenticates-that-the-verification-code-matches-the-one-sent-to-the-tenants-email-if-successful-creates-a-new-lead-pre-assocatiated-with-this-tenant.md)
- [Call when a lead exits the shopping experience, marking them as immediately visible in the FMS.](https://api.monument.io/api-reference/shoppingapi/call-when-a-lead-exits-the-shopping-experience-marking-them-as-immediately-visible-in-the-fms.md)
- [Check if a lead has been converted](https://api.monument.io/api-reference/shoppingapi/check-if-a-lead-has-been-converted.md): Verifies if a lead has been successfully converted to a tenant
- [Checks if a tenant already exists with this email, sends a verfication code to their email they must retrieve if so](https://api.monument.io/api-reference/shoppingapi/checks-if-a-tenant-already-exists-with-this-email-sends-a-verfication-code-to-their-email-they-must-retrieve-if-so.md)
- [Create a new lead](https://api.monument.io/api-reference/shoppingapi/create-a-new-lead.md): Creates a new lead in the system with verification token for authentication
- [Create a payment profile for a lead to use for their initial and future payments](https://api.monument.io/api-reference/shoppingapi/create-a-payment-profile-for-a-lead-to-use-for-their-initial-and-future-payments.md)
- [Generate a shopping cart without a lead](https://api.monument.io/api-reference/shoppingapi/generate-a-shopping-cart-without-a-lead.md): Generates a virtual shopping cart based on facility and unit group data, detached from a lead reference.
- [Get all facilities](https://api.monument.io/api-reference/shoppingapi/get-all-facilities.md): Returns a list of all available facilities in the portfolio
- [Get billing template for a lead](https://api.monument.io/api-reference/shoppingapi/get-billing-template-for-a-lead.md): Retrieves the potential billing template that would be applied to the lead
- [Get branding configuration by brand](https://api.monument.io/api-reference/shoppingapi/get-branding-configuration-by-brand.md): Returns branding configuration for the specified brand organization UUID, with fallback to root organization or first entry
- [Get coverage options for a facility](https://api.monument.io/api-reference/shoppingapi/get-coverage-options-for-a-facility.md): Returns all available coverage options that can be purchased for a specific facility
- [Get details for a converted lead](https://api.monument.io/api-reference/shoppingapi/get-details-for-a-converted-lead.md): Retrieves information about a lead that has been converted to a tenant
- [Get facilities by brand](https://api.monument.io/api-reference/shoppingapi/get-facilities-by-brand.md): Returns a list of all available facilities filtered by brand organization UUID
- [Get facility details](https://api.monument.io/api-reference/shoppingapi/get-facility-details.md): Retrieves detailed information about a specific facility
- [Get Gate Access Code by Lead UUID and Verify Code](https://api.monument.io/api-reference/shoppingapi/get-gate-access-code-by-lead-uuid-and-verify-code.md): Returns the gate access code for a lead once they have been signed their lease and been converted to a tenant. Requires verification token for authentication.
- [Get payment processor information](https://api.monument.io/api-reference/shoppingapi/get-payment-processor-information.md): Retrieves payment processor details needed for payment fields integration
- [Get Payrix public API key](https://api.monument.io/api-reference/shoppingapi/get-payrix-public-api-key.md): Retrieves the temporary public key needed to create payment input fields
- [Get private coverage information](https://api.monument.io/api-reference/shoppingapi/get-private-coverage-information.md): Returns information about the private coverage including provider, website URL, and description
- [Get rental flow configuration for a facility](https://api.monument.io/api-reference/shoppingapi/get-rental-flow-configuration-for-a-facility.md): Returns the rental flow configuration for a specific facility
- [Get tax information for a unit group](https://api.monument.io/api-reference/shoppingapi/get-tax-information-for-a-unit-group.md): Retrieves all applicable taxes and rates for units in the specified unit group
- [Get Unit by Lead UUID and Verify Code](https://api.monument.io/api-reference/shoppingapi/get-unit-by-lead-uuid-and-verify-code.md): Returns the unit details for a lead once they have been signed their lease and been converted to a tenant. Requires verification token for authentication.
- [Get unit group details](https://api.monument.io/api-reference/shoppingapi/get-unit-group-details.md): Retrieves detailed information about a specific unit group, including services available
- [Get unit groups for a facility](https://api.monument.io/api-reference/shoppingapi/get-unit-groups-for-a-facility.md): Returns all unit groups available for rent at the specified facility
- [Retrieve access plans for a facility](https://api.monument.io/api-reference/shoppingapi/retrieve-access-plans-for-a-facility.md): Returns the access plans for the specified facility with all related items.
- [Retrieve payment processor info for a given facility](https://api.monument.io/api-reference/shoppingapi/retrieve-payment-processor-info-for-a-given-facility.md)
- [Retrieve shopping cart for a lead](https://api.monument.io/api-reference/shoppingapi/retrieve-shopping-cart-for-a-lead.md): Returns the shopping cart with all items and related amounts for the specified lead. Requires verification token for authentication.
- [Update lead indicated, setting their personal information, facility, unit group, and services ](https://api.monument.io/api-reference/shoppingapi/update-lead-indicated-setting-their-personal-information-facility-unit-group-and-services.md)
- [Validate lead verification token](https://api.monument.io/api-reference/shoppingapi/validate-lead-verification-token.md): Verifies a lead token and returns the lead's personal information
- [Get Tenant (Account) UUIDs](https://api.monument.io/api-reference/tenants/get-tenant-account-uuids.md): Retrieves the tenant Uuids of all tenant entities, optionally filtered by date.
- [Get tenants by UUIDs](https://api.monument.io/api-reference/tenants/get-tenants-by-uuids.md): Retrieves tenant details for the provided array of accountUuids, most recently updated first.
- [Update Person Email or Phone](https://api.monument.io/api-reference/tenants/update-person-email-or-phone.md): Updates the email or phone number for a person. Phone number must be in format (NPA) NXX-XXXX, NPA-NXX-XXXX, or NPANXXXXXX.
- [Get size-and-type unit group details by UUIDs](https://api.monument.io/api-reference/unit-groups/get-size-and-type-unit-group-details-by-uuids.md): Returns details for specified size-and-type unit groups associated with a facility
- [Get size-and-type unit group UUIDs for a facility](https://api.monument.io/api-reference/unit-groups/get-size-and-type-unit-group-uuids-for-a-facility.md): Retrieves the sizeAndTypeUnitGroupUuids of all size-and-type unit groups in the facility identified by facilityUuid
- [Get unit group details by UUIDs](https://api.monument.io/api-reference/unit-groups/get-unit-group-details-by-uuids.md): Returns details for specified unit groups associated with a facility
- [Get unit group UUIDs for a facility](https://api.monument.io/api-reference/unit-groups/get-unit-group-uuids-for-a-facility.md): Retrieves the unitGroupUuids of all unit groups in the facility identified by facilityUuid
- [Patch unit group rate](https://api.monument.io/api-reference/unit-groups/patch-unit-group-rate.md): Patches the baseWebRate and baseStreetRate of a unit group. The currentStreetRate and currentWebRate will be updated based on the unit group occupancy percentage and rate plan.
- [Patch unit group rate by size and type](https://api.monument.io/api-reference/unit-groups/patch-unit-group-rate-by-size-and-type.md): Resolves the unit group from sizeAndTypeUuid + tierDescription and patches its baseWebRate and baseStreetRate. The currentStreetRate and currentWebRate will be updated based on the unit group occupancy percentage and rate plan.
- [Update units tier](https://api.monument.io/api-reference/unit-groups/update-units-tier.md): Resolves the target unit group from the units' current size and type and the desired tier, then assigns the units.
- [Execute MORA for a unit](https://api.monument.io/api-reference/units/execute-mora-for-a-unit.md): Executes MORA for a unit rental record, causing the rent to be instantly adjusted to the new rent amount.
- [Get unit UUIDs for a facility](https://api.monument.io/api-reference/units/get-unit-uuids-for-a-facility.md): Retrieves the unitUuids of all units in facility identified by facilityUuid
- [Get units by UUIDs](https://api.monument.io/api-reference/units/get-units-by-uuids.md): Retrieves unit details for the provided array of UUIDs within a specific facility, most recently updated first
- [Create webhook subscription](https://api.monument.io/api-reference/webhooks/create-webhook-subscription.md): Creates a webhook subscription for the provided application ID
- [Get webhook portal link](https://api.monument.io/api-reference/webhooks/get-webhook-portal-link.md): Retrieves webhook portal link for the provided application ID
- [Get webhook subscriptions](https://api.monument.io/api-reference/webhooks/get-webhook-subscriptions.md): Retrieves all webhook subscriptions for the provided application ID
- [Send test event](https://api.monument.io/api-reference/webhooks/send-test-event.md): Sends a test event to the provided application ID
- [Unsubscribe from webhook](https://api.monument.io/api-reference/webhooks/unsubscribe-from-webhook.md): Unsubscribes from one or more event types for the provided application ID
- [Update webhook subscription](https://api.monument.io/api-reference/webhooks/update-webhook-subscription.md): Updates a webhook subscription for the provided application ID
- [Integration api](https://api.monument.io/documentation/integration_api.md)
- [Overview](https://api.monument.io/documentation/overview.md)
- [Shopping api](https://api.monument.io/documentation/shopping_api.md)
- [Webhooks](https://api.monument.io/documentation/webhooks.md)

## OpenAPI Specs

- [integration-openapi](https://api.monument.io/openapi/integration-openapi.json)
- [shopping-openapi](https://api.monument.io/openapi/shopping-openapi.json)
- [openapi](https://api.monument.io/openapi/openapi.json)