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

# Estado de sincronización de una entidad

> Devuelve la frecuencia de sincronización contratada para la entidad (`sync_frequency_hours`: 24, 12 o 3) y la última actualización por tipo de scrape. Cada fila de `types` indica cuándo fue la última carga exitosa (`last_success_at`) y el estado de la última ejecución (`last_status`). Solo aparecen los tipos que se han sincronizado al menos una vez para la entidad.



## OpenAPI

````yaml api-reference/openapi-v2.json GET /sync-status/
openapi: 3.0.0
info:
  title: Tupana API — v2
  description: >-
    API v2 de Tupana: facturación electrónica, cesiones, recaudación, consultas,
    boleta de honorarios y nómina. Los identificadores de recursos son public
    IDs opacos con prefijo (docu_, ment_, cred_, doce_, empl_…).
  version: 2.0.0
servers:
  - url: https://api.tupana.ai/v2
    description: Producción (v2)
security:
  - apiKeyAuth: []
paths:
  /sync-status/:
    get:
      tags:
        - Sincronización
      summary: Estado de sincronización de una entidad
      description: >-
        Devuelve la frecuencia de sincronización contratada para la entidad
        (`sync_frequency_hours`: 24, 12 o 3) y la última actualización por tipo
        de scrape. Cada fila de `types` indica cuándo fue la última carga
        exitosa (`last_success_at`) y el estado de la última ejecución
        (`last_status`). Solo aparecen los tipos que se han sincronizado al
        menos una vez para la entidad.
      operationId: getSyncStatus_v2
      parameters:
        - name: master_entity_id
          in: query
          required: true
          description: ID de la entidad maestra. El public ID de la entidad (`ment_...`).
          schema:
            type: string
            example: ment_4829301923847
      responses:
        '200':
          description: Estado de sincronización de la entidad
          content:
            application/json:
              schema:
                type: object
                properties:
                  master_entity_id:
                    type: integer
                    description: ID entero de la entidad
                    example: 48213
                  sync_frequency_hours:
                    type: integer
                    enum:
                      - 24
                      - 12
                      - 3
                    description: >-
                      Frecuencia de sincronización contratada, en horas. 24 es
                      el plan por defecto; 12 y 3 (casi tiempo real) son planes
                      de mayor frecuencia.
                    example: 24
                  types:
                    type: array
                    description: Última actualización por tipo de scrape
                    items:
                      $ref: '#/components/schemas/SyncStatusType'
              example:
                master_entity_id: ment_4829301923847
                sync_frequency_hours: 24
                types:
                  - scrape_type: ISSUED_DOCS
                    last_success_at: '2026-07-20T06:12:41Z'
                    last_status: completed
                  - scrape_type: RECEIVED_DOCS
                    last_success_at: '2026-07-20T06:15:03Z'
                    last_status: completed
                  - scrape_type: PURCHASE_BOOK
                    last_success_at: '2026-07-19T06:14:10Z'
                    last_status: failed
        '400':
          description: master_entity_id faltante o inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: master_entity_id es requerido.
        '403':
          description: Sin acceso a la entidad consultada
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: No tienes acceso a esta entidad.
        '404':
          description: La entidad no existe
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: No encontrado.
      security:
        - apiKeyAuth: []
components:
  schemas:
    SyncStatusType:
      type: object
      description: Última actualización de un tipo de scrape para la entidad
      properties:
        scrape_type:
          type: string
          enum:
            - ISSUED_DOCS
            - RECEIVED_DOCS
            - RECEIVED_HONORARY_BILLS
            - THIRD_PARTY_HONORARY
            - EMITTED_HONORARY_BILLS
            - PURCHASE_BOOK
            - SALE_BOOK
            - BOOK_SUMMARY
          description: >-
            Tipo de scrape: ISSUED_DOCS (facturas emitidas), RECEIVED_DOCS
            (facturas recibidas), RECEIVED_HONORARY_BILLS (boletas de honorarios
            recibidas), THIRD_PARTY_HONORARY (boletas de honorarios de
            terceros), EMITTED_HONORARY_BILLS (boletas de honorarios emitidas),
            PURCHASE_BOOK (libro de compras), SALE_BOOK (libro de ventas),
            BOOK_SUMMARY (resumen de libro de compras/ventas).
          example: ISSUED_DOCS
        last_success_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Fecha/hora de la última sincronización exitosa de este tipo. null si
            nunca ha cargado con éxito.
          example: '2026-07-20T06:12:41Z'
        last_status:
          type: string
          enum:
            - in_progress
            - completed
            - failed
          description: Estado de la última ejecución de este tipo de scrape
          example: completed
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API Key para autenticación. Debe proporcionarse en el header
        Authorization con el formato: 'Api-Key YOUR-API-KEY' (incluye el prefijo
        'Api-Key ' seguido de tu API key)

````

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