Recurly Outbound Report APIs API

openapi: 3.2.0
info:
  title: Recurly Outbound Report APIs API
  version: 1.9.0
  description: 'Operations tagged Outbound Report APIs across 2 of this provider''s published API definitions: recurly-revrec-api.json, recurly-revrec-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://revrec.recurly.com
security:
- basicAuth: []
tags:
- name: Outbound Report APIs
paths:
  /api/report/getReportData:
    post:
      tags:
      - Outbound Report APIs
      summary: Get Report Data
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                layoutId:
                  type: integer
                  description: unique identifier for the layout
                layoutName:
                  type: string
                  description: unique identifier for the layout
                entityName:
                  type: string
                  description: Entity Name filters or labels the specific entity, layout target, or config item for the requested report.
                reportId:
                  type: integer
                  description: Report ID identifies the kind of report being requested.
                reportType:
                  type: integer
                  description: Report Type identifies the kind of line data to include in the requested report.
                bookId:
                  type: integer
                  description: Book ID is the ID for the book to be included in the requested report
                netType:
                  type: integer
                  description: Net Type determines whether the report should present gross values, net values, or another supported balance basis.
                currencyType:
                  type: integer
                  description: Currency Type identifies the currency that should be used for the requested reports.
                download:
                  type: boolean
                  description: True will return all data by compressing the csv file. false will return csv file with first 1000 rows( mainly used for validation)
                periodId:
                  type: integer
                  description: Period ID identifies the accounting period in which to run the requested report. For waterfall reports, this will be the ending period of the requested report.
                layoutFields:
                  type: array
                  items:
                    type: object
                    properties:
                      fieldConfigId:
                        type: string
                        description: Field Config ID identifies the report field definition used in the saved layout filter or prompt.
                      value:
                        type:
                        - string
                        - 'null'
                        description: Value is the user-selected filter or prompt value for the corresponding layout field.
                      indicator:
                        type: integer
                        format: int32
                        description: Indicator controls field behavior in the layout, such as search, grouping, or other supported flags.
                waterFallType:
                  type: integer
                  description: Waterfall Type determines if requested waterfall report should include actuals, forecast, or both.
                summarized:
                  type: boolean
                  description: Summarized indicates whether the report should return summarized output instead of detailed transaction-level rows.
              example:
                layoutId: 0
                reportId: 3
                reportType: 1
                bookId: 1
                netType: 1
                currencyType: 0
                download: true
                periodId: 1
                layoutFields:
                - fieldConfigId: 13
                  value: USD
                  indicators: 0
                waterFallType: 0
                summarized: true
      responses:
        '200':
          description: Report data fetched
      operationId: postApiReportGetReportData
      x-operation-id-source: derived
    servers:
    - url: https://revrec.recurly.com
  /api/transfer/getTransferBatches:
    get:
      tags:
      - Outbound Report APIs
      summary: Get Transfer Batches
      parameters:
      - name: periodId
        in: query
        required: true
        description: Period ID identifies the accounting period for which the transfer batches are requested
        schema:
          type: integer
          example: 2210
      responses:
        '200':
          description: Transfer batches retrieved successfully
          content:
            application/json:
              example:
              - batchId: 10031
                status: 1
                postedPeriod: 0
                approveBy: 0
                approveDate: null
                transferBy: 0
                transferDate: null
                ErrorMsg: null
                bookId: 1
                creationDate: '2024-04-29T05:06:40Z'
                PeriodCreated: 2404
              - batchId: 10030
                status: 3
                postedPeriod: 0
                approveBy: 1
                approveDate: '2024-04-29T05:06:40Z'
                transferBy: 0
                transferDate: null
                ErrorMsg: null
                bookId: 1
                creationDate: '2024-04-29T05:02:17Z'
                PeriodCreated: 2404
      operationId: getApiTransferGetTransferBatches
      x-operation-id-source: derived
    servers:
    - url: https://revrec.recurly.com
  /api/transfer/getEligibleTransferBatches:
    get:
      tags:
      - Outbound Report APIs
      summary: Get Eligible Transfer Batches
      responses:
        '200':
          description: Eligible transfer batches retrieved successfully
          content:
            application/json:
              example:
              - batchId: 10031
                status: 3
                postedPeriod: 0
                approveBy: 0
                approveDate: null
                transferBy: 0
                transferDate: null
                ErrorMsg: null
                bookId: 1
                creationDate: '2024-04-29T05:06:40Z'
                PeriodCreated: 2404
              - batchId: 10030
                status: 3
                postedPeriod: 0
                approveBy: 1
                approveDate: '2024-04-29T05:06:40Z'
                transferBy: 0
                transferDate: null
                ErrorMsg: null
                bookId: 1
                creationDate: '2024-04-29T05:02:17Z'
                PeriodCreated: 2404
      operationId: getApiTransferGetEligibleTransferBatches
      x-operation-id-source: derived
    servers:
    - url: https://revrec.recurly.com
  /api/transfer/getEligibleApproveBatches:
    get:
      tags:
      - Outbound Report APIs
      summary: Get Eligible Approve Batches
      responses:
        '200':
          description: Eligible approve batches retrieved successfully
          content:
            application/json:
              example:
              - batchId: 10031
                status: 1
                postedPeriod: 0
                approveBy: 0
                approveDate: null
                transferBy: 0
                transferDate: null
                ErrorMsg: null
                bookId: 1
                creationDate: '2024-04-29T05:06:40Z'
                PeriodCreated: 2404
              - batchId: 10030
                status: 3
                postedPeriod: 0
                approveBy: 1
                approveDate: '2024-04-29T05:06:40Z'
                transferBy: 0
                transferDate: null
                ErrorMsg: null
                bookId: 1
                creationDate: '2024-04-29T05:02:17Z'
                PeriodCreated: 2404
      operationId: getApiTransferGetEligibleApproveBatches
      x-operation-id-source: derived
    servers:
    - url: https://revrec.recurly.com
  /api/transfer/markTransferred:
    put:
      tags:
      - Outbound Report APIs
      summary: Mark Transfer Batch
      parameters:
      - name: batchId
        in: query
        description: Transfer Batch Id
        required: true
        schema:
          type: integer
          example: 10019
      responses:
        '200':
          description: Transfer batch marked successfully
      operationId: putApiTransferMarkTransferred
      x-operation-id-source: derived
    servers:
    - url: https://revrec.recurly.com
  /api/transfer/approveTransferBatch:
    put:
      tags:
      - Outbound Report APIs
      summary: Approve Transfer Batch
      parameters:
      - name: batchId
        in: query
        description: Transfer Batch Id
        required: true
        schema:
          type: integer
          example: 10005
      responses:
        '200':
          description: Transfer batch approved successfully
      operationId: putApiTransferApproveTransferBatch
      x-operation-id-source: derived
    servers:
    - url: https://revrec.recurly.com
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'Authentication scheme using Basic Auth where the API key is provided as the username and the password is blank.


        Example usage:

        If your API key is `110eee7324cf4146ac875db3108f175c`, then the Authorization header should be:

        `Authorization: Basic MTEwZWVlNzMyNGNmNDE0NmFjODc1ZGIzMTA4ZjE3NWM6`


        This value is the Base64 encoding of the string `110eee7324cf4146ac875db3108f175c:` (note the trailing colon for empty password).'
x-refined-from:
- recurly-revrec-api.json
- recurly-revrec-openapi.yml
x-readme:
  explorer-enabled: false