> ## Documentation Index
> Fetch the complete documentation index at: https://api.monument.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get rental records by UUIDs for a facility

> Retrieves rental record details for the provided array of UUIDs, most recently updated first.



## OpenAPI

````yaml /openapi/integration-openapi.json post /api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids
openapi: 3.0.0
info:
  title: Monument Integration API
  description: Monument Integration API
  version: '1.0'
  contact: {}
servers:
  - url: https://public-api.prd.monument.io
    description: Production
  - url: https://public-api.stg.monument.io
    description: Staging
security: []
tags:
  - name: Portfolios
    description: List portfolios accessible to the API key
  - name: Facilities
    description: Facility retrieval and coverage-option configuration
  - name: Units
    description: Unit listing and MORA execution
  - name: Unit Groups
    description: Unit group listing, rate management, and unit assignment
  - name: Rental Records
    description: Rental record listing, coverage, fees, autopay, and payment links
  - name: Ledger Entries
    description: Ledger entry retrieval at facility and rental-record level
  - name: Leads
    description: Lead listing and lease sending
  - name: Tasks
    description: Task creation and listing for integrations
  - name: Tenants
    description: Tenant listing and person updates
  - name: People
    description: Person listing
  - name: Notes
    description: Note listing and creation for tenants and leads
  - name: Auctions
    description: Auction listing
  - name: Coverage
    description: Portfolio-level coverage CRUD and coverage history
  - name: Summary
    description: Portfolio-level aggregate summaries (insurance enrollment/occupancy)
  - name: Promotions
    description: Promotion listing
  - name: ECRI
    description: Effective Current Rent Increase scheduling
  - name: Item Types
    description: Item type listing per facility
  - name: Delinquencies
    description: Delinquency listing per facility
  - name: Physical Locks
    description: Physical lock assignment and unassignment
  - name: Lead Source Options
    description: Lead source option listing
  - name: Webhooks
    description: Webhook subscription management
  - name: Payments
    description: Payment profile creation
paths:
  /api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/get_by_uuids:
    post:
      tags:
        - Rental Records
      summary: Get rental records by UUIDs for a facility
      description: >-
        Retrieves rental record details for the provided array of UUIDs, most
        recently updated first.
      operationId: FacilityRentalRecordsController_getRentalRecordsDataByUuids
      parameters:
        - name: facilityUuid
          required: true
          in: path
          schema:
            type: string
        - name: expand[lastPayment][]
          required: false
          in: query
          description: 'Bracket notation: include last payment (e.g. ?expand[lastPayment][])'
          schema: {}
        - name: expand[paymentProfile][]
          required: false
          in: query
          description: >-
            Bracket notation: include payment profile (e.g.
            ?expand[paymentProfile][])
          schema: {}
        - in: path
          required: true
          name: portfolio
          schema:
            example: abc_selfstorage
        - in: header
          required: true
          name: x-api-key
          schema:
            example: monument-2230012-2312321
            description: >-
              Api key required to authenticate your request. Please reach out to
              monument for a key.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetRentalRecordsByUuidsDto'
      responses:
        '200':
          description: Successfully retrieved rental records data
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GetRentalRecordsDataResponseDto'
components:
  schemas:
    GetRentalRecordsByUuidsDto:
      type: object
      properties:
        unitRentalRecordUuids:
          example:
            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
            - 3fa85f64-5717-4562-b3fc-2c963f66afa7
          description: Array of unit rental record UUIDs to retrieve data for
          type: array
          items:
            type: string
            format: uuid
      required:
        - unitRentalRecordUuids
    GetRentalRecordsDataResponseDto:
      type: object
      properties:
        unitUuid:
          type: string
          format: uuid
          example: 2a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d
          description: Unit UUID associated with this rental record
        facilityUuid:
          type: string
          format: uuid
          example: 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
          description: Facility UUID where the unit is located
        rentalRecordUuid:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: Rental record UUID
        tenantUuid:
          type: string
          format: uuid
          example: 4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e
          description: Tenant UUID associated with this rental record
        tenantStatus:
          type: string
          enum:
            - PENDING_ACTIVATION
            - ACTIVE
            - PENDING_DEACTIVATION
            - DEACTIVATED
          example: ACTIVE
          description: Tenant status associated with this rental record
        isAutopayEnabled:
          type: boolean
          example: true
          description: Whether the rental record currently has autopay enabled
        status:
          type: string
          example: MOVED_IN
          description: Current status of the rental record
        balance:
          type: number
          example: 12500
          description: Current balance on the rental record in pennies
        paidThroughDate:
          type: string
          nullable: true
          format: date
          example: '2024-01-15'
          description: Date when the rental record is paid through
        startDate:
          type: string
          format: date
          example: '2024-01-15'
          description: Start date of the rental agreement
        endDate:
          type: string
          nullable: true
          format: date
          example: null
          description: End date of the rental agreement (null if ongoing)
        createdAt:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00.000Z'
          description: Timestamp when the rental record was created
        updatedAt:
          type: string
          format: date-time
          example: '2024-01-20T15:45:00.000Z'
          description: Timestamp when the rental record was last updated
        delinquent:
          type: boolean
          example: false
          description: Whether the rental record is currently delinquent
        currentCoveragePartnerId:
          type: string
          nullable: true
          example: COVERAGE_PARTNER_123
          description: Current coverage partner ID (null if no coverage)
        coverageUuid:
          type: string
          nullable: true
          format: uuid
          example: 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
          description: >-
            UUID of the coverage. For private coverage, this will be the private
            coverage UUID: 11111111-1111-1111-1111-111111111111
        billingDayOfMonth:
          type: number
          example: 15
          description: Day of month when billing occurs
        balanceAge:
          type: number
          example: 5
          description: >-
            Age of balance in 24-hour increments since oldest
            open/partial/overdue invoice
        unitBlockedAccessDate:
          type: string
          nullable: true
          format: date
          example: '2024-01-15T10:30:00.000Z'
          description: Date when the unit was blocked from access
        facilityBlockedAccessDate:
          type: string
          nullable: true
          format: date
          example: '2024-01-15T10:30:00.000Z'
          description: Date when the facility was blocked from access
        delinquencyStatus:
          type: string
          nullable: true
          example: OVERDUE
          description: Delinquency status if there is an active delinquency, null otherwise
        desiredMoveOutDate:
          type: string
          nullable: true
          format: date
          example: '2024-12-31'
          description: Desired move-out date for the tenant (null if not specified)
        nextRentInPennies:
          type: number
          nullable: true
          example: 16000
          description: Next scheduled rent amount in pennies
        nextRentChangeDate:
          type: string
          nullable: true
          format: date
          example: '2025-02-01'
          description: Date when the next rent amount becomes effective
        previousRentInPennies:
          type: number
          nullable: true
          example: 14000
          description: Previous rent amount in pennies
        previousRentChangeDate:
          type: string
          nullable: true
          format: date
          example: '2024-06-01'
          description: Date when the previous rent amount changed
        billingTemplate:
          nullable: true
          description: Billing template information for this rental record
          allOf:
            - $ref: '#/components/schemas/BillingTemplateDto'
        primaryContact:
          description: 'Contact details for the '
          allOf:
            - $ref: '#/components/schemas/ContactDto'
        alternateContacts:
          description: Contact details for the alternate contacts
          type: array
          items:
            $ref: '#/components/schemas/ContactDto'
        businessName:
          type: string
          nullable: true
          example: Acme Storage LLC
          description: Business name (populated for BUSINESS accounts, null for PERSONAL)
        accountOwedBalance:
          type: number
          example: 25000
          description: >-
            Sum of all positive balances across the tenant's entire account (in
            pennies)
        unitNumber:
          type: string
          description: Unit number
          example: A101
        unitStatus:
          type: string
          enum:
            - VACANT
            - RESERVED
            - OCCUPIED
            - UNRENTABLE
            - OWNER OCCUPIED
            - PENDING_SIGNATURE
          example: VACANT
          description: Unit occupancy status
        paymentProfile:
          description: >-
            Included when ?expand[paymentProfile][] is present; autopay payment
            profile for this rental record
          type: array
          items:
            $ref: '#/components/schemas/GetPaymentProfileDataResponseDto'
        lastPayment:
          nullable: true
          description: >-
            Included when ?expand[lastPayment][] is present; most recent payment
            for this rental record
          allOf:
            - $ref: '#/components/schemas/LastPaymentDto'
      required:
        - unitUuid
        - facilityUuid
        - rentalRecordUuid
        - tenantUuid
        - tenantStatus
        - isAutopayEnabled
        - status
        - balance
        - paidThroughDate
        - startDate
        - endDate
        - createdAt
        - updatedAt
        - delinquent
        - currentCoveragePartnerId
        - coverageUuid
        - billingDayOfMonth
        - balanceAge
        - unitBlockedAccessDate
        - facilityBlockedAccessDate
        - delinquencyStatus
        - desiredMoveOutDate
        - nextRentInPennies
        - nextRentChangeDate
        - previousRentInPennies
        - previousRentChangeDate
        - billingTemplate
        - primaryContact
        - alternateContacts
        - accountOwedBalance
        - unitNumber
        - unitStatus
    BillingTemplateDto:
      type: object
      properties:
        currentRentInPennies:
          type: number
          nullable: true
          example: 15000
          description: >-
            Current rent amount in pennies for active rental records, null for
            inactive
        additionalServicesAndFees:
          description: List of additional services and fees applied to this rental
          type: array
          items:
            $ref: '#/components/schemas/AdditionalServiceAndFeeDto'
        promotions:
          description: >-
            List of all promotions assigned to this rental, including archived.
            Use isArchived to filter active ones.
          type: array
          items:
            $ref: '#/components/schemas/PromotionDto'
        billingDayOfMonth:
          type: number
          example: 15
          description: Day of the month when rent is due
        nextDueDate:
          type: string
          nullable: true
          format: date
          example: '2024-02-15'
          description: Next due date for billing
      required:
        - currentRentInPennies
        - additionalServicesAndFees
        - promotions
        - billingDayOfMonth
        - nextDueDate
    ContactDto:
      type: object
      properties:
        firstName:
          type: string
          nullable: true
          example: Jane
          description: Contact's first name
        lastName:
          type: string
          nullable: true
          example: Doe
          description: Contact's last name
        address1:
          type: string
          nullable: true
          example: 123 Main St
          description: Contact's address line 1
        address2:
          type: string
          nullable: true
          example: Apt 4B
          description: Contact's address line 2
        city:
          type: string
          nullable: true
          example: Anytown
          description: Contact's city
        state:
          type: string
          nullable: true
          maxLength: 2
          example: CA
          description: Contact's state
        zipcode:
          type: string
          nullable: true
          maxLength: 10
          example: '90210'
          description: Contact's zip code
        email:
          type: string
          nullable: true
          example: jane.doe@example.com
          description: Contact's email address
        phone:
          type: string
          nullable: true
          example: '+15551234567'
          description: Contact's phone number
        optedIntoSms:
          type: boolean
          nullable: true
          example: true
          description: Whether the contact has opted into SMS
        dateOfBirth:
          type: string
          nullable: true
          example: '2024-01-01'
          description: Date of birth
    GetPaymentProfileDataResponseDto:
      type: object
      properties:
        paymentProfileUuid:
          type: string
          format: uuid
          example: 1-1-1-1-1
          description: Payment profile UUID
        accountType:
          $ref: '#/components/schemas/ProcessorPaymentType'
          example: ACH
        creditCardBrand:
          type: string
          example: Visa
          description: Credit card brand
        lastFour:
          type: string
          example: '4444'
          description: Last four digits of the credit card
        expirationDate:
          type: string
          format: MM/YYYY
          example: 01/2025
          description: Expiration date of the credit card
        lastPaymentStatus:
          type: string
          example: SUCCESS
          description: Status of the last payment attempt
      required:
        - paymentProfileUuid
        - accountType
        - creditCardBrand
        - lastFour
        - expirationDate
        - lastPaymentStatus
    LastPaymentDto:
      type: object
      properties:
        lastPaymentDate:
          type: string
          format: date-time
          description: Date of the most recent payment
        lastPaymentAmountInPennies:
          type: number
          example: 5000
          description: Amount of most recent payment in pennies
      required:
        - lastPaymentDate
        - lastPaymentAmountInPennies
    AdditionalServiceAndFeeDto:
      type: object
      properties:
        description:
          type: string
          example: Climate Control Service
          description: Description of the additional service or fee
        amountInPennies:
          type: number
          example: 2500
          description: Amount in pennies for this service or fee
        itemTypeUuid:
          type: string
          format: uuid
          example: 5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f
          description: Item type UUID
        category:
          type: string
          example: SERVICE
          description: Category of the item
        taxAmountInPennies:
          type: number
          example: 200
          description: Tax amount in pennies
      required:
        - description
        - amountInPennies
        - itemTypeUuid
        - category
        - taxAmountInPennies
    PromotionDto:
      type: object
      properties:
        promotionUuid:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: UUID of the promotion definition
        discountType:
          type: string
          example: PERCENTAGE
          description: Type of discount (FIXED_AMOUNT or PERCENTAGE)
        fixedDiscountAmountInPennies:
          type: number
          nullable: true
          example: 5000
          description: Fixed discount amount in pennies (null if percentage discount)
        discountPercentage:
          type: number
          nullable: true
          example: 10.5
          description: Discount percentage as decimal (null if fixed discount)
        promotionName:
          type: string
          example: First Month 50% Off
          description: Name of the promotion
        discountAmountType:
          type: string
          example: OFF_RENT
          description: >-
            How the discount amount is applied (OFF_RENT, FIXED_RENT, or
            DETERMINED_WHEN_APPLIED)
        startPromotionDate:
          type: string
          nullable: true
          format: date
          example: '2025-03-01'
          description: Date the discount starts applying
        durationInMonths:
          type: number
          nullable: true
          example: 3
          description: Number of months the promotion applies (null = permanent)
        monthStarts:
          type: number
          nullable: true
          example: 0
          description: Which billing month to start on (0 = move-in invoice)
        dateCreated:
          type: string
          format: date-time
          example: '2025-02-28T15:30:00.000Z'
          description: When the promotion was assigned to the lease
        dateArchived:
          type: string
          nullable: true
          format: date-time
          example: null
          description: When the promotion was removed (null if still active)
        isArchived:
          type: boolean
          example: false
          description: Whether the promotion has been removed from the lease
      required:
        - promotionUuid
        - discountType
        - fixedDiscountAmountInPennies
        - discountPercentage
        - promotionName
        - discountAmountType
        - startPromotionDate
        - durationInMonths
        - monthStarts
        - dateCreated
        - dateArchived
        - isArchived
    ProcessorPaymentType:
      type: string
      enum:
        - CREDIT/DEBIT
        - ACH

````