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

# Obtener cuentas a cobrar

> Saldos abiertos de clientes por tramo de vencimiento: cuánto le deben a la organización y desde cuándo. Los tramos se miden contra hoy; las fechas filtran por fecha del comprobante. Un miembro ve lo que su visibilidad de datos le permite en la app.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/accounting/accounts-receivable
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/accounting/accounts-receivable:
    get:
      tags:
        - API
      summary: Obtener cuentas a cobrar
      description: >-
        Saldos abiertos de clientes por tramo de vencimiento: cuánto le deben a
        la organización y desde cuándo. Los tramos se miden contra hoy; las
        fechas filtran por fecha del comprobante. Un miembro ve lo que su
        visibilidad de datos le permite en la app.
      operationId: getApiAccountsReceivable
      parameters:
        - name: circuit_id
          in: query
          required: false
          description: >-
            Circuito contable del reporte: `general`, el id de un circuito de la
            organización (ver `accounting_circuits` en GET
            /api/v1/organization), o `all`. Omitido es `all`, todos los
            circuitos. Un id que no es de la organización devuelve 400
            `circuit_not_found`.
          schema:
            type: string
            default: all
        - name: contact_id
          in: query
          required: false
          description: Limita el reporte a un cliente o proveedor.
          schema:
            type: string
            format: uuid
        - name: date_from
          in: query
          required: false
          description: >-
            Fecha inicial inclusiva del comprobante (no del vencimiento). Los
            tramos se miden siempre contra hoy: no devuelve una foto a esa
            fecha.
          schema:
            type: string
            format: date
        - name: date_to
          in: query
          required: false
          description: >-
            Fecha final inclusiva del comprobante (no del vencimiento). Los
            tramos se miden siempre contra hoy: no devuelve una foto a esa
            fecha.
          schema:
            type: string
            format: date
        - name: include_items
          in: query
          required: false
          description: >-
            Incluye los comprobantes abiertos de cada contacto. Sin esto
            devuelve un total por contacto y por tramo.
          schema:
            default: false
            type: boolean
      responses:
        '200':
          description: Cuentas a cobrar obtenidas
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedObjectb1775d2f55'
        '400':
          description: Solicitud inválida
          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: Solicitud inválida
                      retryable: false
                      details: []
        '401':
          description: API key faltante o inválida
          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: API key faltante o inválida
                      retryable: false
                      details: []
        '403':
          description: Scope insuficiente o contabilidad no habilitada
          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: Scope insuficiente o contabilidad no habilitada
                      retryable: false
                      details: []
        '429':
          description: Límite de solicitudes excedido para la organización
          headers:
            Retry-After:
              description: Segundos a esperar antes de volver a intentar la solicitud.
              schema:
                type: string
                example: '30'
            X-RateLimit-Limit:
              description: Límite de la ventana activa.
              schema:
                type: string
                example: '5000'
            X-RateLimit-Remaining:
              description: Solicitudes restantes en la ventana activa.
              schema:
                type: string
                example: '0'
            X-RateLimit-Reset:
              description: Segundos restantes hasta el reset de la ventana activa.
              schema:
                type: string
                example: '30'
            RateLimit-Limit:
              description: Límite de la ventana activa en formato estándar.
              schema:
                type: string
                example: '5000'
            RateLimit-Remaining:
              description: Solicitudes restantes en la ventana activa en formato estándar.
              schema:
                type: string
                example: '0'
            RateLimit-Reset:
              description: >-
                Segundos hasta el reset de la ventana activa en formato
                estándar.
              schema:
                type: string
                example: '30'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
              examples:
                default:
                  summary: RATE_LIMITED
                  value:
                    request_id: req_rate_limit_1
                    error:
                      type: rate_limit_error
                      code: RATE_LIMITED
                      message: >-
                        The organization request limit was reached. Try again
                        later.
                      retryable: true
                      details: []
        '500':
          description: Error interno del servidor
          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: Error interno del servidor
                      retryable: false
                      details: []
components:
  schemas:
    ApiSharedObjectb1775d2f55:
      type: object
      required:
        - request_id
        - effective_scope
        - data
      properties:
        request_id:
          type: string
        effective_scope:
          description: >-
            Circuito sobre el que corrió el reporte: `all`, o el circuito pedido
            (`circuit_id` null es General).
          oneOf:
            - $ref: '#/components/schemas/ApiSharedEnum901b3341d8'
            - $ref: '#/components/schemas/ApiSharedObject8d2ab49c4a'
        data:
          $ref: '#/components/schemas/ApiSharedObjectefe736f3c8'
    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
    ApiSharedEnum901b3341d8:
      type: string
      enum:
        - all
    ApiSharedObject8d2ab49c4a:
      type: object
      required:
        - circuit_id
        - circuit_name
      properties:
        circuit_id:
          type:
            - string
            - 'null'
          format: uuid
        circuit_name:
          type: string
    ApiSharedObjectefe736f3c8:
      type: object
      required:
        - object
        - functional_currency
        - summary
        - buckets
        - is_filtered_subset
        - groups
      properties:
        object:
          $ref: '#/components/schemas/ApiSharedEnum08c2c3face'
        functional_currency:
          $ref: '#/components/schemas/ApiSharedEnumd709360a4b'
        summary:
          $ref: '#/components/schemas/ApiSharedObject824a704f0f'
        buckets:
          type: array
          description: >-
            Saldo por tramo de vencimiento, siempre los seis en este orden:
            undated (sin vencimiento), current (a vencer), 1_30, 31_60, 61_90 y
            90_plus (días de mora). Importes en pesos, en unidades menores.
          items:
            $ref: '#/components/schemas/ApiSharedObject6f9fa68da4'
        is_filtered_subset:
          type: boolean
          description: >-
            true si el saldo no es el de toda la organización: filtraste por
            contacto, fechas o un circuito (en una organización con circuitos),
            o la clave delega a un usuario que solo ve parte de los datos
            (propios, clientes o sucursales asignados).
        groups:
          type: array
          description: Un grupo por contacto con saldo abierto.
          items:
            $ref: '#/components/schemas/ApiSharedObjectb4692c73ee'
    ApiSharedEnum08c2c3face:
      type: string
      enum:
        - accounts_receivable
        - accounts_payable
    ApiSharedEnumd709360a4b:
      type: string
      enum:
        - ARS
      description: >-
        Moneda de todos los importes del reporte. Un comprobante en dólares ya
        viene convertido a pesos en `functional_balance`.
    ApiSharedObject824a704f0f:
      type: object
      required:
        - total
        - undated
        - current
        - overdue
      properties:
        total:
          type: integer
        undated:
          type: integer
        current:
          type: integer
        overdue:
          type: integer
    ApiSharedObject6f9fa68da4:
      type: object
      required:
        - bucket
        - label
        - amount
      properties:
        bucket:
          $ref: '#/components/schemas/ApiSharedEnumc325e8c877'
        label:
          type: string
        amount:
          type: integer
    ApiSharedObjectb4692c73ee:
      type: object
      required:
        - contact_id
        - contact_name
        - total_balance
        - overdue_balance
        - document_count
        - buckets
      properties:
        contact_id:
          type: string
          format: uuid
        contact_name:
          type: string
        total_balance:
          type: integer
        overdue_balance:
          type: integer
        document_count:
          type: integer
        buckets:
          type: array
          description: >-
            Saldo por tramo de vencimiento, siempre los seis en este orden:
            undated (sin vencimiento), current (a vencer), 1_30, 31_60, 61_90 y
            90_plus (días de mora). Importes en pesos, en unidades menores.
          items:
            $ref: '#/components/schemas/ApiSharedObject6f9fa68da4'
        items:
          type: array
          description: Solo con include_items=true.
          items:
            $ref: '#/components/schemas/ApiSharedObject75b1e48314'
    ApiSharedEnumc325e8c877:
      type: string
      enum:
        - undated
        - current
        - 1_30
        - 31_60
        - 61_90
        - 90_plus
    ApiSharedObject75b1e48314:
      type: object
      required:
        - origin
        - origin_label
        - source_type
        - source_id
        - reference
        - document_number
        - voucher_type
        - document_date
        - due_date
        - source_currency
        - functional_balance
        - days_overdue
        - bucket
      properties:
        origin:
          $ref: '#/components/schemas/ApiSharedEnum5a50422bbd'
        origin_label:
          type: string
        source_type:
          type:
            - string
            - 'null'
        source_id:
          type:
            - string
            - 'null'
        reference:
          type:
            - string
            - 'null'
        document_number:
          type:
            - string
            - 'null'
        voucher_type:
          type:
            - string
            - 'null'
        document_date:
          type:
            - string
            - 'null'
          format: date
        due_date:
          type:
            - string
            - 'null'
          format: date
        source_currency:
          type: string
          description: Moneda del comprobante.
        functional_balance:
          type: integer
          description: >-
            Saldo en `functional_currency` (pesos), aunque el comprobante sea en
            otra moneda.
        days_overdue:
          type:
            - integer
            - 'null'
        bucket:
          $ref: '#/components/schemas/ApiSharedEnumc325e8c877'
    ApiSharedEnum5a50422bbd:
      type: string
      enum:
        - sale
        - purchase
        - manual
        - advance
        - credit_note
        - unapplied_credit
        - compensation
        - other
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: Incluí tu API key en el header Authorization con el prefijo Bearer.

````