openapi: 3.2.0
info:
  title: Kelowna Production Credit Sales API
  version: v1
tags:
- name: CreditSales
paths:
  /CreditSales/DownloadTemplate:
    get:
      tags:
      - CreditSales
      summary: Downloads template for entering credit sale details
      description: Only includes rows for sales where data is missing by default.
      parameters:
      - name: includeAll
        in: query
        description: Whether data for all details should be included, even if no information is missing.
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      operationId: getCreditSalesDownloadTemplate
      x-operation-id-source: derived
  /CreditSales/UploadTemplate:
    put:
      tags:
      - CreditSales
      summary: Uploads template for credit sale details
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: CSV file containing sale data.
                  format: binary
            encoding:
              file:
                style: form
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      operationId: putCreditSalesUploadTemplate
      x-operation-id-source: derived
components:
  securitySchemes:
    OrcaAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.carboncure.com/oauth2/authorize
          tokenUrl: https://auth.carboncure.com/oauth2/token
          scopes: {}
    MyCCAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.carboncure.com/oauth2/authorize
          tokenUrl: https://auth.carboncure.com/oauth2/token
          scopes: {}
    M2MAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.carboncure.com/oauth2/authorize
          tokenUrl: https://auth.carboncure.com/oauth2/token
          scopes: {}