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

# Get accounts receivable invoices

> Get a paginated list of accounts receivable invoices.



## OpenAPI

````yaml get /v1/accounts-receivable
openapi: 3.0.0
info:
  title: ibana public api
  description: Public API for ibana
  version: 1.0.0
  contact:
    name: ibana
    url: https://ibana.io
    email: dev@ibana.io
servers:
  - url: http://localhost:3001
security: []
tags: []
paths:
  /v1/accounts-receivable:
    get:
      tags:
        - Accounts Receivable
      summary: Get accounts receivable invoices
      description: Get a paginated list of accounts receivable invoices.
      operationId: AccountsReceivableController_getARInvoices_v1
      parameters:
        - name: searchTerm
          required: false
          in: query
          description: The search term to look for in the invoice list.
          schema:
            type: string
        - name: status
          required: false
          in: query
          description: Filter invoices by status.
          schema:
            type: string
        - name: counterpartyIds
          required: false
          in: query
          description: Filter invoices by their counterparty ids.
          schema:
            type: string
        - name: dateFrom
          required: false
          in: query
          description: Filter invoices dates from
          schema:
            type: string
        - name: dateTo
          required: false
          in: query
          description: Filter invoices dates to
          schema:
            type: string
        - name: dateField
          required: false
          in: query
          description: >-
            Date field to use for date filtering (invoice date or due/payment
            date).
          schema:
            default: invoice_date
            type: string
            enum:
              - invoice_date
              - due_payment_date
        - name: dueFrom
          required: false
          in: query
          description: Filter invoices due date from
          schema:
            type: string
        - name: dueTo
          required: false
          in: query
          description: Filter invoices due date to
          schema:
            type: string
        - name: paidDateFrom
          required: false
          in: query
          description: Filter invoices paid date from (when they were paid)
          schema:
            type: string
        - name: paidDateTo
          required: false
          in: query
          description: Filter invoices paid date to (when they were paid)
          schema:
            type: string
        - name: skontoFrom
          required: false
          in: query
          description: Filter invoices skonto date from
          schema:
            type: string
        - name: skontoTo
          required: false
          in: query
          description: Filter invoices skonto date to
          schema:
            type: string
        - name: invoiceTypes
          required: false
          in: query
          description: Filter invoices by type (invoice, credit note).
          schema:
            type: string
        - name: lastReminderTemplateIds
          required: false
          in: query
          description: Filter invoices by last reminder template IDs.
          schema:
            type: string
        - name: inCaseOfLawStatuses
          required: false
          in: query
          description: Filter invoices by In case of law claim status.
          schema:
            type: string
        - name: orderField
          required: false
          in: query
          description: Specify the field you want to order by.
          schema:
            type: string
        - name: orderDir
          required: false
          in: query
          description: Choose between ascending and descending order.
          schema:
            type: string
        - name: order
          required: false
          in: query
          description: Choose between ascending and descending order.
          schema:
            default: ASC
            type: string
            enum:
              - ASC
              - DESC
        - name: page
          required: false
          in: query
          description: Specify the number of the page you want to retrieve.
          schema:
            minimum: 1
            default: 1
            type: number
        - name: take
          required: false
          in: query
          description: Specify the number of items you want to retrieve per page.
          schema:
            minimum: 1
            maximum: 100
            default: 10
            type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PageDto'
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/AccountsReceivableResponseDto'
      security:
        - bearer: []
components:
  schemas:
    PageDto:
      type: object
      properties:
        data:
          description: Paginated items.
          type: array
          items:
            type: object
        meta:
          description: Additional information about the page.
          allOf:
            - $ref: '#/components/schemas/PageMetaDto'
      required:
        - data
        - meta
    AccountsReceivableResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the entity.
        createdAt:
          format: date-time
          type: string
          description: The date and time the entity was created.
        updatedAt:
          format: date-time
          type: string
          description: The date and time the entity was last updated.
        originalFileName:
          type: string
          description: Original name of the uploaded invoice file.
        filename:
          type: string
          description: Stored filename of the invoice document.
        counterpartyName:
          type: string
          description: Name of the counterparty extracted from OCR scan.
        counterpartyIban:
          type: string
          description: IBAN of the counterparty extracted from OCR scan.
        counterpartyVat:
          type: string
          description: VAT number of the counterparty extracted from OCR scan.
        counterparty:
          description: Details of the selected or detected invoice counterparty.
          allOf:
            - $ref: '#/components/schemas/ShallowCounterpartyResponseDto'
        invoiceNumber:
          type: string
          description: Unique identifier or number of the invoice.
        purchaseOrder:
          type: string
          description: Purchase order number associated with the invoice.
        date:
          type: string
          description: Issuance date of the invoice.
        billingPeriodStart:
          type: string
          description: Start date of the billing period.
        billingPeriodEnd:
          type: string
          description: End date of the billing period.
        dueDate:
          type: string
          description: Due date for invoice payment.
        totalAmount:
          type: number
          description: Total invoice amount excluding taxes.
        taxRate:
          type: number
          description: Tax rate applied to the invoice.
        skontoDate:
          type: string
          description: Date when early payment discount is applicable until.
        skontoAmount:
          type: number
          description: Early payment discount amount.
        skontoRate:
          type: number
          description: Early payment discount rate as a percentage.
        currency:
          type: string
          enum:
            - EUR
            - USD
            - GBP
            - JPY
            - AUD
            - CAD
            - CHF
            - CNY
            - HKD
            - NZD
            - SEK
            - KRW
            - SGD
            - NOK
            - MXN
            - INR
            - BRL
            - RUB
            - ZAR
            - TRY
            - AED
            - THB
            - DKK
            - HUF
            - PLN
            - TWD
            - SAR
            - MYR
            - IDR
          default: EUR
          description: Currency of the invoice amount.
        type:
          type: string
          enum:
            - INVOICE
            - CREDIT_NOTE
            - REMINDER
          default: INVOICE
          description: Type of the invoice (e.g., Invoice, Credit Note).
        category:
          type: string
          enum:
            - GOODS
            - SERVICES
          description: Category of the invoice (GOODS or SERVICES).
        paymentTerms:
          type: string
          description: Payment terms for the invoice.
        notes:
          type: string
          description: Additional notes or comments for the invoice.
        alreadyPaid:
          type: boolean
          description: Whether the invoice has been marked as already paid.
        alreadyPaidDate:
          type: string
          description: Date when the invoice was marked as already paid.
        archived:
          type: boolean
          description: Whether the invoice has been archived.
        archivedDate:
          type: string
          description: Date when the invoice was archived.
        archivedByUser:
          description: User who archived the invoice.
          allOf:
            - $ref: '#/components/schemas/ShallowUserResponseDto'
        organization:
          description: Organization associated with the invoice.
          allOf:
            - $ref: '#/components/schemas/OrganizationResponseDto'
        status:
          type: string
          enum:
            - OUTSTANDING
            - PARTIALLY_PAID
            - PAID
            - CANCELED
          default: OUTSTANDING
          description: >-
            Current status of the AR invoice (e.g., Outstanding, Paid,
            Canceled).
        paymentMethodType:
          type: string
          enum:
            - BANK_TRANSFER
            - DIRECT_DEBIT
            - CARD
            - CASH
            - OTHER
          description: Payment method type for the invoice.
        transactionMatches:
          description: Bank transaction matches for payment tracking.
          type: array
          items:
            $ref: '#/components/schemas/BankTransactionARInvoiceMatchResponseDto'
        manuallyMarkedPaid:
          type: boolean
          description: Whether the invoice was manually marked as paid.
        manuallyMarkedPaidAt:
          type: string
          description: Date when the invoice was manually marked as paid.
        manuallyMarkedPaidBy:
          description: User who manually marked the invoice as paid.
          allOf:
            - $ref: '#/components/schemas/ShallowUserResponseDto'
        matchedTransactionsSum:
          type: number
          description: Sum of all matched transaction amounts for partial payments.
        inCaseOfLawClaim:
          description: In case of law claim summary for this AR invoice.
          allOf:
            - $ref: >-
                #/components/schemas/AccountsReceivableInCaseOfLawClaimResponseDto
      required:
        - currency
        - type
        - alreadyPaid
        - archived
        - organization
        - status
        - manuallyMarkedPaid
    PageMetaDto:
      type: object
      properties:
        page:
          type: number
          description: Specify the number of the page you want to retrieve.
        take:
          type: number
          description: Specify the number of items you want to retrieve per page.
        itemCount:
          type: number
          description: Total number of items.
        pageCount:
          type: number
          description: Total number of pages.
        hasPreviousPage:
          type: boolean
          description: Whether there is a previous page.
        hasNextPage:
          type: boolean
          description: Whether there is a next page.
      required:
        - page
        - take
        - itemCount
        - pageCount
        - hasPreviousPage
        - hasNextPage
    ShallowCounterpartyResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the entity.
        createdAt:
          format: date-time
          type: string
          description: The date and time the entity was created.
        updatedAt:
          format: date-time
          type: string
          description: The date and time the entity was last updated.
        email:
          type: string
          description: The email of the counterparty.
        description:
          type: string
          description: The description of the counterparty.
        vat:
          type: string
          description: The EU VAT number of the counterparty.
        accountsPayableNumber:
          type: string
          example: 22 0391919
          description: Accounts payable number of the counterparty. Used in bookkeeping.
        paymentTermsDays:
          type: number
          description: Payment term in days
        skontoPercentage:
          type: number
          description: Early payment discount percentage
        skontoDays:
          type: number
          description: Days for early payment discount
        bankAccount:
          description: The bank account of the counterparty.
          allOf:
            - $ref: '#/components/schemas/BankAccountResponseDto'
      required:
        - email
        - description
        - vat
        - accountsPayableNumber
        - paymentTermsDays
        - skontoPercentage
        - skontoDays
        - bankAccount
    ShallowUserResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the entity.
        createdAt:
          format: date-time
          type: string
          description: The date and time the entity was created.
        updatedAt:
          format: date-time
          type: string
          description: The date and time the entity was last updated.
        email:
          type: string
          description: The email of the user.
        name:
          type: string
          description: The name of the user.
        authId:
          type: string
          description: The workOs authentication id of the user.
        role:
          type: string
          description: The role the user has in the organization.
        hasPushNotification:
          type: boolean
          description: >-
            A boolean that determines if the user has push notifications
            enabled.
      required:
        - email
        - name
        - authId
        - role
        - hasPushNotification
    OrganizationResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the entity.
        createdAt:
          format: date-time
          type: string
          description: The date and time the entity was created.
        updatedAt:
          format: date-time
          type: string
          description: The date and time the entity was last updated.
        name:
          type: string
          description: The name of the organization.
        slug:
          type: string
          description: The slug of the organization.
        inCaseOfLawCustomerId:
          type: string
          description: >-
            The In case of law customer ID for this organization, if already
            connected.
          nullable: true
        logoFileName:
          type: string
          description: The logo file name.
        country:
          type: string
          description: The country of the organization using ISO 3166-1 alpha-2 code
        vatNumber:
          type: string
          description: The VAT number of the organization
        featureFlags:
          description: The feature flags associated with the organization.
          type: array
          items:
            $ref: '#/components/schemas/FeatureFlagResponseDto'
        baseCurrency:
          type: string
          description: The base currency of the organization
          enum:
            - EUR
            - USD
            - GBP
            - JPY
            - AUD
            - CAD
            - CHF
            - CNY
            - HKD
            - NZD
            - SEK
            - KRW
            - SGD
            - NOK
            - MXN
            - INR
            - BRL
            - RUB
            - ZAR
            - TRY
            - AED
            - THB
            - DKK
            - HUF
            - PLN
            - TWD
            - SAR
            - MYR
            - IDR
          default: EUR
        paymentRunBatchBooking:
          type: boolean
          description: >-
            Default setting for whether payment runs should be exported as batch
            booking or single bookings.
        paymentRunVerificationOfPayee:
          type: boolean
          description: >-
            Default setting for whether the bank should perform verification of
            payee (IBAN-Name check) for payment runs.
        invoiceExportIncludeForeignCurrencies:
          type: boolean
          description: >-
            When true, invoice exports include original currency/amounts; when
            false, exports use EUR only (foreign amounts converted).
        allowDirectInvoiceApproval:
          type: boolean
          description: >-
            Whether direct approval is allowed for invoice approval workflows in
            this organization.
        allowDirectPaymentRunApproval:
          type: boolean
          description: >-
            Whether direct approval is allowed for payment run approval
            workflows in this organization.
        cardCommonBookingTargetName:
          type: string
          description: >-
            Configured shared card booking target display name used for card
            bookkeeping export.
          nullable: true
        cardCommonBookingTargetAccountsPayableNumber:
          type: string
          description: >-
            Configured shared card booking target accounts payable number used
            for card bookkeeping export.
          nullable: true
        cardFxDifferenceLedgerAccount:
          type: string
          description: >-
            Configured ledger account used for FX difference lines in card
            bookkeeping export.
          nullable: true
        customExportFormats:
          description: Custom export formats enabled for this organization
          example:
            - custom_experta
          type: array
          items:
            type: string
        autoPopulateCustomerEmailFromMetadata:
          type: boolean
          description: >-
            Determines if the organization automatically populates customer
            email addresses from email metadata for AR invoices.
        autoPopulateSupplierEmailFromMetadata:
          type: boolean
          description: >-
            Determines if the organization automatically populates supplier
            email addresses from email metadata for AP invoices.
        excludedEmailDomains:
          type: string
          description: >-
            Comma-separated list of email domains that should be excluded from
            auto-population.
      required:
        - name
        - slug
        - logoFileName
        - country
        - vatNumber
        - featureFlags
        - baseCurrency
        - paymentRunBatchBooking
        - paymentRunVerificationOfPayee
        - invoiceExportIncludeForeignCurrencies
        - allowDirectInvoiceApproval
        - allowDirectPaymentRunApproval
        - customExportFormats
        - autoPopulateCustomerEmailFromMetadata
        - autoPopulateSupplierEmailFromMetadata
        - excludedEmailDomains
    BankTransactionARInvoiceMatchResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the entity.
        createdAt:
          format: date-time
          type: string
          description: The date and time the entity was created.
        updatedAt:
          format: date-time
          type: string
          description: The date and time the entity was last updated.
        bankTransaction:
          description: The bank transaction associated with this match.
          allOf:
            - $ref: '#/components/schemas/BankTransactionResponseDto'
        matchedAmount:
          type: number
          description: The amount that was matched between the transaction and invoice.
        matchType:
          type: string
          enum:
            - MANUAL
            - AUTOMATIC
            - SUGGESTED
          description: How the match was created (manual, automatic, or suggested).
        matchConfidence:
          type: string
          enum:
            - HIGH
            - MEDIUM
            - LOW
          description: Confidence level of the match.
        matchedBy:
          description: User who created this match (if manually matched).
          allOf:
            - $ref: '#/components/schemas/ShallowUserResponseDto'
        notes:
          type: string
          description: Additional notes about the match.
        metadata:
          type: object
          description: Metadata including matching reasons, scores, and criteria.
        matchedAt:
          format: date-time
          type: string
          description: Date and time when the match was created.
      required:
        - bankTransaction
        - matchedAmount
        - matchType
        - matchConfidence
        - matchedAt
    AccountsReceivableInCaseOfLawClaimResponseDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: Linked In case of law claim ID for this AR invoice.
        status:
          type: string
          nullable: true
          description: Current In case of law claim status.
        collectionStage:
          type: string
          nullable: true
          description: Current In case of law collection stage.
        forwardedAt:
          format: date-time
          type: string
          nullable: true
          description: Timestamp when the invoice was forwarded to In case of law.
        syncedAt:
          format: date-time
          type: string
          nullable: true
          description: Timestamp of the most recent In case of law sync.
        uploadStatus:
          type: string
          nullable: true
          description: Upload status for this invoice in the In case of law claim.
        uploadedAt:
          format: date-time
          type: string
          nullable: true
          description: Timestamp when the invoice PDF upload completed.
    BankAccountResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the entity.
        createdAt:
          format: date-time
          type: string
          description: The date and time the entity was created.
        updatedAt:
          format: date-time
          type: string
          description: The date and time the entity was last updated.
        name:
          type: string
          description: The name of the bank account holder.
        iban:
          type: string
          description: The IBAN of the bank account.
        bic:
          type: string
          description: The BIC of the bank account.
        countryCode:
          type: string
          description: The country code of the bank account.
        address:
          type: string
          description: The address of the bank account holder.
      required:
        - name
        - iban
        - bic
        - countryCode
        - address
    FeatureFlagResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the entity.
        createdAt:
          format: date-time
          type: string
          description: The date and time the entity was created.
        updatedAt:
          format: date-time
          type: string
          description: The date and time the entity was last updated.
        featureName:
          type: string
          description: The name of the feature.
        isEnabled:
          type: boolean
          description: A boolean that indicates if the feature is enabled.
      required:
        - featureName
        - isEnabled
    BankTransactionResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the entity.
        createdAt:
          format: date-time
          type: string
          description: The date and time the entity was created.
        updatedAt:
          format: date-time
          type: string
          description: The date and time the entity was last updated.
        transactionId:
          type: string
          description: Transaction ID from the bank (unique for the bank account).
        amount:
          type: number
          description: Transaction amount.
        currency:
          type: string
          enum:
            - EUR
            - USD
            - GBP
            - JPY
            - AUD
            - CAD
            - CHF
            - CNY
            - HKD
            - NZD
            - SEK
            - KRW
            - SGD
            - NOK
            - MXN
            - INR
            - BRL
            - RUB
            - ZAR
            - TRY
            - AED
            - THB
            - DKK
            - HUF
            - PLN
            - TWD
            - SAR
            - MYR
            - IDR
          description: Currency of the transaction.
        bookingDate:
          format: date-time
          type: string
          description: Date when the transaction was booked.
        remittanceInformation:
          type: string
          description: Remittance information from the bank.
        additionalInformation:
          type: string
          description: Additional information about the transaction.
        counterPartyName:
          type: string
          description: Name of the counterparty.
        counterPartyIban:
          type: string
          description: IBAN of the counterparty.
        transactionType:
          type: string
          enum:
            - incoming
            - outgoing
          description: Type of the bank transaction.
        endToEndId:
          type: string
          description: End-to-end identification of the transaction.
        matchedInvoicesSum:
          type: number
          description: Sum of matched invoice amounts for this transaction.
        matchingStatus:
          type: string
          enum:
            - NOT_MATCHED
            - PARTIALLY_MATCHED
            - FULLY_MATCHED
          description: Matching status with AR invoices.
        recommendedMatch:
          type: object
          description: Top recommendation candidate for reconciliation.
        hasRecommendation:
          type: boolean
          description: Whether a recommendation is available for this transaction.
      required:
        - transactionId
        - amount
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````