openapi: 3.2.0
info:
  title: DoorLoop API Reference Lease Payments API
  version: '1.0'
  summary: This is the DoorLoop API
  description: It does some pretty cool stuff and gives you complete access to DoorLoop's data
  license:
    name: Terms and Conditions
    url: https://www.doorloop.com/legal/terms
  contact:
    name: DoorLoop Inc.
    url: www.doorloop.com
    email: support@doorloop.com
  termsOfService: https://www.doorloop.com/legal/terms
servers:
- url: https://app.doorloop.com/api
  description: Production
tags:
- name: Lease Payments
paths:
  /lease-payments:
    parameters: []
    get:
      summary: List all Lease Payments
      tags:
      - Lease Payments
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: number
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/leasePayment'
              examples: {}
            application/xml:
              schema:
                type: object
                properties: {}
            multipart/form-data:
              schema:
                type: object
                properties: {}
        '400':
          description: Bad Request
      operationId: get-lease-payments
      description: Lists all Lease Payments
      parameters:
      - schema:
          type: string
        in: query
        name: filter_lease
        description: Filter by Lease Id
      - schema:
          type: string
        in: query
        name: filter_property
        description: Filter by Property Id
      - schema:
          $ref: '#/components/schemas/paymentMethods'
        in: query
        name: filter_paymentMethod
        description: Filter by Payment Method
      - schema:
          type: string
        in: query
        name: filter_owner
        description: Filter by Owner Id
      - schema:
          type: string
        in: query
        name: filter_date_from
        description: Filter by Date (YYYY-MM-DD)
      - schema:
          type: string
        in: query
        name: filter_date_to
        description: Filter by Date (YYYY-MM-DD)
      security:
      - Key: []
    post:
      summary: Create a Lease Payment
      operationId: post-lease-payment
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/leasePayment'
        '400':
          description: Bad Request
      description: Creates a Lease Payment
      security:
      - Key: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/leasePayment'
      tags:
      - Lease Payments
  /lease-payments/{leasePaymentId}:
    parameters:
    - schema:
        type: string
      name: leasePaymentId
      in: path
      required: true
      description: The Lease Payment Id
    get:
      summary: Retrieve a Lease Payment
      tags:
      - Lease Payments
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/leasePayment'
              examples: {}
            application/xml:
              schema:
                type: object
                properties: {}
            multipart/form-data:
              schema:
                type: object
                properties: {}
        '404':
          description: Not Found
      operationId: get-lease-payment
      description: Retrieves a Lease Payment
      parameters: []
      security:
      - Key: []
    put:
      summary: Update a Lease Payment
      operationId: put-lease-payment
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/leasePayment'
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      description: Updates a Lease Payment
      security:
      - Key: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/leasePayment'
      tags:
      - Lease Payments
    delete:
      summary: Delete a Lease Payment
      operationId: delete-lease-payment
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/leasePayment'
        '400':
          description: Bad Request
        '404':
          description: Not Found
      tags:
      - Lease Payments
      description: Deletes a Lease Payment
      security:
      - Key: []
components:
  schemas:
    mongoId:
      type: string
      title: mongoId
      x-stoplight:
        id: 40j7qlmpihfdj
      pattern: /^[a-f\d]{24}$/i
      examples:
      - 507f191e810c19729de860ea
      example: 00000020f51bb4362eee2a4d
    leasePayment:
      title: Lease-Payment
      x-stoplight:
        id: mb48r0rwi1kp0
      type: object
      properties:
        id:
          $ref: '#/components/schemas/mongoId'
        reference:
          type: string
        amountReceived:
          type: number
          example: 1000.5
        paymentMethod:
          $ref: '#/components/schemas/paymentMethods'
        lease:
          $ref: '#/components/schemas/mongoId'
        receivedFromTenant:
          $ref: '#/components/schemas/mongoId'
        depositToAccount:
          $ref: '#/components/schemas/mongoId'
        autoApplyPaymentOnCharges:
          type: boolean
        autoDeposit:
          type: boolean
        depositStatus:
          type: string
          enum:
          - DEPOSITED
          - UNDEPOSITED
          description: Read Only
        reversedPayment:
          type: string
          description: If this payment was returned, will reference the returned payment
        date:
          type: string
          description: Transaction date (YYYY-MM-DD)
        linkedCharges:
          type: array
          readOnly: true
          description: Charges this payment was applied against, with the amount applied to each. Populated whether the application was automatic (autoApplyPaymentOnCharges) or manual.
          items:
            type: object
            properties:
              linkedTransaction:
                $ref: '#/components/schemas/mongoId'
              amount:
                type: number
        linkedCredits:
          type: array
          readOnly: true
          description: Credits this payment was applied against, with the amount applied to each
          items:
            type: object
            properties:
              linkedTransaction:
                $ref: '#/components/schemas/mongoId'
              amount:
                type: number
        amountAppliedToCharges:
          type: number
          readOnly: true
        amountAppliedToCredits:
          type: number
          readOnly: true
        amountNotAppliedToCharges:
          type: number
          readOnly: true
        ePayInfo:
          type: object
          readOnly: true
          description: 'Present for payments processed by DoorLoop. method is the only way to distinguish a card payment from a bank payment - paymentMethod: EPAY covers both rails.'
          properties:
            method:
              type: string
              enum:
              - CARD
              - ECHECK
              - WESTERN_UNION_CASH
            status:
              type: string
              enum:
              - PROCESSING
              - SUCCEEDED
              - PENDING_REVIEW
              - FAILED
              - DISPUTED
              - REFUNDED
              - IN_TRANSIT
              - PAID
        paymentOrigin:
          type: string
          readOnly: true
          description: Where the payment was initiated from
        depositEntry:
          allOf:
          - $ref: '#/components/schemas/mongoId'
          readOnly: true
          description: The deposit journal entry this payment belongs to, if any. depositStatus is derived from its presence rather than being set directly.
        isDepositPayment:
          type: boolean
          readOnly: true
      required:
      - amountReceived
      - paymentMethod
      - lease
      - depositToAccount
      - autoApplyPaymentOnCharges
    paymentMethods:
      type: string
      enum:
      - CASH
      - CHECK
      - CREDIT_CARD
      - CASHIERS_CHECK
      - MONEY_ORDER
      - EFT
      - DEBIT_CARD
      - OTHER
      - EPAY
      description: Lists all possible payment methods that can be used in payable and receivable transactions. Use EFT to record an electronic funds transfer that was collected outside DoorLoop. EPAY is reserved for payments processed through DoorLoop's own merchant account and requires a nested ePayInfo object.
  securitySchemes:
    Key:
      type: apiKey
      in: header
      name: Authorization
      description: 'Bearer token. Create a key under Settings -> API access; it is a JWT. Example: `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.<payload>.<signature>`'
x-stoplight:
  id: cz75kvx8cjg25
x-provenance:
  method: searched
  source: https://api.doorloop.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://api.doorloop.com/reference/delete-account.md
  - https://api.doorloop.com/reference/delete-communication.md
  - https://api.doorloop.com/reference/delete-expense.md
  - https://api.doorloop.com/reference/delete-file.md
  - https://api.doorloop.com/reference/delete-lease-charge.md
  - https://api.doorloop.com/reference/delete-lease-credits-leasecreditid.md
  - https://api.doorloop.com/reference/delete-lease-payment.md
  - https://api.doorloop.com/reference/delete-lease-reversed-payment.md
  - https://api.doorloop.com/reference/delete-note.md
  - https://api.doorloop.com/reference/delete-owner.md
  - https://api.doorloop.com/reference/delete-task.md
  - https://api.doorloop.com/reference/delete-tenant.md
  - https://api.doorloop.com/reference/delete-vendor-bill.md
  - https://api.doorloop.com/reference/delete-vendor-credit.md
  - https://api.doorloop.com/reference/delete-vendor.md
  - https://api.doorloop.com/reference/download-file.md
  - https://api.doorloop.com/reference/get-account.md
  - https://api.doorloop.com/reference/get-accounts.md
  - https://api.doorloop.com/reference/get-communication.md
  - https://api.doorloop.com/reference/get-communications.md
  - https://api.doorloop.com/reference/get-current-user.md
  - https://api.doorloop.com/reference/get-expense.md
  - https://api.doorloop.com/reference/get-expenses.md
  - https://api.doorloop.com/reference/get-file.md
  - https://api.doorloop.com/reference/get-files.md
  - https://api.doorloop.com/reference/get-lease-charge.md
  - https://api.doorloop.com/reference/get-lease-charges.md
  - https://api.doorloop.com/reference/get-lease-credit.md
  - https://api.doorloop.com/reference/get-lease-credits.md
  - https://api.doorloop.com/reference/get-lease-payment.md
  - https://api.doorloop.com/reference/get-lease-payments.md
  - https://api.doorloop.com/reference/get-lease-reversed-payment.md
  - https://api.doorloop.com/reference/get-lease-reversed-payments.md
  - https://api.doorloop.com/reference/get-lease-tenants.md
  - https://api.doorloop.com/reference/get-lease.md
  - https://api.doorloop.com/reference/get-leases.md
  - https://api.doorloop.com/reference/get-note.md
  - https://api.doorloop.com/reference/get-notes.md
  - https://api.doorloop.com/reference/get-owner.md
  - https://api.doorloop.com/reference/get-owners.md
  - https://api.doorloop.com/reference/get-properties.md
  - https://api.doorloop.com/reference/get-property-group.md
  - https://api.doorloop.com/reference/get-property-groups.md
  - https://api.doorloop.com/reference/get-property.md
  - https://api.doorloop.com/reference/get-reports-balance-sheet.md
  - https://api.doorloop.com/reference/get-reports-cash-flow-statement.md
  - https://api.doorloop.com/reference/get-reports-profit-and-loss.md
  - https://api.doorloop.com/reference/get-reports-rent-roll.md
  - https://api.doorloop.com/reference/get-task.md
  - https://api.doorloop.com/reference/get-tasks.md
  - https://api.doorloop.com/reference/get-tenant.md
  - https://api.doorloop.com/reference/get-tenants.md
  - https://api.doorloop.com/reference/get-unit.md
  - https://api.doorloop.com/reference/get-units.md
  - https://api.doorloop.com/reference/get-user.md
  - https://api.doorloop.com/reference/get-users.md
  - https://api.doorloop.com/reference/get-vendor-bill.md
  - https://api.doorloop.com/reference/get-vendor-bills.md
  - https://api.doorloop.com/reference/get-vendor-credit.md
  - https://api.doorloop.com/reference/get-vendor-credits.md
  - https://api.doorloop.com/reference/get-vendor.md
  - https://api.doorloop.com/reference/get-vendors.md
  - https://api.doorloop.com/reference/post-account.md
  - https://api.doorloop.com/reference/post-communication.md
  - https://api.doorloop.com/reference/post-expense.md
  - https://api.doorloop.com/reference/post-files.md
  - https://api.doorloop.com/reference/post-lease-charge.md
  - https://api.doorloop.com/reference/post-lease-credit.md
  - https://api.doorloop.com/reference/post-lease-payment.md
  - https://api.doorloop.com/reference/post-lease-reversed-payments.md
  - https://api.doorloop.com/reference/post-leases-full.md
  - https://api.doorloop.com/reference/post-leases-move-in.md
  - https://api.doorloop.com/reference/post-leases-move-out.md
  - https://api.doorloop.com/reference/post-notes.md
  - https://api.doorloop.com/reference/post-owner.md
  - https://api.doorloop.com/reference/post-task-update.md
  - https://api.doorloop.com/reference/post-task.md
  - https://api.doorloop.com/reference/post-tenant.md
  - https://api.doorloop.com/reference/post-vendor-bill.md
  - https://api.doorloop.com/reference/post-vendor-credit.md
  - https://api.doorloop.com/reference/post-vendor.md
  - https://api.doorloop.com/reference/put-account.md
  - https://api.doorloop.com/reference/put-communication.md
  - https://api.doorloop.com/reference/put-expense.md
  - https://api.doorloop.com/reference/put-file.md
  - https://api.doorloop.com/reference/put-lease-charge.md
  - https://api.doorloop.com/reference/put-lease-credit.md
  - https://api.doorloop.com/reference/put-lease-payment.md
  - https://api.doorloop.com/reference/put-note.md
  - https://api.doorloop.com/reference/put-owner.md
  - https://api.doorloop.com/reference/put-task.md
  - https://api.doorloop.com/reference/put-tenant.md
  - https://api.doorloop.com/reference/put-unit.md
  - https://api.doorloop.com/reference/put-vendor-bill.md
  - https://api.doorloop.com/reference/put-vendor-credit.md
  - https://api.doorloop.com/reference/put-vendor.md
  merge:
    pages: 96
    deduped: 446
    conflicts_kept_first: 0