> ## 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 facility ledger entries by UUIDs

> Retrieves ledger entry details for the provided array of UUIDs within a specific facility, most recently created first



## OpenAPI

````yaml /openapi/integration-openapi.json post /api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/ledgerEntries/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}/ledgerEntries/get_by_uuids:
    post:
      tags:
        - Ledger Entries
      summary: Get facility ledger entries by UUIDs
      description: >-
        Retrieves ledger entry details for the provided array of UUIDs within a
        specific facility, most recently created first
      operationId: PrivateApiLedgerEntriesController_getFacilityLedgerEntriesByUuids
      parameters:
        - name: facilityUuid
          required: true
          in: path
          schema:
            type: string
        - 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/GetLedgerEntriesByUuidsRequestDto'
      responses:
        '200':
          description: Ledger entry details retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LedgerEntryDetailsResponseDto'
        '400':
          description: Bad Request (e.g., Too many uuids, invalid input)
components:
  schemas:
    GetLedgerEntriesByUuidsRequestDto:
      type: object
      properties:
        lineItemLedgerUuids:
          example:
            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
            - 4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e
          description: Array of ledger entry UUIDs to retrieve data for
          type: array
          items:
            type: string
            format: uuid
      required:
        - lineItemLedgerUuids
    LedgerEntryDetailsResponseDto:
      type: object
      properties:
        lineItemLedgerUuid:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: UUID of the ledger entry
        invoiceUuid:
          type: string
          format: uuid
          example: 4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e
          description: UUID of the invoice
        unitRentalRecordUuid:
          type: string
          format: uuid
          example: 5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f
          description: UUID of the rental record associated with this ledger entry
        ledgerEntryItemTypeUuid:
          type: string
          format: uuid
          example: 5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f
          description: UUID of the item type
        ledgerEntryStartDate:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00.000Z'
          description: Start date of the ledger entry service period
        ledgerEntryEndDate:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00.000Z'
          description: End date of the ledger entry service period
        invoiceItemBalance:
          type: number
          example: 15000
          description: Current balance of the invoice item in pennies
        invoiceItemDescription:
          type: string
          nullable: true
          example: Monthly Storage Fee
          description: Description of the invoice item
        invoiceItemOriginalBalance:
          type: number
          nullable: true
          example: 15000
          description: Original balance of the invoice item
        createdAt:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00.000Z'
          description: Date when the ledger entry was created
        invoiceDueDate:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00.000Z'
          description: Invoice due date
        updatedAt:
          type: string
          format: date-time
          example: '2024-01-20T15:45:00.000Z'
          description: Date when the ledger entry was last updated
        transactionType:
          $ref: '#/components/schemas/TransactionType'
          example: INVOICE
        itemTypeCategory:
          type: string
          nullable: true
          example: COVERAGE
          description: >-
            Category of the item type linked to the invoice item. Null if the
            invoice item has no linked item type.
        invoiceStatus:
          $ref: '#/components/schemas/InvoiceStatus'
          example: OPEN
      required:
        - lineItemLedgerUuid
        - invoiceUuid
        - unitRentalRecordUuid
        - ledgerEntryItemTypeUuid
        - ledgerEntryStartDate
        - ledgerEntryEndDate
        - invoiceItemBalance
        - invoiceItemDescription
        - invoiceItemOriginalBalance
        - createdAt
        - invoiceDueDate
        - updatedAt
        - transactionType
        - itemTypeCategory
        - invoiceStatus
    TransactionType:
      type: string
      description: Type of transaction for this ledger entry
      enum:
        - 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
    InvoiceStatus:
      type: string
      description: Status of the invoice this ledger entry belongs to
      enum:
        - OPEN
        - OVERDUE
        - PARTIAL
        - PAID
        - VOID
        - WRITTEN_OFF

````