openapi: 3.1.1
info:
  title: Opal Fines Service - Business Units
  version: 1.0.0
  description: APIs for Business unit information
paths:
  /business-units/outstanding-auto-payment-count:
    get:
      tags:
        - businessUnitOutstandingAutoPayment
      summary: Get outstanding auto payment count
      description: >
        Get all business units where the user has the Process and Allocate Payments permission. Return their
        pending interface files and tills to allocate count
      security:
        - permissions:
            - Filter returned Business Units to those where the user has Process and Allocate Payments permission
      operationId: getBusinessUnitOutstandingAutoPaymentCount
      responses:
        "200":
          description: Business unit outstanding auto payment count response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessUnitsOutstandingAutoPaymentResponse'
        "400":
          description: Bad request
          content:
            application/json+problem:
              schema:
                $ref: './common.yaml#/components/schemas/ProblemDetail'
        "401":
          description: Unauthorized
          content:
            application/json+problem:
              schema:
                $ref: './common.yaml#/components/schemas/ProblemDetail'
        "403":
          description: Forbidden
          content:
            application/json+problem:
              schema:
                $ref: './common.yaml#/components/schemas/ProblemDetail'
        "500":
          description: Internal server error
          content:
            application/json+problem:
              schema:
                $ref: './common.yaml#/components/schemas/ProblemDetail'
        "503":
          description: Service unavailable
          content:
            application/json+problem:
              schema:
                $ref: './common.yaml#/components/schemas/ProblemDetail'

components:
  schemas:
    BusinessUnitsOutstandingAutoPaymentResponse:
      type: object
      additionalProperties: false
      required:
        - business_units
      properties:
        business_units:
          type: array
          items:
            $ref: '#/components/schemas/BusinessUnitsOutstandingAutoPaymentItem'

    BusinessUnitsOutstandingAutoPaymentItem:
      type: object
      additionalProperties: false
      required:
        - business_unit_id
        - business_unit_name
        - file_count
        - till_count
      properties:
        business_unit_id:
          type: integer
          format: int16
        business_unit_name:
          type: string
        file_count:
          type: integer
          format: int64
        till_count:
          type: integer
          format: int64