Solvimon reports API

openapi: 3.2.0
info:
  title: Configuration alertRules Reports API
  version: 1.0.0
servers:
- url: https://test.api.solvimon.com
  description: The TEST environment for our API
- url: https://api.solvimon.com
  description: The live environment for our API
tags:
- name: reports
paths:
  /v{version}/reports:
    get:
      operationId: getReports
      summary: Get Reports
      description: Requires the REPORT.VIEW permission.
      tags:
      - reports
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: limit
        in: query
        description: The amount of records shown in the list
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: The page which is going to be shown
        required: false
        schema:
          type: integer
      - name: order_by
        in: query
        description: The parameter by which the response is ordered.
        required: false
        schema:
          type: string
      - name: order_direction
        in: query
        description: The order direction by which the response is ordered.
        required: false
        schema:
          type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportResponseWrapper'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/reports/{resourceId}:
    get:
      operationId: getReportsByResourceId
      summary: Get report
      description: Requires the REPORT.VIEW permission.
      tags:
      - reports
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceId
        in: path
        description: The ID of the resource to be requested.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Report'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/reports/{resourceId}/download-url:
    get:
      operationId: getReportsByResourceIdDownloadUrl
      summary: Get report download URL
      description: Requires the REPORT.VIEW permission.
      tags:
      - reports
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceId
        in: path
        description: The ID of the resource to be requested.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadUrl'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/reports/invoice-lines-overview:
    get:
      operationId: getReportsInvoiceLinesOverview
      summary: Get invoice lines report
      description: Requires the REPORT_GENERATE_REQUEST.CREATE permission.
      tags:
      - reports
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: customer_id
        in: query
        description: Filter based of customer ID
        required: false
        schema:
          type: string
      - name: statuses[]
        in: query
        description: Filter invoices based on invoice status(es)
        required: false
        schema:
          type: array
          items:
            type: string
      - name: invoice_date
        in: query
        description: Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
        required: false
        schema:
          type: string
      - name: paid
        in: query
        description: Filter invoices based on whether they're paid or not (true or false)
        required: false
        schema:
          type: string
      - name: on_hold
        in: query
        description: Filter invoices based on whether they're on hold or not (true or false)
        required: false
        schema:
          type: string
      - name: pricing_plan_subscription_id
        in: query
        description: Filter invoices by the pricing plan subscription id
        required: false
        schema:
          type: string
      - name: include_periods
        in: query
        description: Indicates whether the response should include period and group data (true or false)
        required: false
        schema:
          type: boolean
      - name: include_lines
        in: query
        description: Indicates whether the response should include invoice lines (true or false)
        required: false
        schema:
          type: boolean
      - name: limit
        in: query
        description: The amount of records shown in the list
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: The page which is going to be shown
        required: false
        schema:
          type: integer
      - name: order_by
        in: query
        description: The parameter by which the response is ordered.
        required: false
        schema:
          type: string
      - name: order_direction
        in: query
        description: The order direction by which the response is ordered.
        required: false
        schema:
          type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportGenerateRequest'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/reports/invoice-tax-overview:
    get:
      operationId: getReportsInvoiceTaxOverview
      summary: Get invoice tax report
      description: Requires the REPORT_GENERATE_REQUEST.CREATE permission.
      tags:
      - reports
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: customer_id
        in: query
        description: Filter based of customer ID
        required: false
        schema:
          type: string
      - name: statuses[]
        in: query
        description: Filter invoices based on invoice status(es)
        required: false
        schema:
          type: array
          items:
            type: string
      - name: invoice_date
        in: query
        description: Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
        required: false
        schema:
          type: string
      - name: paid
        in: query
        description: Filter invoices based on whether they're paid or not (true or false)
        required: false
        schema:
          type: string
      - name: on_hold
        in: query
        description: Filter invoices based on whether they're on hold or not (true or false)
        required: false
        schema:
          type: string
      - name: pricing_plan_subscription_id
        in: query
        description: Filter invoices by the pricing plan subscription id
        required: false
        schema:
          type: string
      - name: include_periods
        in: query
        description: Indicates whether the response should include period and group data (true or false)
        required: false
        schema:
          type: boolean
      - name: include_lines
        in: query
        description: Indicates whether the response should include invoice lines (true or false)
        required: false
        schema:
          type: boolean
      - name: limit
        in: query
        description: The amount of records shown in the list
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: The page which is going to be shown
        required: false
        schema:
          type: integer
      - name: order_by
        in: query
        description: The parameter by which the response is ordered.
        required: false
        schema:
          type: string
      - name: order_direction
        in: query
        description: The order direction by which the response is ordered.
        required: false
        schema:
          type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportGenerateRequest'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/reports/invoice-headers-overview:
    get:
      operationId: getReportsInvoiceHeadersOverview
      summary: Get invoice header report
      description: Requires the REPORT_GENERATE_REQUEST.CREATE permission.
      tags:
      - reports
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: customer_id
        in: query
        description: Filter based of customer ID
        required: false
        schema:
          type: string
      - name: statuses[]
        in: query
        description: Filter invoices based on invoice status(es)
        required: false
        schema:
          type: array
          items:
            type: string
      - name: invoice_date
        in: query
        description: Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
        required: false
        schema:
          type: string
      - name: paid
        in: query
        description: Filter invoices based on whether they're paid or not (true or false)
        required: false
        schema:
          type: string
      - name: on_hold
        in: query
        description: Filter invoices based on whether they're on hold or not (true or false)
        required: false
        schema:
          type: string
      - name: pricing_plan_subscription_id
        in: query
        description: Filter invoices by the pricing plan subscription id
        required: false
        schema:
          type: string
      - name: include_periods
        in: query
        description: Indicates whether the response should include period and group data (true or false)
        required: false
        schema:
          type: boolean
      - name: include_lines
        in: query
        description: Indicates whether the response should include invoice lines (true or false)
        required: false
        schema:
          type: boolean
      - name: limit
        in: query
        description: The amount of records shown in the list
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: The page which is going to be shown
        required: false
        schema:
          type: integer
      - name: order_by
        in: query
        description: The parameter by which the response is ordered.
        required: false
        schema:
          type: string
      - name: order_direction
        in: query
        description: The order direction by which the response is ordered.
        required: false
        schema:
          type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportGenerateRequest'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/reports/search:
    post:
      operationId: postReportsSearch
      summary: Search reports
      description: Requires the REPORT.VIEW permission.
      tags:
      - reports
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: expand[]
        in: query
        description: The id fields of the resources that are going to be expanded.
        required: false
        schema:
          type: array
          items:
            type: string
      - name: limit
        in: query
        description: The amount of records shown in the list
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: The page which is going to be shown
        required: false
        schema:
          type: integer
      - name: order_by
        in: query
        description: The parameter by which the response is ordered. default = name
        required: false
        schema:
          type: string
      - name: order_direction
        in: query
        description: The parameter for the response ordering direction (asc, desc) default asc
        required: false
        schema:
          type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportResponseWrapper'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCreateRequest'
  /v{version}/report-generate-requests:
    get:
      operationId: getReportGenerateRequests
      summary: Get ReportGenerateRequests
      description: Requires the REPORT_GENERATE_REQUEST.VIEW permission.
      tags:
      - reports
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: limit
        in: query
        description: The amount of records shown in the list
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: The page which is going to be shown
        required: false
        schema:
          type: integer
      - name: order_by
        in: query
        description: The parameter by which the response is ordered.
        required: false
        schema:
          type: string
      - name: order_direction
        in: query
        description: The order direction by which the response is ordered.
        required: false
        schema:
          type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportGenerateRequestResponseWrapper'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    post:
      operationId: postReportGenerateRequests
      summary: Create a ReportGenerateRequest
      description: Requires the REPORT_GENERATE_REQUEST.CREATE permission.
      tags:
      - reports
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportGenerateRequest'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportGenerateRequestCreateRequest'
  /v{version}/report-generate-requests/search:
    post:
      operationId: postReportGenerateRequestsSearch
      summary: Search ReportGenerateRequests
      description: Requires the REPORT_GENERATE_REQUEST.VIEW permission.
      tags:
      - reports
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: expand[]
        in: query
        description: The id fields of the resources that are going to be expanded.
        required: false
        schema:
          type: array
          items:
            type: string
      - name: limit
        in: query
        description: The amount of records shown in the list
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: The page which is going to be shown
        required: false
        schema:
          type: integer
      - name: order_by
        in: query
        description: The parameter by which the response is ordered. default = name
        required: false
        schema:
          type: string
      - name: order_direction
        in: query
        description: The parameter for the response ordering direction (asc, desc) default asc
        required: false
        schema:
          type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportGenerateRequestResponseWrapper'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCreateRequest'
  /v{version}/report-generate-requests/{resourceId}:
    get:
      operationId: getReportGenerateRequestsByResourceId
      summary: Get ReportGenerateRequest
      description: Requires the REPORT_GENERATE_REQUEST.VIEW permission.
      tags:
      - reports
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceId
        in: path
        description: The ID of the resource to be requested.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportGenerateRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/report-generate-requests/{resourceId}/report:
    get:
      operationId: getReportGenerateRequestsByResourceIdReport
      summary: Get Report
      description: Requires the REPORT.VIEW permission.
      tags:
      - reports
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceId
        in: path
        description: The ID of the resource to be requested.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Report'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    ReportGenerateRequestCreateRequestReportCode:
      type: string
      enum:
      - INVOICE
      - INVOICE_USAGE
      - INVOICE_HEADER
      - INVOICE_LINE
      - INVOICE_TAX
      - INVOICE_COMMITMENT
      - CHILD_PARENT_BREAKDOWN
      - CHILD_PARENT_BREAKDOWN_PLATFORM
      - NOT_MATCHED_METER_DATA
      - DUPLICATE_METER_DATA
      - METERING
      - CUSTOMER
      - PRODUCT
      - PRICING_PLAN_SUBSCRIPTION
      - PAYMENT
      - PRICING
      - REVENUE_RECOGNITION
      - CLAUSES
      title: ReportGenerateRequestCreateRequestReportCode
    PaginationLinks:
      type: object
      properties:
        first:
          type:
          - string
          - 'null'
        previous:
          type:
          - string
          - 'null'
        current:
          type:
          - string
          - 'null'
        next:
          type:
          - string
          - 'null'
      title: PaginationLinks
    ReportGenerateRequestCreateRequest:
      type: object
      properties:
        object_type:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        customer_id:
          type:
          - string
          - 'null'
          description: Resource ID of type CUSTOMER
        invoice_id:
          type:
          - string
          - 'null'
          description: Resource ID of type INVOICE
        generate_at:
          type: string
          format: date-time
        report_code:
          $ref: '#/components/schemas/ReportGenerateRequestCreateRequestReportCode'
        parameter_values:
          type: array
          items:
            $ref: '#/components/schemas/ReportParameterValueCreateRequest'
        status:
          type:
          - string
          - 'null'
        report_subscription_id:
          type:
          - string
          - 'null'
        report_configuration_id:
          type: string
          description: Resource ID of type REPORT_CONFIGURATION
        run_type:
          type:
          - string
          - 'null'
        export_location:
          $ref: '#/components/schemas/ExportReportLocationCreateRequest'
      title: ReportGenerateRequestCreateRequest
    ApiErrorCode:
      type: string
      enum:
      - RESOURCE_NOT_FOUND
      - RESOURCES_NOT_FOUND
      - UNABLE_TO_PROCESS_INSTRUCTIONS
      - BAD_REQUEST
      - UNSUPPORTED_MEDIA_TYPE
      - RESOURCE_ALREADY_EXISTS
      - CUSTOM_FIELD_VALUE_ALREADY_EXISTS
      - COULD_NOT_CREATE_RESOURCE
      - COULD_NOT_UPDATE_RESOURCE
      - COULD_NOT_DELETE_RESOURCE
      - MISSING_VERSION
      - UNSUPPORTED_VERSION
      - UNAUTHORISED
      - CUSTOMER_NOT_FOUND
      - PLATFORM_NOT_FOUND
      - PRICING_PLAN_NOT_FOUND
      - PRODUCT_NOT_FOUND
      - PRODUCT_ITEM_NOT_FOUND
      - PRICING_NOT_FOUND
      - PRICING_ITEM_NOT_FOUND
      - USER_NOT_FOUND
      - MET

# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/solvimon/refs/heads/main/openapi/solvimon-reports-api-openapi.yml