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

# Get submission report

> Reported-versus-pending counts of payees, payments, and packages.

<Note>
  `packages` counts the messages sent to the regulatory authority: total generated, accepted, and still awaiting a response. A payee with more payments than the country's per-file limit is split into several packages automatically.
</Note>


## OpenAPI

````yaml get /reports/cesop/v1/submissions/{submissionId}/report
openapi: 3.1.0
info:
  title: CESOP REST API
  description: >
    <p>REST API for reporting CESOP(The Central Electronic System of Payment
    information). Create a submission, send payees

    and payments under its id, then submit it to the regulatory authority.</p>


    <p><strong>Filtering is the reporting company's responsibility.</strong>
    This API reports the data you send as-is, and it does not decide which
    payments are reportable. Apply the CESOP filtering rules before sending.</p>


    <p><strong>European Commission's official reporting guideline:</strong>

    <a href="docs/cesop-guidelines-v1.2.pdf">CESOP Guidelines for the reporting
    of payment data v1.2 (PDF)</a></p>


    <p><strong>CESOP filtering rules, PSP's implementation guide:</strong>

    <a href="docs/cesop-filtering-rules.html">open the guide</a>. This is a
    quick reference only, it may not cover every case. For accurate handling of
    specific cases, refer to the regulation and official CESOP
    documentation.</p>


    <p><strong>Regulation:</strong>

    <a href="https://eur-lex.europa.eu/eli/dir/2020/284/oj">Council Directive
    (EU) 2020/284</a>

    &middot;

    <a
    href="https://taxation-customs.ec.europa.eu/taxation-1/central-electronic-system-payment-information-cesop_en">CESOP
    — European Commission</a></p>
  version: 0.0.1
servers:
  - url: https://api.rrc.dev.finventi.com
    description: Development
  - url: https://api.rrc.finventi.com
    description: Production
security:
  - bearer-jwt: []
tags:
  - name: CESOP Filtering Support
    description: >-
      Helper endpoints supporting CESOP filtering decisions. This is not part of
      the submission flow.Use them to prepare your data before sending it via
      the CESOP Submission API.
  - name: CESOP REST API
    description: >-
      REST API for submitting and correcting CESOP payee and payment data.
      Create a submission, push payees and payments under its id, then submit it
      to the regulatory authority.
paths:
  /reports/cesop/v1/submissions/{submissionId}/report:
    get:
      tags:
        - CESOP REST API
      summary: Get submission report
      description: >-
        Detailed reporting status of the submission: overall status, how many
        payees and payments are reported versus still pending, the number of
        packages sent to the regulatory authority, and each payee's state.
      operationId: getSubmissionReport
      parameters:
        - name: submissionId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionReport'
components:
  schemas:
    SubmissionReport:
      type: object
      description: >-
        Detailed reporting status: overall status, reported/pending counts of
        payees and payments, the number of packages sent to the regulatory
        authority, and per-payee state.
      properties:
        submissionId:
          type: string
        year:
          type: integer
          format: int32
        quarter:
          type: integer
          format: int32
        countryCode:
          type: string
        status:
          type: string
          description: High-level lifecycle status of a submission
          enum:
            - DRAFT
            - PROCESSING
            - ACTION_REQUIRED
            - REPORTED
            - FAILED
        payees:
          $ref: '#/components/schemas/ProgressCount'
        payments:
          $ref: '#/components/schemas/ProgressCount'
        packages:
          $ref: '#/components/schemas/ProgressCount'
          description: >-
            Packages (messages) sent to the regulatory authority: total
            generated, accepted, and still awaiting a response
        payeeStatuses:
          type: array
          items:
            $ref: '#/components/schemas/PayeeReportStatus'
      required:
        - countryCode
        - packages
        - payeeStatuses
        - payees
        - payments
        - quarter
        - status
        - submissionId
        - year
    ProgressCount:
      type: object
      description: Totals split into already-reported and still-pending
      properties:
        total:
          type: integer
          format: int32
        reported:
          type: integer
          format: int32
        pending:
          type: integer
          format: int32
      required:
        - pending
        - reported
        - total
    PayeeReportStatus:
      type: object
      description: >-
        A payee (by your clientPayeeId) and whether its data has been reported
        yet
      properties:
        clientPayeeId:
          type: string
          description: Your clientPayeeId
        state:
          type: string
          description: >-
            REPORTED once all of the payee's data is accepted; PENDING while any
            is still to be reported
          enum:
            - PENDING
            - REPORTED
            - FAILED
        payments:
          type: integer
          format: int32
          description: Number of payments reported for this payee
      required:
        - clientPayeeId
        - payments
        - state
  securitySchemes:
    bearer-jwt:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: >-
            https://auth.sandbox.finventi.com/realms/sti-connector/protocol/openid-connect/token
          scopes: {}

````