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

# Balance by third party

> Debit, credit and balance by third party and account. Only PROCESSED journal entries and lines with a third party. `balance` = `opening` + `debit` - `credit` (positive: debit balance; negative: credit balance). With `start_date`, everything before it accumulates as `opening`; without it, all movement up to `end_date` counts as `debit` and `credit`. With `format=pdf` or `format=excel` it downloads the file.

**Required permission:** `accounting.reports`



## OpenAPI

````yaml /api-reference/openapi.en.json get /accounting/reports/third-party-balance
openapi: 3.0.3
info:
  title: FileXpress External API
  version: 1.0.0
  description: >-
    API for integrating third-party systems with FileXpress: billing, HR,
    accounting, inventory, projects, accounts receivable and payable, treasury,
    pricing and promotions, and cash. Current base URL: /api/external/v1. The
    legacy unversioned path (/api/external) will be removed on January 1, 2027;
    migrate to /api/external/v1 (same endpoints, only the base URL changes). The
    v2 API (/api/external/v2) exposes currencies and exchange rates, sales and
    purchases in foreign currency, taxes by id, payrolls with branch, and errors
    with a stable `code`; its operations carry the /v2 prefix in the path. We
    suggest migrating to the available v2 routes before March 30, 2027.
servers:
  - url: https://api.filexpress.app/api/external/v1
    description: Production
security:
  - ApiKey: []
tags:
  - name: General
  - name: Billing · Sales
  - name: Billing · Purchases
  - name: Billing · Customers
  - name: Billing · Suppliers
  - name: Billing · Products
  - name: Catalogs
  - name: HR · Employees
  - name: HR · Attendance
  - name: HR · Labor rules
  - name: HR · Schedules
  - name: HR · Holidays
  - name: HR · Attendance results
  - name: HR · Leave requests
  - name: HR · Payrolls
  - name: Accounting
  - name: Inventory
  - name: Projects
  - name: Accounts receivable
  - name: Accounts payable
  - name: Treasury
  - name: Pricing and promotions
  - name: Cash
  - name: Points of sale
  - name: API v2 · General
  - name: API v2 · Currencies and rates
  - name: API v2 · Countries
  - name: API v2 · Sales
  - name: API v2 · Purchases
  - name: API v2 · Payrolls
paths:
  /accounting/reports/third-party-balance:
    get:
      tags:
        - Contabilidad
      summary: Balance by third party
      description: >-
        Debit, credit and balance by third party and account. Only PROCESSED
        journal entries and lines with a third party. `balance` = `opening` +
        `debit` - `credit` (positive: debit balance; negative: credit balance).
        With `start_date`, everything before it accumulates as `opening`;
        without it, all movement up to `end_date` counts as `debit` and
        `credit`. With `format=pdf` or `format=excel` it downloads the file.


        **Required permission:** `accounting.reports`
      parameters:
        - name: end_date
          in: query
          required: true
          description: Cut-off date (YYYY-MM-DD).
          schema:
            type: string
            format: date
          example: '2026-10-31'
        - name: start_date
          in: query
          required: false
          description: >-
            Optional: everything before this date accumulates as the opening
            balance (`opening`).
          schema:
            type: string
            format: date
        - name: third_party_type
          in: query
          required: false
          description: >-
            Optional: `customer`, `provider` or `employee`. The type alone lists
            all third parties of that type.
          schema:
            type: string
            enum:
              - customer
              - provider
              - employee
        - name: third_party_id
          in: query
          required: false
          description: >-
            Optional, requires third_party_type: a single third party (from
            another business → 404; without type → 422).
          schema:
            type: string
            format: uuid
        - name: account_codes[]
          in: query
          required: false
          description: >-
            Optional (repeatable; also accepts comma-separated codes): only
            those accounts.
          schema:
            type: array
            items:
              type: string
        - name: category_ids[]
          in: query
          required: false
          description: >-
            Optional (repeatable; also accepts comma-separated ids): only
            accounts of those account categories and, by default, their
            subcategories. If no account belongs to them, the report comes back
            empty.
          schema:
            type: array
            items:
              type: string
              format: uuid
        - name: include_children
          in: query
          required: false
          description: >-
            With category_ids, includes the accounts of their subcategories
            (default true).
          schema:
            type: boolean
            default: true
        - name: branch_id
          in: query
          required: false
          description: 'Optional: limits to one branch.'
          schema:
            type: string
        - name: format
          in: query
          required: false
          description: >-
            `json` (default), `pdf` (application/pdf), or `excel` (.xlsx). With
            pdf/excel the response is the file.
          schema:
            type: string
            enum:
              - json
              - pdf
              - excel
            default: json
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - data
                properties:
                  status:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/ThirdPartyBalance'
              example:
                status: true
                data:
                  title: Saldo por tercero
                  date_from: 01/10/2026
                  date_to: 31/10/2026
                  as_of_date: '2026-10-31'
                  rows:
                    - third_party_type: customer
                      third_party_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                      third_party_name: Distribuidora Sol
                      account_code: '1103'
                      account_name: Clientes
                      opening: 100
                      debit: 0
                      credit: 30
                      balance: 70
                  totals:
                    opening: 100
                    debit: 0
                    credit: 30
                    balance: 70
                  generated_at: 31/10/2026 18:20:05
            application/pdf:
              schema:
                type: string
                format: binary
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '404':
          description: Not found or belongs to another business
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                message: Third party not found for this integration.
        '422':
          $ref: '#/components/responses/E422'
        '429':
          $ref: '#/components/responses/E429'
components:
  schemas:
    ThirdPartyBalance:
      type: object
      properties:
        title:
          type: string
        date_from:
          type: string
          nullable: true
        date_to:
          type: string
        as_of_date:
          type: string
          format: date
        rows:
          type: array
          items:
            type: object
            properties:
              third_party_type:
                type: string
                description: Third party type.
                enum:
                  - customer
                  - provider
                  - employee
              third_party_id:
                type: string
                format: uuid
              third_party_name:
                type: string
                description: >-
                  Third party name (`(tercero eliminado)` if it no longer
                  exists).
              account_code:
                type: string
              account_name:
                type: string
              opening:
                type: number
                description: Opening balance (debit - credit before start_date).
              debit:
                type: number
              credit:
                type: number
              balance:
                type: number
                description: opening + debit - credit.
            required:
              - third_party_type
              - third_party_id
              - account_code
        totals:
          type: object
          properties:
            opening:
              type: number
            debit:
              type: number
            credit:
              type: number
            balance:
              type: number
        generated_at:
          type: string
      required:
        - as_of_date
        - rows
        - totals
    Error:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Errors per field (validation only).
      required:
        - status
        - message
  responses:
    E401:
      description: Missing or invalid API Key
      content:
        application/json:
          example:
            status: false
            message: Invalid API Key.
    E403:
      description: Integration without the required permission or deactivated
      content:
        application/json:
          example:
            status: false
            message: This integration does not have the 'hr.employees' permission.
            required_scope: hr.employees
    E422:
      description: Validation error
      content:
        application/json:
          example:
            status: false
            message: Validation errors
            errors:
              start_date:
                - The start date field is required.
    E429:
      description: Rate limit exceeded
      content:
        application/json:
          example:
            status: false
            message: Rate limit exceeded. Please try again later.
            rate_limit: 100
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Integration API Key (Integrations → New Integration).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.