openapi: 3.2.0
info:
  title: Enterprise Billing Billing Batch Information API
  description: Enterprise Billing API provides an API proxy to Salesforce using the Salesforce API.  For access requests, please visit https://crm.project.wiscweb.wisc.edu/enterprise-billing-api-request-form/.  For additional information, please visit https://kb.wisc.edu/uw-enterprise-billing-api/page.php?id=162438.
  version: 0.1.0
servers:
- url: https://doit.dev.api.wisc.edu/enterprise-billing
  description: Dev server
security:
- OAuth2ClientCredentials: []
tags:
- name: Billing Batch Information
paths:
  /billingBatch/{id}:
    parameters:
    - in: path
      name: id
      schema:
        type: string
      required: true
      description: Salesforce Billing Batch Id
    summary: represents Billing Batch information regarding a imported set of transactions
    get:
      tags:
      - Billing Batch Information
      summary: represents a single Billing Batch
      description: Retrieve Billing Batch information.
      responses:
        '200':
          description: A JSON representation of Billing Batch information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/billingBatch'
              example:
                totalSize: 5
                done: true
                records:
                  id: a0IDh000005sqp4MAA
                  name: Maddie Test B
                  type: ISP Provided
                  status: New
                  ispDataRecordCount: 3,
                  dataErrorRows: 0
        '403':
          $ref: '#/components/responses/NoAuthorization'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    billingBatch:
      title: Billing Batch
      description: Billing Batch information of submitted transaction data.
      type: object
      properties:
        totalSize:
          readOnly: true
          title: totalSize
          description: Number of response records.
          type: integer
        done:
          readOnly: true
          title: done
          description: Response complete.
          type: boolean
        records:
          description: A collection of BillingBatches.
          type: array
          items:
            description: A single BillingCustomer.
            type: object
            properties:
              id:
                readOnly: true
                title: Id
                description: Salesforce record identifier.
                type: string
                format: Salesforce Id
              name:
                readOnly: true
                title: Name
                description: Name of Billing Batch.
                type: string
              type:
                readOnly: true
                title: Type
                description: Type of Billing Batch.
                type: string
              status:
                readOnly: true
                title: Status
                description: Status of Billing Batch.
                type: string
              ispDataRecordCount:
                readOnly: true
                title: ISP Data Record Count
                description: Count of records per Billing Batch.
                type: integer
              dataErrorRows:
                readOnly: true
                title: Data Errors Rows
                description: Count of records with errors per Billing Batch.
                type: integer
    error:
      description: Error object
      type: object
      properties:
        message:
          type: string
  responses:
    NotFound:
      description: A specified resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            message: The requested resource does not exist
    NoAuthorization:
      description: Not authorized to access resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            message: Token not found.