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

# Review a period's transactions and clients against the audit checklist



## OpenAPI

````yaml /openapi/audits.json get /audits/period-review
openapi: 3.1.1
info:
  title: ARTU Compliance API
  version: 1.0.0
  description: 'API for compliance management. Documentation: https://docs.artu.ai'
servers:
  - url: https://api.artu.ai
security:
  - bearerAuth: []
    environmentHeader: []
paths:
  /audits/period-review:
    get:
      tags:
        - Audits
      summary: Review a period's transactions and clients against the audit checklist
      operationId: audits.getPeriodReview
      parameters:
        - name: scope
          in: query
          required: true
          schema:
            enum:
              - MX:AV:ARI
              - MX:AV:AVI
              - MX:AV:INM
              - MX:AV:JYS
              - MX:AV:MJR
              - MX:AV:MPC
              - MX:AV:TSC
              - MX:AV:VEH
            type: string
          allowEmptyValue: true
          allowReserved: true
        - name: from
          in: query
          required: true
          schema:
            type: string
            format: date
          allowEmptyValue: true
          allowReserved: true
        - name: to
          in: query
          required: true
          schema:
            type: string
            format: date
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  avisos:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        label:
                          type: string
                        status:
                          type: string
                        mesReportado:
                          type: string
                        filedAt:
                          anyOf:
                            - type: string
                              format: date-time
                            - type: 'null'
                        transactionCount:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                      required:
                        - id
                        - label
                        - status
                        - mesReportado
                        - filedAt
                        - transactionCount
                  transactions:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        externalId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        amount:
                          type: string
                        currency:
                          type: string
                        timestamp:
                          type: string
                          format: date-time
                        auditComplete:
                          type: boolean
                        alerts:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              label:
                                type: string
                              status:
                                type: string
                              filedAt:
                                anyOf:
                                  - type: string
                                    format: date-time
                                  - type: 'null'
                            required:
                              - id
                              - label
                              - status
                              - filedAt
                      required:
                        - id
                        - externalId
                        - amount
                        - currency
                        - timestamp
                        - auditComplete
                        - alerts
                  clients:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        type:
                          type: string
                        externalId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        rfc:
                          anyOf:
                            - type: string
                            - type: 'null'
                        curp:
                          anyOf:
                            - type: string
                            - type: 'null'
                        auditComplete:
                          type: boolean
                        outOfScope:
                          type: boolean
                        ebrWarning:
                          type: boolean
                        screeningWarning:
                          type: boolean
                        transactionIds:
                          type: array
                          items:
                            type: string
                      required:
                        - id
                        - name
                        - type
                        - externalId
                        - rfc
                        - curp
                        - auditComplete
                        - outOfScope
                        - ebrWarning
                        - screeningWarning
                        - transactionIds
                  summary:
                    type: object
                    properties:
                      pendingTransactions:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      completeTransactions:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      pendingClients:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      completeClients:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      outOfScopeClients:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      clientsWithWarnings:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      unfiledAvisos:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      unfiledAvisoTransactions:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      unreportedTransactions:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      gatePassed:
                        type: boolean
                    required:
                      - pendingTransactions
                      - completeTransactions
                      - pendingClients
                      - completeClients
                      - outOfScopeClients
                      - clientsWithWarnings
                      - unfiledAvisos
                      - unfiledAvisoTransactions
                      - unreportedTransactions
                      - gatePassed
                required:
                  - avisos
                  - transactions
                  - clients
                  - summary
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: API key authentication. Obtain your API key from the dashboard.
    environmentHeader:
      type: apiKey
      in: header
      name: X-Environment
      description: Target environment for the request. Must be "test" or "live".

````

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