> ## 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. # List house accounts > Lists the house accounts across the whole banner, newest first. Filter by account number to find the one a customer gave at checkout, and page through the results with the cursor parameters. ## OpenAPI ````yaml /api/openapi.json get /v1/house-accounts 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: get: tags: - House Accounts summary: List house accounts description: >- Lists the house accounts across the whole banner, newest first. Filter by account number to find the one a customer gave at checkout, and page through the results with the cursor parameters. operationId: listHouseAccount parameters: - name: balance required: false in: query schema: type: string description: >- Money on the account. A negative balance is what the customer owes the store; a positive balance is credit they can spend. Compared as stored, so `balance[lte]=-100` finds the accounts owing 100 or more. - name: balance[gt] required: false in: query schema: type: string description: >- Money on the account. A negative balance is what the customer owes the store; a positive balance is credit they can spend. Compared as stored, so `balance[lte]=-100` finds the accounts owing 100 or more. - name: balance[gte] required: false in: query schema: type: string description: >- Money on the account. A negative balance is what the customer owes the store; a positive balance is credit they can spend. Compared as stored, so `balance[lte]=-100` finds the accounts owing 100 or more. - name: balance[lt] required: false in: query schema: type: string description: >- Money on the account. A negative balance is what the customer owes the store; a positive balance is credit they can spend. Compared as stored, so `balance[lte]=-100` finds the accounts owing 100 or more. - name: balance[lte] required: false in: query schema: type: string description: >- Money on the account. A negative balance is what the customer owes the store; a positive balance is credit they can spend. Compared as stored, so `balance[lte]=-100` finds the accounts owing 100 or more. - name: ending_before required: false in: query description: Return records that precede the record with this ID, in list order. schema: type: string - name: limit required: false in: query description: Maximum number of records to return. schema: minimum: 1 maximum: 100 default: 20 type: integer - name: shopper_facing_id required: false in: query schema: type: string maxLength: 255 description: >- Account number the store gives the customer, and what a cashier looks the account up by. Unique within the banner. Matched exactly. - name: starting_after required: false in: query description: Return records that follow the record with this ID, in list order. schema: type: string - name: status required: false in: query style: form explode: true description: >- Whether the account may be charged. A suspended or deactivated account cannot be charged at the register, though a suspended one still accepts payments against what is owed. Repeat to match any of up to 20 values. schema: type: array items: type: string enum: - active - deactivated - suspended responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/HouseAccountList' '400': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/ConflictingListParametersError' - $ref: '#/components/schemas/InvalidListCursorError' '402': description: The required capability is not enabled for the banner. content: application/json: schema: $ref: '#/components/schemas/CapabilityRequiredException' '403': description: '' content: application/json: schema: anyOf: - $ref: '#/components/schemas/InsufficientPermissionsError' - $ref: '#/components/schemas/NoBannerAssociationError' security: - bearer: [] components: schemas: HouseAccountList: type: object properties: data: type: array items: $ref: '#/components/schemas/HouseAccount' has_more: type: boolean description: Whether more records follow this page. required: - data - has_more ConflictingListParametersError: type: object properties: error_code: type: string enum: - conflicting_list_parameters required: - error_code InvalidListCursorError: type: object properties: error_code: type: string enum: - invalid_list_cursor required: - error_code CapabilityRequiredException: type: object properties: error_code: type: string enum: - capability_not_enabled required: - error_code 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 HouseAccount: type: object properties: id: type: string description: Unique identifier for the record. balance: type: string description: >- Money on the account. A negative balance is what the customer owes the store; a positive balance is credit they can spend. format: monetary example: '199.99' pattern: ^-?[0-9]+(\.[0-9]+)?$ created_at: type: string description: When the record was created. format: date-time email: type: string nullable: true description: Email address on file for the account holder. format: email maxLength: 254 last_order_at: type: string nullable: true description: >- When an order was last charged to or refunded against this account. Null if it has never been used at a register. format: date-time name: type: string description: >- Name the account is held under, usually the customer or business it belongs to. phone_number: type: string nullable: true description: Phone number on file for the account holder. format: phone pattern: ^\+[1-9]\d{1,14}$ shopper_facing_id: type: string description: >- Account number the store gives the customer, and what a cashier looks the account up by. Unique within the banner. status: description: >- Whether the account may be charged. A suspended or deactivated account cannot be charged at the register, though a suspended one still accepts payments against what is owed. allOf: - $ref: '#/components/schemas/HouseAccountStatus' updated_at: type: string description: When the record was last changed. format: date-time description: >- A charge account, or tab, a store lets a customer buy against and settle later. A house account belongs to the banner rather than to any one store, and can be charged at any of its registers. required: - id - balance - created_at - email - last_order_at - name - phone_number - shopper_facing_id - status - updated_at InsufficientPermissionsErrorDetails: type: object properties: action: allOf: - $ref: '#/components/schemas/Action' resource: allOf: - $ref: '#/components/schemas/Resource' required: - action - resource HouseAccountStatus: type: string enum: - active - deactivated - suspended 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 - api_clients - asynchronous_tasks - banners - blackhawk_transactions - 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_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 - pos_banner_configurations - pos_orders - pos_tills - price_tags - product_ranges - products - promotions - purchase_orders - receiving - 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 securitySchemes: bearer: type: http scheme: bearer ```` ## Related topics - [List house account transactions](/api-reference/house-accounts/list-house-account-transactions.md) - [Format & Import House Accounts](/point-of-sale-pos/house-accounts-charge-accounts/how-to-format-and-import-house-accounts.md) - [The house account object](/api/house-accounts/object.md)