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

# List statement periods

> Read native statement and book balances, pending lines and unmatched book records. Closed requires exact balance, no pending lines and no outstanding records. Never post a balancing entry to force a close.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/statements/periods
openapi: 3.1.0
info:
  title: La Pyme API
  description: >-
    Resources and workflows for purchases, sales, inventory, contacts, products,
    reports, and settings.
  version: 1.0.0
  contact:
    name: La Pyme Support
    email: hola@lapyme.com.ar
  license:
    name: Proprietary
    url: https://lapyme.com.ar/terminos
servers:
  - url: https://api.lapyme.com.ar
    description: Servidor de producción
security:
  - bearerAuth: []
tags:
  - name: API
    description: Public API operations for La Pyme integrations.
paths:
  /api/v1/statements/periods:
    get:
      tags:
        - API
      summary: List statement periods
      description: >-
        Read native statement and book balances, pending lines and unmatched
        book records. Closed requires exact balance, no pending lines and no
        outstanding records. Never post a balancing entry to force a close.
      operationId: listApiStatementPeriods
      parameters:
        - name: bank_account_id
          in: query
          required: true
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          required: false
          schema:
            default: 50
            type: integer
            minimum: 1
            maximum: 100
        - name: cursor
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Statement result or immutable replay
          content:
            application/json:
              schema:
                type: object
                required:
                  - request_id
                  - data
                  - object
                  - url
                  - has_more
                  - next_cursor
                properties:
                  request_id:
                    type: string
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        object:
                          type: string
                          const: statement_period
                        bank_account_id:
                          type: string
                          format: uuid
                        statement_id:
                          anyOf:
                            - type: string
                              format: uuid
                            - type: 'null'
                        period_start:
                          type: string
                          format: date
                        period_end:
                          type: string
                          format: date
                        currency:
                          $ref: '#/components/schemas/ApiSharedEnumffb4886f2b'
                        opening_balance:
                          anyOf:
                            - type: integer
                            - type: 'null'
                        closing_balance:
                          anyOf:
                            - type: integer
                            - type: 'null'
                        book_balance:
                          anyOf:
                            - type: integer
                            - type: 'null'
                        difference:
                          anyOf:
                            - type: integer
                            - type: 'null'
                        book_balance_quality:
                          $ref: '#/components/schemas/ApiSharedEnum714ff181d6'
                        pending_line_count:
                          type: integer
                          minimum: 0
                        line_count:
                          type: integer
                          minimum: 0
                        status:
                          type: string
                          enum:
                            - open
                            - closed
                            - without_statement
                        outstanding_records:
                          type: array
                          items:
                            $ref: '#/components/schemas/ApiSharedObject7687b554ab'
                      required:
                        - object
                        - bank_account_id
                        - statement_id
                        - period_start
                        - period_end
                        - currency
                        - opening_balance
                        - closing_balance
                        - book_balance
                        - difference
                        - book_balance_quality
                        - pending_line_count
                        - line_count
                        - status
                        - outstanding_records
                      additionalProperties: false
                  object:
                    type: string
                    const: list
                  url:
                    type: string
                  has_more:
                    type: boolean
                  next_cursor:
                    type:
                      - string
                      - 'null'
        '400':
          description: Statement request could not be completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
              examples:
                default:
                  summary: INVALID_REQUEST
                  value:
                    request_id: req_error_1
                    error:
                      type: invalid_request_error
                      code: INVALID_REQUEST
                      message: Statement request could not be completed
                      retryable: false
                      details: []
        '401':
          description: Statement request could not be completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
              examples:
                default:
                  summary: INVALID_REQUEST
                  value:
                    request_id: req_error_1
                    error:
                      type: invalid_request_error
                      code: INVALID_REQUEST
                      message: Statement request could not be completed
                      retryable: false
                      details: []
        '403':
          description: Statement request could not be completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
              examples:
                default:
                  summary: INVALID_REQUEST
                  value:
                    request_id: req_error_1
                    error:
                      type: invalid_request_error
                      code: INVALID_REQUEST
                      message: Statement request could not be completed
                      retryable: false
                      details: []
        '404':
          description: Statement request could not be completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
              examples:
                default:
                  summary: INVALID_REQUEST
                  value:
                    request_id: req_error_1
                    error:
                      type: invalid_request_error
                      code: INVALID_REQUEST
                      message: Statement request could not be completed
                      retryable: false
                      details: []
        '409':
          description: Idempotency or statement state conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
              examples:
                default:
                  summary: INVALID_REQUEST
                  value:
                    request_id: req_error_1
                    error:
                      type: invalid_request_error
                      code: INVALID_REQUEST
                      message: Idempotency or statement state conflict
                      retryable: false
                      details: []
        '422':
          description: Statement request could not be completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
              examples:
                default:
                  summary: INVALID_REQUEST
                  value:
                    request_id: req_error_1
                    error:
                      type: invalid_request_error
                      code: INVALID_REQUEST
                      message: Statement request could not be completed
                      retryable: false
                      details: []
        '429':
          description: Statement request could not be completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
              examples:
                default:
                  summary: INVALID_REQUEST
                  value:
                    request_id: req_error_1
                    error:
                      type: invalid_request_error
                      code: INVALID_REQUEST
                      message: Statement request could not be completed
                      retryable: false
                      details: []
        '503':
          description: >-
            Statement request could not be completed Verificación de
            credenciales temporalmente ocupada; reintentá sin cambiar la
            operación ni su Idempotency-Key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
              examples:
                default:
                  summary: INVALID_REQUEST
                  value:
                    request_id: req_error_1
                    error:
                      type: invalid_request_error
                      code: INVALID_REQUEST
                      message: Statement request could not be completed
                      retryable: false
                      details: []
                authentication_capacity:
                  summary: Verificación temporalmente ocupada
                  value:
                    request_id: req_auth_capacity_1
                    error:
                      type: api_error
                      code: INTERNAL_ERROR
                      message: >-
                        La verificación de credenciales está ocupada. Reintentá
                        más tarde.
                      retryable: true
                      details: []
          headers:
            Retry-After:
              description: >-
                Segundos de espera. La verificación de credenciales indica 1;
                otras dependencias pueden indicar otro valor.
              schema:
                type: string
                example: '1'
            Cache-Control:
              description: La verificación de credenciales indica no-store.
              schema:
                type: string
                example: no-store
components:
  schemas:
    ApiSharedEnumffb4886f2b:
      type: string
      enum:
        - ARS
        - USD
    ApiSharedEnum714ff181d6:
      type: string
      enum:
        - exact
        - derived
        - unavailable
    ApiSharedObject7687b554ab:
      type: object
      properties:
        target_type:
          $ref: '#/components/schemas/ApiSharedEnumfb34785183'
        target_id:
          type: string
          format: uuid
        occurred_at:
          type: string
          format: date
        amount:
          type: integer
        reference:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
      required:
        - target_type
        - target_id
        - occurred_at
        - amount
        - reference
        - description
      additionalProperties: false
    ApiErrorEnvelope:
      type: object
      properties:
        request_id:
          type: string
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - api_error
                - authentication_error
                - authorization_error
                - business_error
                - external_dependency_error
                - idempotency_error
                - invalid_request_error
                - rate_limit_error
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            details:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
                  metadata:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties:
                      type:
                        - string
                        - number
                        - boolean
                        - 'null'
                required:
                  - code
                  - message
                additionalProperties: false
          required:
            - type
            - code
            - message
            - retryable
            - details
          additionalProperties: false
      required:
        - request_id
        - error
      additionalProperties: false
    ApiSharedEnumfb34785183:
      type: string
      enum:
        - payment
        - journal_entry
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: Incluí tu API key en el header Authorization con el prefijo Bearer.

````

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