openapi: 3.2.0
info:
  title: FIS® Accounting Data as a Service™ Dispute Controller V2 API
  description: What's changed in our API
  version: v2
  contact: {}
servers:
- url: https://api.railz.ai
  description: Main (production) API server
tags:
- name: DisputeControllerV2
paths:
  /v2/commerce/disputes:
    get:
      description: '**Supported for:**


        `shopify` `square`'
      operationId: dispute
      parameters:
      - name: connectionUuid
        required: true
        in: query
        description: Unique connection identifier.
        schema:
          example: CON-396d5daa-26b2-4979-89b6-cafb2c298155
          type: string
      - name: offset
        required: false
        in: query
        description: The offset is the position in the dataset of a particular record.
        schema:
          format: integer
          type: number
      - name: limit
        required: false
        in: query
        description: 'This is the size of the results set you would like (default: 100).'
        schema:
          format: integer
          example: 100
          type: number
      - name: orderBy
        required: false
        in: query
        schema:
          type: string
      - name: id
        required: false
        in: query
        schema:
          example: '12345'
          type: string
      - name: status
        required: false
        in: query
        schema:
          example: processing
          type: string
          enum:
          - evidenceRequired
          - inquiryProcessing
          - processing
          - inquiryClosed
          - chargeRefunded
          - inquiryAccepted
          - inquiryWon
          - inquiryLost
          - unknown
          - other
      - name: startDate
        required: false
        in: query
        schema:
          example: '2014-04-25'
          type: string
      - name: endDate
        required: false
        in: query
        schema:
          example: '2014-04-25'
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDisputeResponseV2Dto'
        '202':
          description: Data in pending state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDisputeResponseV2Dto'
        '204':
          description: No data available
        '400':
          description: Bad Request Error - Thrown if fields sent via query does not follow specifications
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400ResponseDtoV2'
        '401':
          description: Unauthorized - Not logged in or log in expired
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401ResponseDto'
        '403':
          description: Forbidden - Not enough permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403ResponseDto'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500ResponseDto'
      security:
      - bearer: []
      summary: List Disputes
      tags:
      - DisputeControllerV2
components:
  schemas:
    Error403ResponseDto:
      type: object
      properties:
        error:
          readOnly: true
          allOf:
          - $ref: '#/components/schemas/Error403Dto'
        payload:
          type: object
          readOnly: true
          example: {}
      required:
      - error
      - payload
    Error401Dto:
      type: object
      properties:
        statusCode:
          type: number
          readOnly: true
          example: 401
        message:
          readOnly: true
          example:
          - Unauthorized
          type: array
          items:
            type: string
        error:
          type: string
          readOnly: true
          example: Unauthorized
      required:
      - statusCode
      - message
      - error
    OrderRef:
      type: object
      properties:
        id:
          type: string
          example: '625362839'
        orderNumber:
          type: string
          example: '1001'
      required:
      - id
    Error500Dto:
      type: object
      properties:
        error:
          type: string
          readOnly: true
          example: Internal Server Error
        message:
          readOnly: true
          example:
          - INTERNAL_ERROR
          type: array
          items:
            type: string
        statusCode:
          type: number
          readOnly: true
          example: 500
      required:
      - error
      - message
      - statusCode
    Error400DtoV2:
      type: object
      properties:
        statusCode:
          type: number
          readOnly: true
          example: 400
        message:
          readOnly: true
          example:
          - connectionUuid should not be empty
          type: array
          items:
            type: string
        error:
          type: string
          readOnly: true
          example: Bad Request
      required:
      - statusCode
      - message
      - error
    Error403Dto:
      type: object
      properties:
        statusCode:
          type: number
          readOnly: true
          example: 403
        message:
          readOnly: true
          example:
          - Forbidden resource
          type: array
          items:
            type: string
        error:
          type: string
          readOnly: true
          example: Forbidden
      required:
      - statusCode
      - message
      - error
    GetDisputeData:
      type: object
      properties:
        id:
          type: string
          example: '1052608616'
        totalAmount:
          type: number
          example: 100
          format: float
        status:
          type: string
          example: processing
          enum:
          - evidenceRequired
          - inquiryProcessing
          - processing
          - inquiryClosed
          - chargeRefunded
          - inquiryAccepted
          - inquiryWon
          - inquiryLost
          - unknown
          - other
        reason:
          type: string
          example: subscriptionCanceled
          enum:
          - bankNotProcessed
          - creditNotProcessed
          - debitNotAuthorized
          - duplicate
          - fraudulent
          - general
          - incorrectAccountDetails
          - insufficientFunds
          - productNotReceived
          - productUnacceptable
          - subscriptionCanceled
          - unrecognized
          - unknown
          - other
        dueDate:
          format: date-time
          type: string
          example: 2022-03-11T11:29:03-05:00"
        createdDate:
          format: date-time
          type: string
          example: 2022-03-11T11:29:03-05:00"
        sourceModifiedDate:
          format: date-time
          type: string
          example: 2022-03-11T11:29:03-05:00"
        orderRef:
          $ref: '#/components/schemas/OrderRef'
        currencyRef:
          $ref: '#/components/schemas/CommerceCurrencyRef'
      required:
      - id
      - totalAmount
      - status
      - reason
      - dueDate
      - createdDate
    Error401ResponseDto:
      type: object
      properties:
        error:
          readOnly: true
          allOf:
          - $ref: '#/components/schemas/Error401Dto'
        payload:
          type: object
          readOnly: true
          example: {}
      required:
      - error
      - payload
    Error400ResponseDtoV2:
      type: object
      properties:
        error:
          readOnly: true
          allOf:
          - $ref: '#/components/schemas/Error400DtoV2'
        payload:
          type: object
          readOnly: true
      required:
      - error
      - payload
    PaginationMetaData:
      type: object
      properties:
        offset:
          type: number
          readOnly: true
        limit:
          type: number
          readOnly: true
        count:
          type: number
          readOnly: true
      required:
      - offset
      - limit
      - count
    CommerceCurrencyRef:
      type: object
      properties:
        id:
          type: string
        symbol:
          type: string
          example: CAD
        name:
          type: string
          example: Canadian Dollar
      required:
      - symbol
      - name
    Error500ResponseDto:
      type: object
      properties:
        error:
          readOnly: true
          allOf:
          - $ref: '#/components/schemas/Error500Dto'
        payload:
          type: object
          readOnly: true
      required:
      - error
      - payload
    BasicStartEndDateReportMetaDataV2:
      type: object
      properties:
        connectionUuid:
          type: string
          readOnly: true
          example: CON-396d5daa-26b2-4979-89b6-cafb2c298155
        businessName:
          type: string
          readOnly: true
          example: Railz
        serviceName:
          type: string
          readOnly: true
          example: xero
          enum:
          - freshbooks
          - quickbooks
          - quickbooksDesktop
          - xero
          - oracleNetsuite
          - sageBusinessCloud
          - sageIntacct
          - dynamicsBusinessCentral
          - dynamics365Finance
          - wave
          - myob
          - zohoBooks
          - byod
        reportId:
          readOnly: true
          example:
          - 5fad8a342a88364234392fb5
          type: array
          items:
            type: string
        createdAt:
          type: string
          readOnly: true
          example: '2020-11-25T01:02:03Z'
          format: date-time
        updatedAt:
          type: string
          example: '2020-11-30T01:02:03Z'
          format: date-time
          readOnly: false
        startDate:
          type: string
          readOnly: true
          example: '2020-11-25T01:02:03Z'
          format: date-time
        endDate:
          type: string
          readOnly: true
          example: '2020-11-30T01:02:03Z'
          format: date-time
      required:
      - connectionUuid
      - businessName
      - serviceName
      - reportId
      - createdAt
      - updatedAt
      - startDate
      - endDate
    GetDisputeResponseV2Dto:
      type: object
      properties:
        count:
          type: number
          readOnly: true
          example: 1
          format: integer
          deprecated: true
        pagination:
          $ref: '#/components/schemas/PaginationMetaData'
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetDisputeData'
        meta:
          $ref: '#/components/schemas/BasicStartEndDateReportMetaDataV2'
      required:
      - count
      - pagination
      - data
      - meta
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http