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

# Capabilities and catalogs of a country

> Document types, payment methods, taxes, tax rules and invoicing capabilities of a country, to build documents without country-specific code. `base_currency_of_business` is the base currency of the integration's business. It only reads catalogs of the requested country, never data from other businesses. Returns 404 `country_not_supported` if electronic invoicing is not configured for the country.

**Required permission:** `countries`



## OpenAPI

````yaml /api-reference/openapi.en.json get /v2/countries/{code}
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/countries/{code}:
    get:
      tags:
        - API v2 · Countries
      summary: Capabilities and catalogs of a country
      description: >-
        Document types, payment methods, taxes, tax rules and invoicing
        capabilities of a country, to build documents without country-specific
        code. `base_currency_of_business` is the base currency of the
        integration's business. It only reads catalogs of the requested country,
        never data from other businesses. Returns 404 `country_not_supported` if
        electronic invoicing is not configured for the country.


        **Required permission:** `countries`
      parameters:
        - name: code
          in: path
          required: true
          description: ISO-2 country code (case-insensitive).
          schema:
            type: string
            minLength: 2
            maxLength: 2
          example: GT
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - data
                properties:
                  status:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/V2CountryCapabilities'
              example:
                status: true
                data:
                  country_code: GT
                  name: Guatemala
                  legal_currency: GTQ
                  base_currency_of_business: USD
                  timezone: America/Guatemala
                  document_types:
                    - code: fact
                      name: Factura
                      number_code: '01'
                      applicable_to: both
                      requires: []
                  payment_methods:
                    - id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                      code: '01'
                      name: Efectivo
                  taxes:
                    - id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
                      name: IVA
                      number_code: '20'
                      tax_type: percentage
                      percent: 12
                      effect: add
                  tax_rules: []
                  identification_types: []
                  adapter:
                    signs: false
                    async: false
                    void_mode: cancel
                    supports_draft: true
                    supports_skip_transmission: false
                    country_data_schema:
                      fcam:
                        periodos:
                          type: integer
                          required: false
                          default: 1
                          description: Número de periodos (>= 1).
        '401':
          $ref: '#/components/responses/E401'
        '403':
          description: Integration without the `countries` permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Error'
              example:
                status: false
                message: This integration does not have the 'countries' permission.
                required_scope: countries
        '404':
          description: Country without electronic invoicing configured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Error'
              example:
                status: false
                code: country_not_supported
                message: No hay facturación electrónica configurada para el país XX.
        '429':
          $ref: '#/components/responses/E429'
      servers:
        - url: https://api.filexpress.app/api/external
          description: Production (v2 routes are prefixed with /v2)
components:
  schemas:
    V2CountryCapabilities:
      type: object
      properties:
        country_code:
          type: string
          description: ISO-2 country code, uppercase.
        name:
          type: string
        legal_currency:
          type: string
          nullable: true
          description: >-
            Legal currency of the country in which the electronic document is
            issued (null if not configured).
        base_currency_of_business:
          type: string
          description: Base currency of the integration's business.
        timezone:
          type: string
          description: Issuing time zone. Only present if the country has it configured.
        document_types:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                description: Value for `document_type` when creating documents.
              name:
                type: string
              number_code:
                type: string
              applicable_to:
                type: string
                description: Where it is used.
                enum:
                  - sales
                  - expenses
                  - both
              requires:
                type: array
                items:
                  type: string
                description: >-
                  Own fields required by this document type in the country
                  (empty if none).
            required:
              - code
              - name
              - number_code
              - applicable_to
              - requires
        payment_methods:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                description: >-
                  Value for `payment_details[].payment_method_id`. Use the id:
                  the code is not unique across countries.
              code:
                type: string
                description: >-
                  Payment method code (informational only; not unique across
                  countries).
              name:
                type: string
            required:
              - id
              - code
              - name
        taxes:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                description: Value for `tax_ids`.
              name:
                type: string
              number_code:
                type: string
              tax_type:
                type: string
                description: >-
                  How it is calculated. With `percentage`, `percent` is present;
                  otherwise `value` is present.
              percent:
                type: number
              value:
                type: number
              effect:
                type: string
                description: >-
                  Effect of the tax on the document (for example `add` adds and
                  `withhold` withholds).
            required:
              - id
              - name
              - number_code
              - tax_type
              - effect
        tax_rules:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              name:
                type: string
              tax_id:
                type: string
                format: uuid
                nullable: true
              applies_to:
                type: string
              effect:
                type: string
              rate:
                type: number
              base:
                type: string
              scope:
                type: string
              document_types:
                type: array
                items:
                  type: string
                nullable: true
                description: Document types it applies to.
            required:
              - code
              - name
          description: >-
            Active tax rules of the country. It is a summary: it does not
            include the trigger conditions.
        identification_types:
          type: array
          items:
            type: string
          description: >-
            Reserved; currently always returned empty (the customer and supplier
            document type is free text).
        adapter:
          type: object
          properties:
            signs:
              type: boolean
              description: FileXpress signs the document with the business's certificate.
            async:
              type: boolean
              description: The authority responds after the call.
            void_mode:
              type: string
              description: How a document is voided.
              enum:
                - invalidate
                - cancel
                - credit_note_only
                - none
            supports_draft:
              type: boolean
              description: >-
                A rejection by the authority leaves the document as a draft with
                the error detail.
            supports_skip_transmission:
              type: boolean
              description: It can be recorded without transmitting to the authority.
            country_data_schema:
              type: object
              additionalProperties:
                type: object
                additionalProperties:
                  type: object
                  additionalProperties: true
              description: >-
                `country_data` fields per document type: `{type: {field: {type,
                required, enum?, default?, format?, description}}}`. Empty if
                the country has no own fields.
          required:
            - signs
            - async
            - void_mode
            - supports_draft
            - supports_skip_transmission
            - country_data_schema
      required:
        - country_code
        - name
        - legal_currency
        - base_currency_of_business
        - document_types
        - payment_methods
        - taxes
        - tax_rules
        - identification_types
        - adapter
    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
  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
  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.