> ## 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.

# Resolve the rate for a document

> The rate that would be applied to a document for the given branch, currency and date: the rate for that day or the latest earlier one (a branch rate takes priority over the general one). `exact` is false if an earlier date was used.

**Required permission:** `currencies`



## OpenAPI

````yaml /api-reference/openapi.en.json get /v2/exchange-rates/resolve
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:
  /v2/exchange-rates/resolve:
    get:
      tags:
        - API v2 · Currencies and rates
      summary: Resolve the rate for a document
      description: >-
        The rate that would be applied to a document for the given branch,
        currency and date: the rate for that day or the latest earlier one (a
        branch rate takes priority over the general one). `exact` is false if an
        earlier date was used.


        **Required permission:** `currencies`
      parameters:
        - name: branch_id
          in: query
          required: true
          description: Branch of the integration's business.
          schema:
            type: string
            format: uuid
          example: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
        - name: currency
          in: query
          required: true
          description: 3-letter code.
          schema:
            type: string
          example: GTQ
        - name: date
          in: query
          required: false
          description: 'Document date (default: today).'
          schema:
            type: string
            format: date
          example: '2026-10-17'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - data
                properties:
                  status:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      currency_code:
                        type: string
                      base_currency_code:
                        type: string
                      rate:
                        type: string
                      effective_date:
                        type: string
                        format: date
                      exact:
                        type: boolean
                      source:
                        type: string
                        description: Source.
                        enum:
                          - manual
                          - api
                          - base
                    required:
                      - currency_code
                      - base_currency_code
                      - rate
                      - effective_date
                      - exact
                      - source
              example:
                status: true
                data:
                  currency_code: GTQ
                  base_currency_code: USD
                  rate: '0.12800000'
                  effective_date: '2026-10-15'
                  exact: false
                  source: manual
        '401':
          $ref: '#/components/responses/E401'
        '403':
          description: >-
            Missing the `currencies` permission, or multi-currency not enabled
            for the business
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Error'
              examples:
                scope:
                  summary: Sin el permiso currencies
                  value:
                    status: false
                    message: >-
                      This integration does not have the 'currencies'
                      permission.
                    required_scope: currencies
                flag:
                  summary: Multi-moneda deshabilitada
                  value:
                    status: false
                    code: currency_not_enabled
                    message: Multi-moneda no está habilitada para esta empresa.
        '404':
          description: No rate on or before the date
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Error'
              example:
                status: false
                code: exchange_rate_not_found
                message: >-
                  No hay tasa de cambio para GTQ a la fecha 2026-10-01 ni
                  anterior. Registre una tasa de cambio o envíe exchange_rate en
                  el documento.
                errors:
                  exchange_rate: Sin tasa de cambio para GTQ al 2026-10-01.
        '422':
          description: Invalid parameters or currency not active
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Error'
              examples:
                validation_error:
                  summary: Parámetro inválido
                  value:
                    status: false
                    code: validation_error
                    message: Validation errors
                    errors:
                      currency:
                        - Obligatoria (código de 3 letras).
                currency_not_enabled:
                  summary: Moneda no activa
                  value:
                    status: false
                    code: currency_not_enabled
                    message: La moneda GTQ no está activa para este negocio.
                    errors:
                      currency: La moneda GTQ no está activa.
        '429':
          $ref: '#/components/responses/E429'
      servers:
        - url: https://api.filexpress.app/api/external
          description: Production (v2 routes are prefixed with /v2)
components:
  responses:
    E401:
      description: Missing or invalid API Key
      content:
        application/json:
          example:
            status: false
            message: Invalid API Key.
    E429:
      description: Rate limit exceeded
      content:
        application/json:
          example:
            status: false
            message: Rate limit exceeded. Please try again later.
            rate_limit: 100
  schemas:
    V2Error:
      type: object
      properties:
        status:
          type: boolean
          example: false
        code:
          type: string
          description: >-
            Stable error code. Evaluate this field instead of the `message`
            text. Responses from the access layer (API Key, permission, rate
            limit) and the 404 for a resource of another business may not
            include it: use the HTTP code.
          enum:
            - currency_not_enabled
            - exchange_rate_not_found
            - exchange_rate_invalid
            - base_currency_not_legal
            - validation_error
            - tax_invalid
            - payment_method_invalid
            - tax_not_supported_in_expenses
            - country_not_supported
            - country_data_invalid
            - idempotency_key_reused
            - idempotency_in_progress
            - unauthorized
            - forbidden
            - not_found
            - rate_limited
            - error
        message:
          type: string
        errors:
          oneOf:
            - type: object
              additionalProperties: true
              description: Field -> message(s) (validation and currency).
            - type: array
              description: 'Only in `tax_invalid`: one entry per tax problem.'
              items:
                type: object
                properties:
                  field:
                    type: string
                  code:
                    type: string
                    description: Detail of the tax problem.
                    enum:
                      - tax_not_found
                      - tax_wrong_effect
                      - tax_country_mismatch
                      - tax_not_in_lines
                      - tax_totals_inconsistent
                      - tax_amount_mismatch
                      - withholding_totals_inconsistent
                      - withholding_amount_mismatch
                  message:
                    type: string
                  tax_id:
                    type: string
                    format: uuid
                required:
                  - field
                  - code
                  - message
          description: Optional. Its shape depends on the error.
      required:
        - status
        - message
  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.