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

# Get General Report

> Retrieves general report information from the database based on URL params :company_id and :report_id.



## OpenAPI

````yaml api-reference/openapi.json get /v1/companies/{company_id}/reports/{report_id}
openapi: 3.0.0
info:
  description: Validate, store, and query compliance carbon data.
  title: NueBorder API
  termsOfService: https://nueborder.com/terms/
  contact:
    name: Jack Dunlap
    url: https://nueborder.com/support
    email: support@nueborder.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
servers:
  - url: https://nueborder.com/api/v1
security: []
externalDocs:
  description: OpenAPI
  url: https://nueborder.com/openapi/
paths:
  /v1/companies/{company_id}/reports/{report_id}:
    get:
      tags:
        - General Report
      summary: Get General Report
      description: >-
        Retrieves general report information from the database based on URL
        params :company_id and :report_id.
      parameters:
        - example: '"12345"'
          description: Company ID associated with the general report
          name: company_id
          in: path
          required: true
          schema:
            type: string
        - example: '"67890"'
          description: Report ID associated with the general report
          name: report_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >-
            Successfully retrieved general report information"
            example({"status": "success", "data": {...}})
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/flat.QReportType'
        '400':
          description: >-
            Occurs when the company_id or report_id is missing or invalid"
            example({"status": "error", "message": "Invalid parameters"})
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.JSONPayloadErrorResponse'
        '500':
          description: >-
            Internal database error, possibly due to network or data integrity
            issues" example({"status": "error", "message": "Internal server
            error"})
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.InternalServerErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    flat.QReportType:
      description: Summary of Struct
      type: object
      required:
        - additional_information
        - declarant_actor_address_city
        - declarant_actor_address_country
        - declarant_identification_number
        - declarant_name
        - importer_address_city
        - importer_address_country
        - importer_identification_number
        - importer_name
        - reporting_period
        - representative_address_city
        - representative_address_country
        - representative_identification_number
        - representative_name
        - role
        - signatures
        - year
      properties:
        additional_information:
          description: >-
            Additional Information Additional Information (Min Length: 1, Max
            Length: 512)
          type: string
          example: Goods' additional information
        companyID:
          description: Company identifier
          type: integer
        createdAt:
          description: Creation time
          type: string
        declarant_actor_address_city:
          description: >-
            The city where the Declarant is located. The city where the
            Declarant is located. The city where the importer is located. The
            city where the Declarant is located. The city where the importer is
            located. The city where the operator is located. (Min Length: 1, Max
            Length: 35)
          type: string
          example: Declarant city
        declarant_actor_address_country:
          description: >-
            The country where the Declarant is established The country where the
            Indirect customs representative is established The country where the
            Importer is established The country where the Indirect customs
            representative is established The country where the Importer is
            established  . (Min Length: 2, Max Length: 2)
          type: string
          example: BE
        declarant_identification_number:
          description: >-
            The Declarant's Economic Operators Registration and Identification
            (EORI) Number (Min Length: 1, Max Length: 17)
          type: string
          example: BE1457893
        declarant_name:
          description: >-
            The full name (person or company) of the Declarant. (Min Length: 1,
            Max Length: 70)
          type: string
          example: Declarant CBAM
        importer_address_city:
          description: >-
            The city where the Declarant is located. The city where the
            Declarant is located. The city where the importer is located. The
            city where the Declarant is located. The city where the importer is
            located. The city where the operator is located. (Min Length: 1, Max
            Length: 35)
          type: string
          example: Declarant city
        importer_address_country:
          description: >-
            The country where the Declarant is established The country where the
            Indirect customs representative is established The country where the
            Importer is established The country where the Indirect customs
            representative is established The country where the Importer is
            established  . (Min Length: 2, Max Length: 2)
          type: string
          example: BE
        importer_identification_number:
          description: >-
            The Importer's Economic Operators Registration and Identification
            The Importer's Economic Operators Registration and Identification
            (EORI) Number (EORI) Number (Min Length: 1, Max Length: 17)
          type: string
          example: GR293847584930295
        importer_name:
          description: >-
            The full name The full name (person or company) of the importer.
            (person or company) of the importer. (Min Length: 1, Max Length: 70)
          type: string
          example: Declarant CBAM
        internalReportID:
          description: Internal report ID
          type: integer
        organizationID:
          description: Organization identifier
          type: integer
        reporting_period:
          description: >-
            The Quarter of the year. (Q1,Q2,Q3,Q4) (Min Length: 2, Max Length:
            2)
          type: string
          example: Q3
        representative_address_city:
          description: >-
            The city where the Declarant is located. The city where the
            Declarant is located. The city where the importer is located. The
            city where the Declarant is located. The city where the importer is
            located. The city where the operator is located. (Min Length: 1, Max
            Length: 35)
          type: string
          example: Declarant city
        representative_address_country:
          description: >-
            The country where the Declarant is established The country where the
            Indirect customs representative is established The country where the
            Importer is established The country where the Indirect customs
            representative is established The country where the Importer is
            established  . (Min Length: 2, Max Length: 2)
          type: string
          example: BE
        representative_identification_number:
          description: >-
            The Representative's Economic Operators Registration and
            Identification The Representative's Economic Operators Registration
            and Identification (EORI) Number (EORI) Number (Min Length: 1, Max
            Length: 17)
          type: string
          example: IT293847584930295
        representative_name:
          description: >-
            The full name The full name (person or company) of the Indirect
            customs representative. (person or company) of the Indirect customs
            representative. (Min Length: 1, Max Length: 70)
          type: string
          example: Representative CBAM
        role:
          description: >-
            The role that the Declarant has. If they are the importer or a
            Indirect customs representative. (Min Length: 1, Max Length: 5)
          type: string
          example: '01'
        signatures:
          description: ''
          allOf:
            - $ref: '#/components/schemas/flat.SignaturesType'
        submission_date:
          description: >-
            The submission date of the report. (Pattern:
            \d{4}-\d\d-\d\dT\d\d:\d\d:\d\dZ)
          type: string
          example: '2023-08-08T08:21:14Z'
        updatedAt:
          description: Last update time
          type: string
        updatedBy:
          description: Updater identifier
          type: string
        version:
          description: Report Versions
          type: string
        year:
          description: 'The year for which the report is submitted. (Total Digits: 4)'
          type: integer
          example: 2024
    models.JSONPayloadErrorResponse:
      description: A response indicating that the JSON payload is invalid.
      type: object
      properties:
        message:
          description: A detailed error message.
          type: string
          example: The JSON payload is invalid
        status:
          description: HTTP status code.
          type: integer
          example: 400
    models.InternalServerErrorResponse:
      description: A response indicating that an internal server error occurred.
      type: object
      properties:
        message:
          description: A detailed error message.
          type: string
          example: An internal server error occurred
        status:
          description: HTTP status code.
          type: integer
          example: 500
    flat.SignaturesType:
      description: Summary of Struct
      type: object
      required:
        - global_data_confirmation
        - other_applicable_reporting_methodology
        - position_of_person_sending
        - signature
        - signature_place
        - use_of_data_confirmation
      properties:
        global_data_confirmation:
          description: >-
            This element holds the confirmation of the Declarant regarding the
            information of the CBAM Report.
          type: boolean
          example: true
        other_applicable_reporting_methodology:
          description: 'This element is used to hold the Position of the Declarant '
          type: boolean
          example: true
        position_of_person_sending:
          description: >-
            This element is used to hold the full name of the Declarant. (Min
            Length: 1, Max Length: 128)
          type: string
          example: Position of person signing
        signature:
          description: >-
            This element holds the place where the confirmation was signed. (Min
            Length: 1, Max Length: 128)
          type: string
          example: Signature (Full Name)
        signature_place:
          description: >-
            This element holds the date when the confirmation was signed. (Min
            Length: 1, Max Length: 128)
          type: string
          example: Place of signature
        use_of_data_confirmation:
          description: >-
            This element holds the confirmation of the Declarant regarding his
            approval to use the data of the CBAM Report for the review process.
          type: boolean
          example: true
  securitySchemes:
    BearerAuth:
      description: 'Provide your Bearer token in the format: Bearer <your_api_key>'
      type: apiKey
      name: Authorization
      in: header

````