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

# Retrieve a house account transaction

> Retrieves one charge or payment on a house account.



## OpenAPI

````yaml /api/openapi.json get /v1/house-accounts/{id}/transactions/{transaction_id}
openapi: 3.0.0
info:
  title: Vori API
  description: ''
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.vori.com
    description: production
security: []
tags: []
paths:
  /v1/house-accounts/{id}/transactions/{transaction_id}:
    get:
      tags:
        - House Accounts
      summary: Retrieve a house account transaction
      description: Retrieves one charge or payment on a house account.
      operationId: getHouseAccountTransaction
      parameters:
        - name: id
          required: true
          in: path
          description: ID of the house account.
          schema:
            type: string
        - name: transaction_id
          required: true
          in: path
          description: ID of the transaction.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HouseAccountTransaction'
        '403':
          description: ''
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/InsufficientPermissionsError'
                  - $ref: '#/components/schemas/NoBannerAssociationError'
        '404':
          description: House account or transaction not found.
      security:
        - bearer: []
components:
  schemas:
    HouseAccountTransaction:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the record.
        amount:
          type: string
          description: >-
            Money the transaction moved. A negative amount is a charge, which
            grows what the customer owes; a positive amount is a payment or
            refund, which reduces it.
          format: monetary
          example: '199.99'
          pattern: ^-?[0-9]+(\.[0-9]+)?$
        api_client_id:
          type: string
          nullable: true
          description: >-
            ID of the API credential that recorded the transaction. Null when a
            person did.
        created_at:
          type: string
          description: When the record was created.
          format: date-time
        description:
          type: string
          nullable: true
          description: >-
            Note written alongside the transaction, such as why an adjustment
            was made.
        effective_at:
          type: string
          description: >-
            When the transaction took effect. A sale carries the time it was
            completed at the register, which can be earlier than when it reached
            the ledger.
          format: date-time
        employee_id:
          type: string
          nullable: true
          description: >-
            ID of the employee who took the transaction at a register, or null
            when it was made in the back office.
          pattern: ^[0-9]+$
        ending_balance:
          type: string
          description: >-
            The account balance after this transaction. A negative balance is
            what the customer owes the store. A positive balance is credit the
            customer can spend.
          format: monetary
          example: '199.99'
          pattern: ^-?[0-9]+(\.[0-9]+)?$
        idempotency_key:
          type: string
          description: >-
            Key supplied when the transaction was created, unique within the
            banner. Sending the same key again returns the transaction already
            recorded rather than charging the account twice.
        metadata:
          type: object
          maxProperties: 50
          additionalProperties:
            type: string
            maxLength: 500
          example:
            order_source: shopify
            fulfillment_id: '88213'
          nullable: true
          description: >-
            Your own key/value pairs, exactly as supplied when the transaction
            was recorded.
        online_payment:
          nullable: true
          description: The charge behind an online payment.
          type: object
          allOf:
            - $ref: '#/components/schemas/HouseAccountOnlinePayment'
        order_id:
          type: string
          nullable: true
          description: >-
            ID of the checkout this settled, from the transactions resource.
            Null when the ledger entry is not tied to a checkout.
          format: uuid
        store:
          description: The store where the transaction took place.
          allOf:
            - $ref: '#/components/schemas/CompactStore'
        store_id:
          type: string
          description: ID of the store where the transaction took place.
          pattern: ^[0-9]+$
        type:
          description: >-
            What produced the transaction: a sale or refund rung up at a
            register, a payment accepted at a register toward the balance, a
            payment made online through Vori toward the balance, or an
            adjustment made in the back office.
          allOf:
            - $ref: '#/components/schemas/HouseAccountTransactionType'
        updated_at:
          type: string
          description: When the record was last changed.
          format: date-time
        user_id:
          type: string
          nullable: true
          description: >-
            ID of the back-office user who made the adjustment. Null for a
            transaction taken at a register.
          pattern: ^[0-9]+$
      description: >-
        One charge or payment on a house account. The ledger is append-only, so
        a transaction is never edited or removed once recorded; a correction is
        another transaction.
      required:
        - id
        - amount
        - api_client_id
        - created_at
        - description
        - effective_at
        - employee_id
        - ending_balance
        - idempotency_key
        - metadata
        - online_payment
        - order_id
        - store_id
        - type
        - updated_at
        - user_id
    InsufficientPermissionsError:
      type: object
      properties:
        error_code:
          type: string
          enum:
            - insufficient_permissions
        error_details:
          $ref: '#/components/schemas/InsufficientPermissionsErrorDetails'
      required:
        - error_code
        - error_details
    NoBannerAssociationError:
      type: object
      properties:
        error_code:
          type: string
          enum:
            - no_banner_association
      required:
        - error_code
    HouseAccountOnlinePayment:
      type: object
      properties:
        id:
          type: string
          description: ID of the payment.
        payment_method_details:
          description: The card or bank account the customer paid with.
          oneOf:
            - $ref: '#/components/schemas/HouseAccountCardPaymentMethodDetails'
            - $ref: '#/components/schemas/HouseAccountAchDebitPaymentMethodDetails'
          discriminator:
            propertyName: type
            mapping:
              card: '#/components/schemas/HouseAccountCardPaymentMethodDetails'
              ach_debit: '#/components/schemas/HouseAccountAchDebitPaymentMethodDetails'
        payment_method_type:
          description: How the customer paid.
          allOf:
            - $ref: '#/components/schemas/OnlinePaymentMethodType'
      description: The charge behind an online payment toward a house account.
      required:
        - id
        - payment_method_details
        - payment_method_type
    CompactStore:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the store.
        name:
          type: string
          description: Human-readable store name.
      required:
        - id
        - name
    HouseAccountTransactionType:
      type: string
      enum:
        - manual_adjustment
        - online_payment
        - order_payment
        - pos_payment
      description: >-
        What produced the transaction: a sale or refund rung up at a register, a
        payment accepted at a register toward the balance, a payment made online
        through Vori toward the balance, or an adjustment made in the back
        office.
    InsufficientPermissionsErrorDetails:
      type: object
      properties:
        action:
          allOf:
            - $ref: '#/components/schemas/Action'
        resource:
          allOf:
            - $ref: '#/components/schemas/Resource'
      required:
        - action
        - resource
    HouseAccountCardPaymentMethodDetails:
      type: object
      properties:
        brand:
          nullable: true
          description: Brand of the card.
          allOf:
            - $ref: '#/components/schemas/CardBrand'
        last4:
          type: string
          nullable: true
          description: Last four digits of the card number.
        type:
          type: string
          enum:
            - card
      required:
        - brand
        - last4
        - type
    HouseAccountAchDebitPaymentMethodDetails:
      type: object
      properties:
        account_type:
          description: Whether the bank account is a checking or savings account.
          allOf:
            - $ref: '#/components/schemas/PaymentBankAccountType'
        last4:
          type: string
          nullable: true
          description: Last four digits of the bank account number.
        type:
          type: string
          enum:
            - ach_debit
      required:
        - account_type
        - last4
        - type
    OnlinePaymentMethodType:
      type: string
      enum:
        - ach_debit
        - card
      description: The payment methods the account can be paid with.
    Action:
      type: string
      enum:
        - '*'
        - cancel
        - check_in
        - create
        - delete
        - read
        - read_credentials
        - record_events
        - refund
        - restart
        - update
        - void
    Resource:
      type: string
      enum:
        - '*'
        - accounting_integration
        - agent_chats
        - agents
        - api_clients
        - asynchronous_tasks
        - banners
        - billing
        - blackhawk_transactions
        - business_entities
        - capabilities
        - coupons
        - custom_quick_actions
        - datacap_transactions
        - departments
        - discounts
        - ditto_auth_tokens
        - edge_agents
        - electronic_shelf_labels
        - employees
        - feature_orientations
        - files
        - food_modifiers
        - gift_cards
        - gl_code_mappings
        - house_account_payment_links
        - house_account_payments
        - house_accounts
        - inventory
        - inventory_sessions
        - inventory_settings
        - invoices
        - item_modifiers
        - label_dimension_sets
        - label_sheet_profiles
        - label_stock_products
        - lanes
        - loyalty_bonuses
        - loyalty_campaigns
        - loyalty_rewards
        - notification_templates
        - offers
        - order_guides
        - payments
        - people
        - pos_banner_configurations
        - pos_orders
        - pos_tills
        - price_tags
        - product_ranges
        - products
        - promotions
        - purchase_orders
        - receiving
        - recommendation_settings
        - recommendations
        - reporting
        - revision_sessions
        - revisions
        - roles
        - shopper_tags
        - shoppers
        - store_product_inventory_counts
        - store_product_lots
        - store_product_rules
        - store_product_tag_templates
        - store_snap_incentive_program_coupons
        - store_vendor_merge_requests
        - store_vendor_product_merge_requests
        - store_vendor_products
        - store_vendors
        - stores
        - tag_printings
        - tag_template_presets
        - tag_templates
        - tax_rates
        - users
        - variable_weights
        - vendor_merge_requests
        - vendor_product_merge_requests
        - vendors
        - wallet_payments
        - wic_products
    CardBrand:
      type: string
      enum:
        - american_express
        - atm
        - bill_me_later
        - china_union_pay
        - debit
        - diners_club
        - discover
        - ebt
        - jcb
        - mastercard
        - other
        - revolution_money
        - telecheck
        - undetermined
        - visa
        - voyager
        - wright_express
    PaymentBankAccountType:
      type: string
      enum:
        - checking
        - savings
      description: Whether the bank account is a checking or savings account.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

## Related topics

- [Retrieve a house account](https://help.vori.com/api-reference/house-accounts/retrieve-a-house-account.md)
- [The house account transaction object](https://help.vori.com/api/house-accounts/transaction.md)
- [Create a house account transaction](https://help.vori.com/api-reference/house-accounts/create-a-house-account-transaction.md)
