openapi: 3.2.0
info:
  title: Folio Reports API
  version: 3.2.0
  contact:
    name: Knowledge Integration
    url: https://www.k-int.com
  description: 'Operations tagged Reports across 2 of this provider''s published API definitions: folio-mod-oa-openapi.json, folio-mod-oa-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://folio-snapshot-okapi.dev.folio.org
- url: https://folio-snapshot-2-okapi.dev.folio.org
- url: https://folio-etesting-snapshot-kong.ci.folio.org
security:
- accessToken: []
- okapiToken: []
tags:
- name: Reports
paths:
  /oa/reports/openApcChargesReport:
    description: 'Exports a CSV report of open-access charges (APC) for the given filters. Streams the CSV body directly to the response - there is no pagination, and the server does not set a `Content-Type` header on the response (only `Content-Disposition: attachment; filename=export.csv`).'
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    get:
      tags:
      - Reports
      summary: Get an open-access charges CSV report
      operationId: getOpenApcChargesReport
      parameters:
      - in: query
        name: institution
        description: Not used to filter the underlying query - included verbatim as the `institution` column value on every output row.
        schema:
          type: string
      - in: query
        name: paymentPeriod
        schema:
          type: string
      - in: query
        name: chargeCategory
        description: Comma-separated list of Charge category refdata values.
        schema:
          type: string
      - in: query
        name: chargeStatus
        description: Comma-separated list of Charge status refdata values.
        schema:
          type: string
      responses:
        '200':
          description: 'OK. CSV body with columns: institution, period, euro, doi, is_hybrid, publisher, journal_full_title, issn, url. Invalid paymentPeriod or other failures in the query result in a CSV with header but  no rows, or missing whatever rows the failure prevented'
          content:
            text/csv:
              schema:
                type: string
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
  /oa/reports/openApcBpcReport:
    description: 'Exports a CSV report of book processing charges (BPC) for the given filters. Streams the CSV body directly to the response - there is no pagination, and the server does not set a `Content-Type` header on the response (only `Content-Disposition: attachment; filename=export.csv`).'
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    get:
      tags:
      - Reports
      summary: Get a book processing charges CSV report
      operationId: getOpenApcBpcReport
      parameters:
      - in: query
        name: institution
        description: Not used to filter the underlying query - included verbatim as the `institution` column value on every output row.
        schema:
          type: string
      - in: query
        name: paymentPeriod
        schema:
          type: string
      - in: query
        name: chargeCategory
        description: Comma-separated list of Charge category refdata values.
        schema:
          type: string
      - in: query
        name: chargeStatus
        description: Comma-separated list of Charge status refdata values.
        schema:
          type: string
      responses:
        '200':
          description: 'OK. CSV body with columns: institution, period, euro, doi, backlist_oa, book_title, isbn. Invalid paymentPeriod or other failures in the query result in a CSV with header but  no rows, or missing whatever rows the failure prevented'
          content:
            text/csv:
              schema:
                type: string
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
  /oa/reports/openApcTransformativeAgreementReport:
    description: 'Exports a CSV report of publication requests billed under a specific transformative agreement. Streams the CSV body directly to the response - there is no pagination, and the server does not set a `Content-Type` header on the response (only `Content-Disposition: attachment; filename=export.csv`).'
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    get:
      tags:
      - Reports
      summary: Get a transformative agreement CSV report
      operationId: getOpenApcTransformativeAgreementReport
      parameters:
      - in: query
        name: institution
        description: Not used to filter the underlying query - included verbatim as the `institution` column value on every output row.
        schema:
          type: string
      - in: query
        name: paymentPeriod
        schema:
          type: string
      - in: query
        name: publicationStatus
        description: PublicationStatus refdata value to filter on.
        schema:
          type: string
      - in: query
        name: agreementId
        description: Remote ID of the agreement to report on.
        schema:
          type: string
      responses:
        '200':
          description: 'OK. CSV body with columns: institution, period, doi, is_hybrid, publisher, journal_full_title, issn, url. Invalid paymentPeriod or other failures in the query result in a CSV with header but  no rows, or missing whatever rows the failure prevented'
          content:
            text/csv:
              schema:
                type: string
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
components:
  parameters:
    x-okapi-tenant:
      in: header
      name: x-okapi-tenant
      required: true
      schema:
        type: string
  securitySchemes:
    okapiToken:
      type: apiKey
      in: header
      name: x-okapi-token
    accessToken:
      type: apiKey
      in: cookie
      name: folioAccessToken
x-refined-from:
- folio-mod-oa-openapi.json
- folio-mod-oa-openapi.yml