openapi: 3.0.0
info:
  title: Coolset Carbon API
  description: >-
    Read-only access to emissions calculations, charts, and carbon footprint
    data.
  version: '1.0'
  contact:
    email: support@coolset.com
    url: https://coolset.com
servers:
  - url: https://developers-scranton.coolset.com/api
    description: Production server
paths:
  /emission_calculations/charts:
    get:
      operationId: emission_calculations_charts_list
      description: ''
      parameters:
        - name: journal
          in: query
          description: journal
          required: false
          schema:
            type: string
        - name: journal__icontains
          in: query
          description: journal__icontains
          required: false
          schema:
            type: string
        - name: journal__istartswith
          in: query
          description: journal__istartswith
          required: false
          schema:
            type: string
        - name: journal__iendswith
          in: query
          description: journal__iendswith
          required: false
          schema:
            type: string
        - name: journal__isnull
          in: query
          description: journal__isnull
          required: false
          schema:
            type: string
        - name: title
          in: query
          description: title
          required: false
          schema:
            type: string
        - name: title__icontains
          in: query
          description: title__icontains
          required: false
          schema:
            type: string
        - name: title__istartswith
          in: query
          description: title__istartswith
          required: false
          schema:
            type: string
        - name: title__iendswith
          in: query
          description: title__iendswith
          required: false
          schema:
            type: string
        - name: description
          in: query
          description: description
          required: false
          schema:
            type: string
        - name: description__icontains
          in: query
          description: description__icontains
          required: false
          schema:
            type: string
        - name: description__istartswith
          in: query
          description: description__istartswith
          required: false
          schema:
            type: string
        - name: description__iendswith
          in: query
          description: description__iendswith
          required: false
          schema:
            type: string
        - name: description__isnull
          in: query
          description: description__isnull
          required: false
          schema:
            type: string
        - name: vendor_name
          in: query
          description: vendor_name
          required: false
          schema:
            type: string
        - name: vendor_name__icontains
          in: query
          description: vendor_name__icontains
          required: false
          schema:
            type: string
        - name: vendor_name__istartswith
          in: query
          description: vendor_name__istartswith
          required: false
          schema:
            type: string
        - name: vendor_name__iendswith
          in: query
          description: vendor_name__iendswith
          required: false
          schema:
            type: string
        - name: vendor_name__isnull
          in: query
          description: vendor_name__isnull
          required: false
          schema:
            type: string
        - name: accounting_date
          in: query
          description: accounting_date
          required: false
          schema:
            type: string
        - name: accounting_date__gte
          in: query
          description: accounting_date__gte
          required: false
          schema:
            type: string
        - name: accounting_date__lte
          in: query
          description: accounting_date__lte
          required: false
          schema:
            type: string
        - name: is_activity_based_emission
          in: query
          description: is_activity_based_emission
          required: false
          schema:
            type: string
        - name: classification_category_id
          in: query
          description: classification_category_id
          required: false
          schema:
            type: string
        - name: classification_category_name
          in: query
          description: classification_category_name
          required: false
          schema:
            type: string
        - name: classification_category_name__icontains
          in: query
          description: classification_category_name__icontains
          required: false
          schema:
            type: string
        - name: classification_category_name__istartswith
          in: query
          description: classification_category_name__istartswith
          required: false
          schema:
            type: string
        - name: classification_category_name__iendswith
          in: query
          description: classification_category_name__iendswith
          required: false
          schema:
            type: string
        - name: sub_category_id
          in: query
          description: sub_category_id
          required: false
          schema:
            type: string
        - name: category_id
          in: query
          description: category_id
          required: false
          schema:
            type: string
        - name: ghg_category_id
          in: query
          description: ghg_category_id
          required: false
          schema:
            type: string
        - name: is_tag_along
          in: query
          description: is_tag_along
          required: false
          schema:
            type: string
        - name: confidence_status
          in: query
          description: confidence_status
          required: false
          schema:
            type: string
            enum:
              - confident
              - needs_attention
        - name: co2_kg
          in: query
          description: co2_kg
          required: false
          schema:
            type: string
        - name: co2_kg__gt
          in: query
          description: co2_kg__gt
          required: false
          schema:
            type: string
        - name: co2_kg__lt
          in: query
          description: co2_kg__lt
          required: false
          schema:
            type: string
        - name: co2_kg__gte
          in: query
          description: co2_kg__gte
          required: false
          schema:
            type: string
        - name: co2_kg__lte
          in: query
          description: co2_kg__lte
          required: false
          schema:
            type: string
        - name: scope
          in: query
          description: scope
          required: false
          schema:
            type: string
            enum:
              - '1'
              - '2'
              - '3'
              - Offset
              - Excluded
        - name: company_tags
          in: query
          description: company_tags
          required: false
          schema:
            type: string
        - name: flags_key_value
          in: query
          description: flags_key_value
          required: false
          schema:
            type: string
        - name: relative_to
          in: query
          description: relative_to
          required: false
          schema:
            type: string
            enum:
              - absolute
              - per_employee
              - per_revenue_unit
        - name: group_by
          in: query
          description: Fields to group by
          explode: true
          schema:
            type: array
            items:
              type: string
              enum:
                - date
                - main_emission
                - category_name
                - sub_category_name
                - ghg_category_name
                - scope
                - title
                - vendor_name
            default:
              - date
        - name: delimit_by
          in: query
          description: delimit_by
          required: false
          schema:
            type: string
            enum:
              - yearly
              - monthly
              - daily
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          schema:
            type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          schema:
            type: integer
        - name: ordering
          in: query
          description: Fields to order by (prefix with '-' for descending)
          schema:
            type: string
            enum:
              - date
              - '-date'
              - transaction_count
              - '-transaction_count'
              - total_co2_kg
              - '-total_co2_kg'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                required:
                  - count
                  - results
                type: object
                properties:
                  count:
                    type: integer
                  next:
                    type: string
                    format: uri
                    nullable: true
                  previous:
                    type: string
                    format: uri
                    nullable: true
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/EmissionChart'
      tags:
        - emission_calculations
      summary: Emission Calculations Charts List
    parameters: []
  /emission_calculations/emissions:
    get:
      operationId: emission_calculations_emissions_list
      description: ''
      parameters:
        - name: journal
          in: query
          description: journal
          required: false
          schema:
            type: string
        - name: journal__icontains
          in: query
          description: journal__icontains
          required: false
          schema:
            type: string
        - name: journal__istartswith
          in: query
          description: journal__istartswith
          required: false
          schema:
            type: string
        - name: journal__iendswith
          in: query
          description: journal__iendswith
          required: false
          schema:
            type: string
        - name: journal__isnull
          in: query
          description: journal__isnull
          required: false
          schema:
            type: string
        - name: title
          in: query
          description: title
          required: false
          schema:
            type: string
        - name: title__icontains
          in: query
          description: title__icontains
          required: false
          schema:
            type: string
        - name: title__istartswith
          in: query
          description: title__istartswith
          required: false
          schema:
            type: string
        - name: title__iendswith
          in: query
          description: title__iendswith
          required: false
          schema:
            type: string
        - name: description
          in: query
          description: description
          required: false
          schema:
            type: string
        - name: description__icontains
          in: query
          description: description__icontains
          required: false
          schema:
            type: string
        - name: description__istartswith
          in: query
          description: description__istartswith
          required: false
          schema:
            type: string
        - name: description__iendswith
          in: query
          description: description__iendswith
          required: false
          schema:
            type: string
        - name: description__isnull
          in: query
          description: description__isnull
          required: false
          schema:
            type: string
        - name: vendor_name
          in: query
          description: vendor_name
          required: false
          schema:
            type: string
        - name: vendor_name__icontains
          in: query
          description: vendor_name__icontains
          required: false
          schema:
            type: string
        - name: vendor_name__istartswith
          in: query
          description: vendor_name__istartswith
          required: false
          schema:
            type: string
        - name: vendor_name__iendswith
          in: query
          description: vendor_name__iendswith
          required: false
          schema:
            type: string
        - name: vendor_name__isnull
          in: query
          description: vendor_name__isnull
          required: false
          schema:
            type: string
        - name: accounting_date
          in: query
          description: accounting_date
          required: false
          schema:
            type: string
        - name: accounting_date__gte
          in: query
          description: accounting_date__gte
          required: false
          schema:
            type: string
        - name: accounting_date__lte
          in: query
          description: accounting_date__lte
          required: false
          schema:
            type: string
        - name: is_activity_based_emission
          in: query
          description: is_activity_based_emission
          required: false
          schema:
            type: string
        - name: classification_category_id
          in: query
          description: classification_category_id
          required: false
          schema:
            type: string
        - name: classification_category_name
          in: query
          description: classification_category_name
          required: false
          schema:
            type: string
        - name: classification_category_name__icontains
          in: query
          description: classification_category_name__icontains
          required: false
          schema:
            type: string
        - name: classification_category_name__istartswith
          in: query
          description: classification_category_name__istartswith
          required: false
          schema:
            type: string
        - name: classification_category_name__iendswith
          in: query
          description: classification_category_name__iendswith
          required: false
          schema:
            type: string
        - name: sub_category_id
          in: query
          description: sub_category_id
          required: false
          schema:
            type: string
        - name: category_id
          in: query
          description: category_id
          required: false
          schema:
            type: string
        - name: ghg_category_id
          in: query
          description: ghg_category_id
          required: false
          schema:
            type: string
        - name: is_tag_along
          in: query
          description: is_tag_along
          required: false
          schema:
            type: string
        - name: confidence_status
          in: query
          description: confidence_status
          required: false
          schema:
            type: string
            enum:
              - confident
              - needs_attention
        - name: co2_kg
          in: query
          description: co2_kg
          required: false
          schema:
            type: string
        - name: co2_kg__gt
          in: query
          description: co2_kg__gt
          required: false
          schema:
            type: string
        - name: co2_kg__lt
          in: query
          description: co2_kg__lt
          required: false
          schema:
            type: string
        - name: co2_kg__gte
          in: query
          description: co2_kg__gte
          required: false
          schema:
            type: string
        - name: co2_kg__lte
          in: query
          description: co2_kg__lte
          required: false
          schema:
            type: string
        - name: scope
          in: query
          description: scope
          required: false
          schema:
            type: string
            enum:
              - '1'
              - '2'
              - '3'
              - Offset
              - Excluded
        - name: company_tags
          in: query
          description: company_tags
          required: false
          schema:
            type: string
        - name: flags_key_value
          in: query
          description: flags_key_value
          required: false
          schema:
            type: string
        - name: search
          in: query
          description: A search term.
          required: false
          schema:
            type: string
        - name: ordering
          in: query
          description: Which field to use when ordering the results.
          required: false
          schema:
            type: string
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          schema:
            type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                required:
                  - count
                  - results
                type: object
                properties:
                  count:
                    type: integer
                  next:
                    type: string
                    format: uri
                    nullable: true
                  previous:
                    type: string
                    format: uri
                    nullable: true
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Emission'
      tags:
        - emission_calculations
      summary: Emission Calculations Emissions List
    parameters: []
  /emission_calculations/emissions/export:
    get:
      operationId: emission_calculations_emissions_export_list
      description: Override list method to return CSV export instead of JSON.
      parameters:
        - name: journal
          in: query
          description: journal
          required: false
          schema:
            type: string
        - name: journal__icontains
          in: query
          description: journal__icontains
          required: false
          schema:
            type: string
        - name: journal__istartswith
          in: query
          description: journal__istartswith
          required: false
          schema:
            type: string
        - name: journal__iendswith
          in: query
          description: journal__iendswith
          required: false
          schema:
            type: string
        - name: journal__isnull
          in: query
          description: journal__isnull
          required: false
          schema:
            type: string
        - name: title
          in: query
          description: title
          required: false
          schema:
            type: string
        - name: title__icontains
          in: query
          description: title__icontains
          required: false
          schema:
            type: string
        - name: title__istartswith
          in: query
          description: title__istartswith
          required: false
          schema:
            type: string
        - name: title__iendswith
          in: query
          description: title__iendswith
          required: false
          schema:
            type: string
        - name: description
          in: query
          description: description
          required: false
          schema:
            type: string
        - name: description__icontains
          in: query
          description: description__icontains
          required: false
          schema:
            type: string
        - name: description__istartswith
          in: query
          description: description__istartswith
          required: false
          schema:
            type: string
        - name: description__iendswith
          in: query
          description: description__iendswith
          required: false
          schema:
            type: string
        - name: description__isnull
          in: query
          description: description__isnull
          required: false
          schema:
            type: string
        - name: vendor_name
          in: query
          description: vendor_name
          required: false
          schema:
            type: string
        - name: vendor_name__icontains
          in: query
          description: vendor_name__icontains
          required: false
          schema:
            type: string
        - name: vendor_name__istartswith
          in: query
          description: vendor_name__istartswith
          required: false
          schema:
            type: string
        - name: vendor_name__iendswith
          in: query
          description: vendor_name__iendswith
          required: false
          schema:
            type: string
        - name: vendor_name__isnull
          in: query
          description: vendor_name__isnull
          required: false
          schema:
            type: string
        - name: accounting_date
          in: query
          description: accounting_date
          required: false
          schema:
            type: string
        - name: accounting_date__gte
          in: query
          description: accounting_date__gte
          required: false
          schema:
            type: string
        - name: accounting_date__lte
          in: query
          description: accounting_date__lte
          required: false
          schema:
            type: string
        - name: is_activity_based_emission
          in: query
          description: is_activity_based_emission
          required: false
          schema:
            type: string
        - name: classification_category_id
          in: query
          description: classification_category_id
          required: false
          schema:
            type: string
        - name: classification_category_name
          in: query
          description: classification_category_name
          required: false
          schema:
            type: string
        - name: classification_category_name__icontains
          in: query
          description: classification_category_name__icontains
          required: false
          schema:
            type: string
        - name: classification_category_name__istartswith
          in: query
          description: classification_category_name__istartswith
          required: false
          schema:
            type: string
        - name: classification_category_name__iendswith
          in: query
          description: classification_category_name__iendswith
          required: false
          schema:
            type: string
        - name: sub_category_id
          in: query
          description: sub_category_id
          required: false
          schema:
            type: string
        - name: category_id
          in: query
          description: category_id
          required: false
          schema:
            type: string
        - name: ghg_category_id
          in: query
          description: ghg_category_id
          required: false
          schema:
            type: string
        - name: is_tag_along
          in: query
          description: is_tag_along
          required: false
          schema:
            type: string
        - name: confidence_status
          in: query
          description: confidence_status
          required: false
          schema:
            type: string
            enum:
              - confident
              - needs_attention
        - name: co2_kg
          in: query
          description: co2_kg
          required: false
          schema:
            type: string
        - name: co2_kg__gt
          in: query
          description: co2_kg__gt
          required: false
          schema:
            type: string
        - name: co2_kg__lt
          in: query
          description: co2_kg__lt
          required: false
          schema:
            type: string
        - name: co2_kg__gte
          in: query
          description: co2_kg__gte
          required: false
          schema:
            type: string
        - name: co2_kg__lte
          in: query
          description: co2_kg__lte
          required: false
          schema:
            type: string
        - name: scope
          in: query
          description: scope
          required: false
          schema:
            type: string
            enum:
              - '1'
              - '2'
              - '3'
              - Offset
              - Excluded
        - name: company_tags
          in: query
          description: company_tags
          required: false
          schema:
            type: string
        - name: flags_key_value
          in: query
          description: flags_key_value
          required: false
          schema:
            type: string
        - name: search
          in: query
          description: A search term.
          required: false
          schema:
            type: string
        - name: ordering
          in: query
          description: Which field to use when ordering the results.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmissionCsvExport'
      tags:
        - emission_calculations
      summary: Emission Calculations Emissions Export List
    parameters: []
components:
  schemas:
    RiskAssessment:
      required:
        - identifier
        - assessment_type
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        identifier:
          title: Identifier
          type: string
          maxLength: 1024
          minLength: 1
        assessment_type:
          title: Assessment type
          type: string
          enum:
            - eudr_origin_assessment
            - eudr_origin_harvest_assessment
            - eudr_company_maturity_self_assessment
            - eudr_supply_chain_assessment
            - eudr_order_item_assessment
            - eudr_order_assessment
        assessment_run_id:
          title: Assessment run id
          description: The UUID of the assessment run
          type: string
          format: uuid
        results:
          title: Results
          description: The output of the risk assessment
          type: object
        assessment_summary:
          title: Assessment summary
          type: object
          readOnly: true
        assessment_date:
          title: Assessment date
          description: When this risk assessment was conducted
          type: string
          format: date-time
          readOnly: true
        analyzed_assessments:
          title: Analyzed assessments
          description: >-
            List of analyzed assessments (assessment runs) that contributed
            evidence to this assessment
          type: object
          readOnly: true
        company_id:
          title: Company id
          type: integer
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    RiskAssessmentCreate:
      required:
        - identifier
        - assessment_type
      type: object
      properties:
        identifier:
          title: Identifier
          description: Pulse identifier of the object to assess
          type: string
          maxLength: 1024
          minLength: 1
        assessment_type:
          title: Assessment type
          description: Type of risk assessment to perform
          type: string
          enum:
            - eudr_origin_assessment
            - eudr_origin_harvest_assessment
            - eudr_company_maturity_self_assessment
            - eudr_supply_chain_assessment
            - eudr_order_item_assessment
            - eudr_order_assessment
        data_room_survey_submission_context:
          title: Data room survey submission context
          description: Context of the data room to assess
          type: object
        assessment_run_id:
          title: Assessment run id
          description: Assessment run ID
          type: string
          format: uuid
          readOnly: true
        results:
          title: Results
          description: Results of the risk assessment
          type: object
          default: {}
        company_id:
          title: Company id
          description: Company ID
          type: integer
    DocumentGCP:
      required:
        - name
        - source
        - file_path
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        name:
          title: Name
          type: string
          maxLength: 510
          minLength: 1
        description:
          title: Description
          type: string
          nullable: true
        source:
          title: Source
          type: string
          maxLength: 20
          minLength: 1
        file_path:
          title: File path
          description: 'GCS path: gs://bucket/path'
          type: string
          maxLength: 1024
          minLength: 1
        file_size:
          title: File size
          description: File size in bytes
          type: integer
          readOnly: true
          nullable: true
        content_type:
          title: Content type
          type: string
          maxLength: 255
          nullable: true
        upload_status:
          title: Upload status
          type: string
          enum:
            - pending
            - uploading
            - completed
            - failed
          readOnly: true
        uploaded_at:
          title: Uploaded at
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
        company_id:
          title: Company id
          type: integer
          readOnly: true
        user_company_id:
          title: User company id
          type: integer
          readOnly: true
    DocumentUploadRequest:
      required:
        - name
        - content_type
      type: object
      properties:
        name:
          title: Name
          type: string
          maxLength: 510
          minLength: 1
        content_type:
          title: Content type
          type: string
          enum:
            - application/pdf
            - application/msword
            - >-
              application/vnd.openxmlformats-officedocument.wordprocessingml.document
            - application/vnd.ms-excel
            - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
            - application/vnd.ms-powerpoint
            - >-
              application/vnd.openxmlformats-officedocument.presentationml.presentation
            - image/jpeg
            - image/png
            - image/gif
            - image/webp
            - text/plain
            - text/csv
            - application/rtf
            - application/vnd.oasis.opendocument.text
            - application/vnd.oasis.opendocument.spreadsheet
            - application/vnd.oasis.opendocument.presentation
        description:
          title: Description
          type: string
    DataExchangeRun:
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        run_id:
          title: Run id
          description: Unique identifier for this data exchange run
          type: string
          format: uuid
          readOnly: true
        company_id:
          title: Company id
          description: ID of the company this data exchange run belongs to
          type: integer
          readOnly: true
        results:
          title: Results
          description: The output of the data exchange run
          type: object
        document:
          title: Document
          type: integer
          nullable: true
        model_identifier:
          title: Model identifier
          type: string
          readOnly: true
          minLength: 1
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    DataExchangeRunCreate:
      required:
        - results
        - document_id
        - model_identifier
      type: object
      properties:
        results:
          title: Results
          description: Results of the data exchange run
          type: object
        document_id:
          title: Document id
          description: Associated document ID
          type: integer
        model_identifier:
          title: Model identifier
          description: Associated model identifier
          type: string
          minLength: 1
        dry_run:
          title: Dry run
          description: Whether to run the data exchange run in dry run mode
          type: boolean
          default: true
        id:
          title: Id
          type: integer
          readOnly: true
        run_id:
          title: Run id
          type: string
          format: uuid
          readOnly: true
        company_id:
          title: Company id
          type: integer
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    DueDiligenceStatement:
      required:
        - dds_identifier
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        dds_identifier:
          title: Dds identifier
          type: string
          maxLength: 255
          minLength: 1
        dds_data:
          title: Dds data
          type: object
          readOnly: true
        orders:
          type: array
          items:
            type: integer
          readOnly: true
          uniqueItems: true
        pulse_params:
          title: Pulse params
          type: string
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    HSCode:
      type: object
      properties:
        hscode:
          title: Hscode
          type: string
          readOnly: true
          minLength: 1
        description:
          title: Description
          type: string
          readOnly: true
          minLength: 1
        section:
          title: Section
          type: string
          readOnly: true
          minLength: 1
        parent:
          title: Parent
          type: string
          readOnly: true
          minLength: 1
        level:
          title: Level
          type: string
          readOnly: true
          minLength: 1
        is_chapter:
          title: Is chapter
          type: boolean
          readOnly: true
        is_heading:
          title: Is heading
          type: boolean
          readOnly: true
        is_subheading:
          title: Is subheading
          type: boolean
          readOnly: true
        standards:
          type: array
          items:
            type: string
            minLength: 1
          readOnly: true
        commodity:
          title: Commodity
          type: string
          readOnly: true
          minLength: 1
    HSSection:
      type: object
      properties:
        section:
          title: Section
          type: string
          readOnly: true
          minLength: 1
        name:
          title: Name
          type: string
          readOnly: true
          minLength: 1
    InformationRequest:
      type: object
      properties:
        order_id:
          title: Order id
          type: integer
        value_chain_id:
          title: Value chain id
          type: integer
        invitation_action:
          title: Invitation action
          type: string
          readOnly: true
          minLength: 1
        name:
          title: Name
          type: string
          readOnly: true
          minLength: 1
        type:
          title: Type
          type: string
          readOnly: true
          minLength: 1
        city:
          title: City
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        country:
          title: Country
          type: string
          readOnly: true
          minLength: 1
        primary_contact_id:
          title: Primary contact id
          type: integer
          readOnly: true
        primary_contact_email:
          title: Primary contact email
          type: string
          format: email
          readOnly: true
          minLength: 1
    InformationRequestItem:
      type: object
      properties:
        order_id:
          title: Order id
          type: integer
        value_chain_id:
          title: Value chain id
          type: integer
    InformationRequestBulk:
      required:
        - information_requests
      type: object
      properties:
        information_requests:
          description: List of information requests to create
          type: array
          items:
            $ref: '#/components/schemas/InformationRequestItem'
          maxItems: 100
          minItems: 1
    CoolsetCompany:
      type: object
      properties:
        id:
          title: Id
          type: integer
          readOnly: true
        name:
          title: Name
          type: string
          readOnly: true
          minLength: 1
        slug:
          title: Slug
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        type:
          title: Type
          type: string
          readOnly: true
          minLength: 1
        city:
          title: City
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        country:
          title: Country
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        nr_of_employees:
          title: Nr of employees
          type: integer
          readOnly: true
          nullable: true
        nr_of_locations:
          title: Nr of locations
          type: integer
          readOnly: true
          nullable: true
        default_currency:
          title: Default currency
          type: string
          readOnly: true
          minLength: 1
        default_locale:
          title: Default locale
          type: string
          readOnly: true
          minLength: 1
        data_room_consumer_id:
          title: Data room consumer id
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    OrderList:
      required:
        - type
        - order_created_at
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        type:
          title: Type
          type: string
          enum:
            - order
            - produced_batch
            - manufactured_batch
        buyer_external_id:
          title: Buyer external id
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        seller_external_id:
          title: Seller external id
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        order_created_at:
          title: Order created at
          type: string
          format: date
        order_arrival_at:
          title: Order arrival at
          type: string
          format: date
          nullable: true
        order_status:
          title: Order status
          type: string
          enum:
            - draft
            - open
            - complete
            - cancelled
        assessment_status:
          title: Assessment status
          type: string
          enum:
            - pending
            - passing
            - failing
          readOnly: true
        value_chain:
          title: Value chain
          type: integer
          nullable: true
        buyer_company_id:
          title: Buyer company id
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        seller_company_id:
          title: Seller company id
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        company:
          $ref: '#/components/schemas/CoolsetCompany'
        buyer_company:
          $ref: '#/components/schemas/CoolsetCompany'
        seller_company:
          $ref: '#/components/schemas/CoolsetCompany'
        assessment_summary:
          title: Assessment summary
          type: object
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    ProductList:
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        company_id:
          title: Company id
          type: integer
          readOnly: true
        sku:
          title: Sku
          type: string
          readOnly: true
          minLength: 1
        name:
          title: Name
          type: string
          readOnly: true
          minLength: 1
        description:
          title: Description
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        scientific_name:
          title: Scientific name
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        common_name:
          title: Common name
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        type:
          title: Type
          type: string
          enum:
            - manufactured
            - produced
            - purchased
          readOnly: true
        hs_code:
          title: Hs code
          type: string
          readOnly: true
          minLength: 1
        commodity:
          title: Commodity
          type: string
          enum:
            - cattle
            - cocoa
            - coffee
            - palm_oil
            - rubber
            - soya
            - wood
          readOnly: true
        composition:
          title: Composition
          type: string
          enum:
            - simple
            - composite
          readOnly: true
        external_id:
          title: External id
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    OrderItem:
      required:
        - order
        - volume
        - unit
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        order:
          title: Order
          type: integer
        order_detail:
          $ref: '#/components/schemas/OrderList'
        buyer_product:
          title: Buyer product
          type: integer
          nullable: true
        buyer_product_detail:
          $ref: '#/components/schemas/ProductList'
        seller_product:
          title: Seller product
          type: integer
          nullable: true
        seller_product_detail:
          $ref: '#/components/schemas/ProductList'
        volume:
          title: Volume
          type: number
        unit:
          title: Unit
          type: string
          maxLength: 3
          minLength: 1
        line_number:
          title: Line number
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        external_id:
          title: External id
          type: string
          maxLength: 255
          nullable: true
        traced_orders:
          type: array
          items:
            type: integer
          uniqueItems: true
        traced_orders_detail:
          type: array
          items:
            $ref: '#/components/schemas/OrderList'
          readOnly: true
        is_complete_match:
          title: Is complete match
          type: string
          readOnly: true
        pulse_params:
          title: Pulse params
          type: string
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
        assessment_summary:
          title: Assessment summary
          type: object
          readOnly: true
        assessment_status:
          title: Assessment status
          type: string
          enum:
            - pending
            - passing
            - failing
          readOnly: true
    ValueChain:
      required:
        - company_name
        - country_code
        - contact_name
        - contact_email
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        company_name:
          title: Company name
          type: string
          maxLength: 255
          minLength: 1
        description:
          title: Description
          type: string
          nullable: true
        status:
          title: Status
          type: string
          enum:
            - revoked
            - not_invited_yet
            - invitation_sent
            - connected
        assessment_status:
          title: Assessment status
          type: string
          enum:
            - pending
            - passing
            - failing
          readOnly: true
        country_code:
          title: Country code
          type: string
          maxLength: 2
          minLength: 1
        external_id:
          title: External id
          type: string
          maxLength: 255
          nullable: true
        permission_granted:
          title: Permission granted
          type: boolean
        is_self_managed:
          title: Is self managed
          type: boolean
        contact_name:
          title: Contact name
          type: string
          maxLength: 255
          minLength: 1
        contact_email:
          title: Contact email
          type: string
          format: email
          maxLength: 254
          minLength: 1
        invitation_id:
          title: Invitation id
          type: string
          format: uuid
          nullable: true
        reciprocal_company_id:
          title: Reciprocal company id
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        has_account:
          title: Has account
          type: string
          readOnly: true
        is_invited:
          title: Is invited
          type: string
          readOnly: true
        pulse_params:
          title: Pulse params
          type: string
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
        assessment_summary:
          title: Assessment summary
          type: object
          readOnly: true
    NestedOrderItem:
      required:
        - volume
        - unit
      type: object
      properties:
        id:
          title: Id
          type: integer
        order:
          title: Order
          type: integer
          readOnly: true
        buyer_product:
          title: Buyer product
          type: integer
          nullable: true
        buyer_product_detail:
          $ref: '#/components/schemas/ProductList'
        seller_product:
          title: Seller product
          type: integer
          nullable: true
        seller_product_detail:
          $ref: '#/components/schemas/ProductList'
        volume:
          title: Volume
          type: number
        unit:
          title: Unit
          type: string
          maxLength: 3
          minLength: 1
        line_number:
          title: Line number
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        external_id:
          title: External id
          type: string
          maxLength: 255
          nullable: true
        is_complete_match:
          title: Is complete match
          type: string
          readOnly: true
        traced_order_count:
          title: Traced order count
          type: string
          readOnly: true
        traced_origin_count:
          title: Traced origin count
          type: string
          readOnly: true
        pulse_params:
          title: Pulse params
          type: string
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
        assessment_summary:
          title: Assessment summary
          type: object
          readOnly: true
        assessment_status:
          title: Assessment status
          type: string
          enum:
            - pending
            - passing
            - failing
          readOnly: true
    DueDiligenceStatementNested:
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        company_id:
          title: Company id
          type: integer
          readOnly: true
        dds_data:
          title: Dds data
          type: object
          readOnly: true
        pulse_params:
          title: Pulse params
          type: string
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    Order:
      required:
        - company_id
        - type
        - order_created_at
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        company_id:
          title: Company id
          type: integer
          maximum: 2147483647
          minimum: 0
        type:
          title: Type
          type: string
          enum:
            - order
            - produced_batch
            - manufactured_batch
        buyer_external_id:
          title: Buyer external id
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        seller_external_id:
          title: Seller external id
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        order_created_at:
          title: Order created at
          type: string
          format: date
        order_arrival_at:
          title: Order arrival at
          type: string
          format: date
          nullable: true
        order_status:
          title: Order status
          type: string
          enum:
            - draft
            - open
            - complete
            - cancelled
        assessment_status:
          title: Assessment status
          type: string
          enum:
            - pending
            - passing
            - failing
          readOnly: true
        value_chain:
          title: Value chain
          type: integer
          nullable: true
        value_chain_detail:
          $ref: '#/components/schemas/ValueChain'
        buyer_company_id:
          title: Buyer company id
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        seller_company_id:
          title: Seller company id
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        company:
          $ref: '#/components/schemas/CoolsetCompany'
        buyer_company:
          $ref: '#/components/schemas/CoolsetCompany'
        seller_company:
          $ref: '#/components/schemas/CoolsetCompany'
        items:
          type: array
          items:
            $ref: '#/components/schemas/NestedOrderItem'
          readOnly: true
        due_diligence_statements:
          type: array
          items:
            $ref: '#/components/schemas/DueDiligenceStatementNested'
          readOnly: true
        assessment_summary:
          title: Assessment summary
          type: object
          readOnly: true
        pulse_params:
          title: Pulse params
          type: string
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    BatchOrder:
      required:
        - type
        - order_created_at
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        type:
          title: Type
          type: string
          enum:
            - order
            - produced_batch
            - manufactured_batch
        buyer_external_id:
          title: Buyer external id
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        seller_external_id:
          title: Seller external id
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        order_created_at:
          title: Order created at
          type: string
          format: date
        order_arrival_at:
          title: Order arrival at
          type: string
          format: date
          nullable: true
        order_status:
          title: Order status
          type: string
          enum:
            - draft
            - open
            - complete
            - cancelled
          readOnly: true
        assessment_status:
          title: Assessment status
          type: string
          enum:
            - pending
            - passing
            - failing
          readOnly: true
        value_chain:
          title: Value chain
          type: integer
          readOnly: true
          nullable: true
        seller_company_id:
          title: Seller company id
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        company:
          $ref: '#/components/schemas/CoolsetCompany'
        buyer_company:
          $ref: '#/components/schemas/CoolsetCompany'
        seller_company:
          $ref: '#/components/schemas/CoolsetCompany'
        items:
          type: array
          items:
            $ref: '#/components/schemas/NestedOrderItem'
        due_diligence_statements:
          type: array
          items:
            type: integer
          readOnly: true
          uniqueItems: true
        assessment_summary:
          title: Assessment summary
          type: object
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    PurchaseOrder:
      required:
        - type
        - order_created_at
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        type:
          title: Type
          type: string
          enum:
            - order
            - produced_batch
            - manufactured_batch
        buyer_external_id:
          title: Buyer external id
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        seller_external_id:
          title: Seller external id
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        order_created_at:
          title: Order created at
          type: string
          format: date
        order_arrival_at:
          title: Order arrival at
          type: string
          format: date
          nullable: true
        order_status:
          title: Order status
          type: string
          enum:
            - draft
            - open
            - complete
            - cancelled
        assessment_status:
          title: Assessment status
          type: string
          enum:
            - pending
            - passing
            - failing
          readOnly: true
        value_chain:
          title: Value chain
          type: integer
          nullable: true
        value_chain_detail:
          $ref: '#/components/schemas/ValueChain'
        seller_company_id:
          title: Seller company id
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        company:
          $ref: '#/components/schemas/CoolsetCompany'
        buyer_company:
          $ref: '#/components/schemas/CoolsetCompany'
        seller_company:
          $ref: '#/components/schemas/CoolsetCompany'
        items:
          type: array
          items:
            $ref: '#/components/schemas/NestedOrderItem'
        due_diligence_statements:
          type: array
          items:
            type: integer
          readOnly: true
          uniqueItems: true
        assessment_summary:
          title: Assessment summary
          type: object
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    Origin:
      required:
        - name
        - country_code
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        name:
          title: Name
          type: string
          maxLength: 255
          minLength: 1
        description:
          title: Description
          type: string
          nullable: true
        country_code:
          title: Country code
          type: string
          maxLength: 2
          minLength: 1
        location:
          title: Location
          type: object
        external_id:
          title: External id
          type: string
          maxLength: 255
          nullable: true
        open_atlas_external_id:
          title: Open atlas external id
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        open_atlas_information:
          title: Open atlas information
          type: object
          readOnly: true
        pulse_params:
          title: Pulse params
          type: string
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
        assessment_summary:
          title: Assessment summary
          type: object
          readOnly: true
        assessment_status:
          title: Assessment status
          type: string
          enum:
            - pending
            - passing
            - failing
          readOnly: true
    RelatedOrderItem:
      required:
        - volume
        - unit
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        order:
          title: Order
          type: integer
          readOnly: true
        buyer_product:
          title: Buyer product
          type: integer
          nullable: true
        buyer_product_detail:
          $ref: '#/components/schemas/ProductList'
        seller_product:
          title: Seller product
          type: integer
          nullable: true
        seller_product_detail:
          $ref: '#/components/schemas/ProductList'
        volume:
          title: Volume
          type: number
        unit:
          title: Unit
          type: string
          maxLength: 3
          minLength: 1
        line_number:
          title: Line number
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        external_id:
          title: External id
          type: string
          maxLength: 255
          nullable: true
        traced_orders_detail:
          type: array
          items:
            $ref: '#/components/schemas/OrderList'
          readOnly: true
        traced_origins_detail:
          type: array
          items:
            $ref: '#/components/schemas/Origin'
          readOnly: true
        is_complete_match:
          title: Is complete match
          type: string
          readOnly: true
        pulse_params:
          title: Pulse params
          type: string
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
        assessment_summary:
          title: Assessment summary
          type: object
          readOnly: true
        assessment_status:
          title: Assessment status
          type: string
          enum:
            - pending
            - passing
            - failing
          readOnly: true
    SaleOrder:
      required:
        - type
        - order_created_at
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        type:
          title: Type
          type: string
          enum:
            - order
            - produced_batch
            - manufactured_batch
        buyer_external_id:
          title: Buyer external id
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        seller_external_id:
          title: Seller external id
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        order_created_at:
          title: Order created at
          type: string
          format: date
        order_arrival_at:
          title: Order arrival at
          type: string
          format: date
          nullable: true
        order_status:
          title: Order status
          type: string
          enum:
            - draft
            - open
            - complete
            - cancelled
        assessment_status:
          title: Assessment status
          type: string
          enum:
            - pending
            - passing
            - failing
        value_chain:
          title: Value chain
          type: integer
          nullable: true
        value_chain_detail:
          $ref: '#/components/schemas/ValueChain'
        buyer_company_id:
          title: Buyer company id
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        company:
          $ref: '#/components/schemas/CoolsetCompany'
        buyer_company:
          $ref: '#/components/schemas/CoolsetCompany'
        seller_company:
          $ref: '#/components/schemas/CoolsetCompany'
        items:
          type: array
          items:
            $ref: '#/components/schemas/NestedOrderItem'
        due_diligence_statements:
          type: array
          items:
            type: integer
          readOnly: true
          uniqueItems: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    OrderStatistics:
      required:
        - order_count
      type: object
      properties:
        order_count:
          title: Order count
          type: integer
        date:
          title: Date
          type: string
          format: date
        type:
          title: Type
          type: string
          minLength: 1
        order_status:
          title: Order status
          type: string
          minLength: 1
        assessment_status:
          title: Assessment status
          type: string
          minLength: 1
    ProductComponent:
      required:
        - product
        - component_product
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        product:
          title: Product
          type: integer
        component_product:
          title: Component product
          type: integer
        component_product_detail:
          $ref: '#/components/schemas/ProductList'
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
        deleted_at:
          title: Deleted at
          type: string
          format: date-time
          nullable: true
    Product:
      required:
        - sku
        - name
        - type
        - hs_code
        - commodity
        - composition
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        sku:
          title: Sku
          type: string
          maxLength: 100
          minLength: 1
        name:
          title: Name
          type: string
          maxLength: 255
          minLength: 1
        description:
          title: Description
          type: string
          nullable: true
        scientific_name:
          title: Scientific name
          type: string
          maxLength: 255
          nullable: true
        common_name:
          title: Common name
          type: string
          maxLength: 255
          nullable: true
        type:
          title: Type
          type: string
          enum:
            - manufactured
            - produced
            - purchased
        hs_code:
          title: Hs code
          type: string
          maxLength: 255
          minLength: 1
        commodity:
          title: Commodity
          type: string
          enum:
            - cattle
            - cocoa
            - coffee
            - palm_oil
            - rubber
            - soya
            - wood
        composition:
          title: Composition
          type: string
          enum:
            - simple
            - composite
        external_id:
          title: External id
          type: string
          maxLength: 255
          nullable: true
        product_components:
          description: A list of product IDs to set as components.
          type: array
          items:
            description: A list of product IDs to set as components.
            type: integer
          uniqueItems: true
        product_components_detail:
          type: array
          items:
            $ref: '#/components/schemas/ProductComponent'
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    TraceList:
      required:
        - order
        - volume
        - unit
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        order:
          title: Order
          type: integer
        order_detail:
          $ref: '#/components/schemas/OrderList'
        buyer_product:
          title: Buyer product
          type: integer
          nullable: true
        buyer_product_detail:
          $ref: '#/components/schemas/ProductList'
        seller_product:
          title: Seller product
          type: integer
          nullable: true
        seller_product_detail:
          $ref: '#/components/schemas/ProductList'
        volume:
          title: Volume
          type: number
        unit:
          title: Unit
          type: string
          maxLength: 3
          minLength: 1
        line_number:
          title: Line number
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        external_id:
          title: External id
          type: string
          maxLength: 255
          nullable: true
        traced_orders_detail:
          type: array
          items:
            $ref: '#/components/schemas/OrderList'
          readOnly: true
        traced_origins_detail:
          type: array
          items:
            $ref: '#/components/schemas/Origin'
          readOnly: true
        is_complete_match:
          title: Is complete match
          type: string
          readOnly: true
        pulse_params:
          title: Pulse params
          type: string
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
        assessment_summary:
          title: Assessment summary
          type: object
          readOnly: true
        assessment_status:
          title: Assessment status
          type: string
          enum:
            - pending
            - passing
            - failing
          readOnly: true
    Country:
      type: object
      properties:
        name:
          title: Name
          type: string
          readOnly: true
          minLength: 1
        alpha_2:
          title: Alpha 2
          type: string
          readOnly: true
          minLength: 1
        alpha_3:
          title: Alpha 3
          type: string
          readOnly: true
          minLength: 1
        numeric:
          title: Numeric
          type: string
          readOnly: true
          minLength: 1
        official_name:
          title: Official name
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        flag:
          title: Flag
          type: string
          readOnly: true
          minLength: 1
          nullable: true
    UserConfigResponse:
      required:
        - config
        - available_actions
        - company_type
      type: object
      properties:
        config:
          title: Config
          description: Current user configuration
          type: object
        available_actions:
          description: List of actions available to the user based on their current state
          type: array
          items:
            type: string
            minLength: 1
        company_type:
          title: Company type
          description: Type of company the user belongs to
          type: string
          minLength: 1
    UserConfigUpdate:
      type: object
      properties:
        sign_stakeholder_agreement:
          title: Sign stakeholder agreement
          description: Set to true to sign the stakeholder agreement
          type: boolean
    Workspace:
      type: object
      properties:
        workspace_id:
          title: Workspace id
          type: integer
          readOnly: true
        workspace_name:
          title: Workspace name
          type: string
          readOnly: true
          minLength: 1
        workspace_logo:
          title: Workspace logo
          type: string
          readOnly: true
          format: uri
        id:
          title: ID
          type: integer
          readOnly: true
        name:
          title: Name
          type: string
          readOnly: true
          minLength: 1
        logo:
          title: Logo
          type: string
          readOnly: true
          format: uri
          nullable: true
        type:
          title: Type
          type: string
          enum:
            - active
            - inactive
            - test
            - demo
            - trial
            - stakeholder
          readOnly: true
        country:
          title: Country
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        member_count:
          title: Member count
          type: integer
          readOnly: true
        is_mfa_enabled:
          title: Is mfa enabled
          type: boolean
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    ManualInput:
      required:
        - label
        - order
        - type
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        label:
          title: Label
          type: string
          maxLength: 1000
          minLength: 1
        unit:
          title: Unit
          type: string
          readOnly: true
        order:
          title: Order
          type: integer
          maximum: 2147483647
          minimum: 1
        type:
          title: Type
          type: string
          enum:
            - dropdown
            - value
    BaseEmissionFactorCategory:
      required:
        - title
        - parent
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        slug:
          title: Slug
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        title:
          title: Title
          type: string
          maxLength: 255
          minLength: 1
        description:
          title: Description
          type: string
          maxLength: 1024
          nullable: true
        color:
          title: Color
          type: string
          pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
          maxLength: 24
          nullable: true
        icon:
          title: Icon
          type: string
          readOnly: true
          format: uri
          nullable: true
        parent:
          title: Parent
          type: integer
          nullable: true
        category:
          title: Category
          type: integer
          readOnly: true
        manual_inputs:
          type: array
          items:
            $ref: '#/components/schemas/ManualInput'
    EmissionFactorCategory:
      required:
        - title
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        slug:
          title: Slug
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        title:
          title: Title
          type: string
          maxLength: 255
          minLength: 1
        description:
          title: Description
          type: string
          maxLength: 1024
          nullable: true
        color:
          title: Color
          type: string
          pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
          maxLength: 24
          nullable: true
        icon:
          title: Icon
          type: string
          readOnly: true
          format: uri
          nullable: true
        parent:
          $ref: '#/components/schemas/BaseEmissionFactorCategory'
        category:
          title: Category
          type: integer
          readOnly: true
        manual_inputs:
          type: array
          items:
            $ref: '#/components/schemas/ManualInput'
    BaseEmissionFactor:
      required:
        - title
        - category
        - kg_co2e_multiplier
        - kg_co2e_multiplier_unit
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        scope:
          title: Scope
          type: integer
          enum:
            - 1
            - 2
            - 3
            - 9
        title:
          title: Title
          type: string
          maxLength: 255
          minLength: 1
        parent:
          title: Parent
          type: integer
          nullable: true
        category:
          $ref: '#/components/schemas/EmissionFactorCategory'
        company:
          title: Company
          type: integer
          nullable: true
        kg_co2e_multiplier:
          title: Kg co2e multiplier
          type: number
        kg_co2e_multiplier_unit:
          title: Kg co2e multiplier unit
          type: integer
    ActivityBasedTransactionsType:
      required:
        - count
        - sub_categories
      type: object
      properties:
        count:
          title: Count
          type: integer
        sub_categories:
          type: array
          items:
            $ref: '#/components/schemas/BaseEmissionFactorCategory'
    ManualInputTransactionsSubCategories:
      required:
        - open
        - completed
        - skipped
      type: object
      properties:
        open:
          $ref: '#/components/schemas/ActivityBasedTransactionsType'
        completed:
          $ref: '#/components/schemas/ActivityBasedTransactionsType'
        skipped:
          $ref: '#/components/schemas/ActivityBasedTransactionsType'
    Permission:
      required:
        - codename
      type: object
      properties:
        codename:
          title: Codename
          type: string
          maxLength: 100
          minLength: 1
    Group:
      required:
        - name
        - permissions
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        name:
          title: Name
          type: string
          maxLength: 150
          minLength: 1
        permissions:
          type: array
          items:
            $ref: '#/components/schemas/Permission'
    ChartQueryParam:
      type: object
      properties:
        date_aggregation:
          title: Date aggregation
          type: string
          enum:
            - day
            - week
            - month
            - quarter
            - year
        date_gte:
          title: Date gte
          type: string
          format: date
        date_lte:
          title: Date lte
          type: string
          format: date
        group_by:
          title: Group by
          type: string
          enum:
            - scope
            - category
            - parent_category
            - status
            - vendor_name
            - ledger
        relative_to:
          title: Relative to
          type: string
          enum:
            - absolute
            - per_employee
            - per_revenue_unit
        metric_label:
          title: Metric label
          type: string
          minLength: 1
        limit:
          title: Limit
          type: integer
        type:
          title: Type
          type: string
          enum:
            - pie
            - bar
            - line
            - area
            - dashed-line
            - dotted-line
            - tree-map
    TrendLineData:
      required:
        - date_aggregation
        - trend_line
      type: object
      properties:
        date_aggregation:
          title: Date aggregation
          type: string
          format: date-time
        trend_line:
          title: Trend line
          type: number
    TransactionEmissionClassificationUpdate:
      required:
        - emission_factor
      type: object
      properties:
        emission_factor:
          title: Emission factor
          type: integer
    CompanyFlag:
      required:
        - name
      type: object
      properties:
        name:
          title: Name
          description: The human/computer readable name.
          type: string
          maxLength: 100
          minLength: 1
    Company:
      required:
        - name
        - default_currency
        - default_locale
        - flags
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        name:
          title: Name
          type: string
          maxLength: 1024
          minLength: 1
        type:
          title: Type
          type: string
          enum:
            - active
            - inactive
            - test
            - demo
            - trial
            - stakeholder
          readOnly: true
        logo:
          title: Logo
          type: string
          readOnly: true
          format: uri
          nullable: true
        credits_used:
          title: Credits used
          type: string
          readOnly: true
        nr_of_employees:
          title: Nr of employees
          type: number
          readOnly: true
        nr_of_locations:
          title: Nr of locations
          type: number
          readOnly: true
        nr_of_transactions:
          title: Nr of transactions
          type: integer
          readOnly: true
        minimum_date_filter:
          title: Minimum date filter
          type: string
          format: date
          readOnly: true
        results_limit_earliest_year:
          title: Results limit earliest year
          type: string
          format: date
          readOnly: true
        results_limit_latest_year:
          title: Results limit latest year
          type: string
          format: date
          readOnly: true
          nullable: true
        min_transaction_date:
          title: Min transaction date
          type: string
          readOnly: true
        max_transaction_date:
          title: Max transaction date
          type: string
          readOnly: true
        public_page_url:
          title: Public page url
          type: string
          format: uri
          maxLength: 200
          nullable: true
        chift_consumer_id:
          title: Chift consumer id
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        default_currency:
          title: Default currency
          type: string
          minLength: 1
        default_locale:
          title: Default locale
          type: string
          enum:
            - nl-NL
            - en-US
            - en-GB
            - fr-FR
            - fr-BE
            - sv-SE
        data_room_consumer_id:
          title: Data room consumer id
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        information:
          title: Information
          type: object
        pulse_params:
          title: Pulse params
          type: string
          readOnly: true
        flags:
          type: array
          items:
            $ref: '#/components/schemas/CompanyFlag'
    CompanyTag:
      required:
        - company
        - name
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        company:
          title: Company
          type: integer
        name:
          title: Name
          type: string
          maxLength: 20
          minLength: 1
    DataPointCreateRequest:
      required:
        - context
        - value
        - field_id
      type: object
      properties:
        context:
          title: Context
          type: object
          additionalProperties:
            type: string
            nullable: true
        value:
          title: Value
          type: string
        field_id:
          title: Field id
          type: string
          minLength: 1
    DataPointCreateStatusRequest:
      required:
        - context
        - field_id
        - status
      type: object
      properties:
        context:
          title: Context
          type: object
          additionalProperties:
            type: string
            nullable: true
        field_id:
          title: Field id
          type: string
          minLength: 1
        status:
          title: Status
          type: string
          enum:
            - not_started
            - in_progress
            - ready_for_review
            - ready_for_audit
            - suggested
    Export:
      required:
        - context
      type: object
      properties:
        export_template:
          title: Export template
          type: integer
        survey:
          title: Survey
          type: integer
        application_survey_id:
          title: Application survey id
          type: integer
        export_configuration:
          title: Export configuration
          type: object
          additionalProperties:
            type: string
            nullable: true
        context:
          title: Context
          type: object
          additionalProperties:
            type: string
            nullable: true
    QueryContext:
      required:
        - context_object
        - context_value
        - precision
      type: object
      properties:
        context_object:
          title: Context object
          type: string
          minLength: 1
        context_value:
          title: Context value
          type: string
          minLength: 1
        precision:
          title: Precision
          type: string
          enum:
            - exact
            - exclude
            - nearest
    SurveySubmissionCreate:
      required:
        - application_survey_id
        - query_context
      type: object
      properties:
        application_survey_id:
          title: Application survey id
          type: integer
        query_context:
          type: array
          items:
            $ref: '#/components/schemas/QueryContext'
    ElasticSearchEmissionFactorCategory:
      required:
        - id
        - title
        - description
        - slug
        - parent
        - color
        - is_classification_category
        - parent_id
        - ghg_mappings
      type: object
      properties:
        id:
          title: Id
          type: integer
        title:
          title: Title
          type: string
          minLength: 1
        description:
          title: Description
          type: string
          minLength: 1
        slug:
          title: Slug
          type: string
          minLength: 1
        parent:
          title: Parent
          type: string
        color:
          title: Color
          type: string
          minLength: 1
        is_classification_category:
          title: Is classification category
          type: boolean
        parent_id:
          title: Parent id
          type: integer
        ghg_mappings:
          title: Ghg mappings
          type: string
    EmissionFactor:
      required:
        - title
        - parent
        - category
        - classification_category
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        slug:
          title: Slug
          type: string
          maxLength: 255
          minLength: 1
          nullable: true
        scope:
          title: Scope
          type: integer
          enum:
            - 1
            - 2
            - 3
            - 9
        description:
          title: Description
          type: string
          maxLength: 1024
          nullable: true
        title:
          title: Title
          type: string
          maxLength: 255
          minLength: 1
        parent:
          $ref: '#/components/schemas/BaseEmissionFactor'
        category:
          $ref: '#/components/schemas/EmissionFactorCategory'
        classification_category:
          $ref: '#/components/schemas/EmissionFactorCategory'
        company:
          title: Company
          type: integer
          nullable: true
        kg_co2e_multiplier:
          title: Kg co2e multiplier
          type: number
          readOnly: true
        kg_co2e_multiplier_unit:
          title: Kg co2e multiplier unit
          type: object
          readOnly: true
        region:
          title: Region
          type: string
          maxLength: 255
          nullable: true
        is_activity_based:
          title: Is Activity Based Preference
          type: boolean
        is_required_transactions_input_classifier:
          title: Is required transactions input classifier
          type: boolean
        year:
          title: Year
          type: string
          maxLength: 10
          nullable: true
        source:
          title: Source
          type: string
          maxLength: 255
          nullable: true
        obsolete:
          title: Obsolete
          type: boolean
    CreateUpdateCompanyEmissionFactor:
      required:
        - kg_co2e_multiplier
        - parent
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        title:
          title: Title
          type: string
          maxLength: 255
          minLength: 1
        scope:
          title: Scope
          type: integer
          enum:
            - 1
            - 2
            - 3
            - 9
        kg_co2e_multiplier:
          title: Kg co2e multiplier
          type: number
        parent:
          title: Parent
          type: integer
          nullable: true
    Classification:
      required:
        - transaction_id
      type: object
      properties:
        id:
          title: Id
          type: integer
        transaction_id:
          title: Transaction id
          type: integer
        emission_factor_id:
          title: Emission factor id
          type: integer
        classification_category_id:
          title: Classification category id
          type: integer
        ghg_category_id:
          title: Ghg category id
          type: integer
        is_activity_based_emission:
          title: Is activity based emission
          type: boolean
        activity_data:
          title: Activity data
          type: object
    EmissionClassificationTchuRequest:
      required:
        - classifications
      type: object
      properties:
        classifications:
          type: array
          items:
            $ref: '#/components/schemas/Classification'
    EmissionChart:
      required:
        - transaction_count
        - total_co2_kg
      type: object
      properties:
        transaction_count:
          title: Transaction count
          type: integer
        total_co2_kg:
          title: Total co2 kg
          type: number
        date:
          title: Date
          type: string
          format: date-time
        main_emission:
          title: Main emission
          type: integer
        category:
          title: Category
          type: integer
        category_name:
          title: Category name
          type: string
          minLength: 1
        sub_category:
          title: Sub category
          type: integer
        sub_category_name:
          title: Sub category name
          type: string
          minLength: 1
        ghg_category:
          title: Ghg category
          type: integer
        ghg_category_name:
          title: Ghg category name
          type: string
          minLength: 1
        scope:
          title: Scope
          type: string
          minLength: 1
        title:
          title: Title
          type: string
          minLength: 1
        vendor_name:
          title: Vendor name
          type: string
          minLength: 1
    Emission:
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        company:
          title: Company
          type: integer
          readOnly: true
        company_name:
          title: Company name
          type: string
          readOnly: true
          minLength: 1
        company_tags:
          type: array
          items:
            type: integer
          readOnly: true
          uniqueItems: true
        emission_group_id:
          title: Emission group id
          type: string
          format: uuid
          readOnly: true
        transaction:
          title: Transaction
          type: integer
          readOnly: true
          nullable: true
        total_volume:
          title: Total volume
          type: number
          readOnly: true
          nullable: true
        volume:
          title: Volume
          type: number
          readOnly: true
          nullable: true
        volume_unit:
          title: Volume unit
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        journal:
          title: Journal
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        title:
          title: Title
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        description:
          title: Description
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        vendor_name:
          title: Vendor name
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        accounting_date:
          title: Accounting date
          type: string
          format: date-time
          readOnly: true
          nullable: true
        accounting_end_date:
          title: Accounting end date
          type: string
          format: date-time
          readOnly: true
          nullable: true
        transaction_is_visible:
          title: Transaction is visible
          type: boolean
          readOnly: true
          nullable: true
        transaction_data:
          title: Transaction data
          type: object
          readOnly: true
          nullable: true
        transaction_id:
          title: Transaction id
          type: string
          readOnly: true
        is_activity_based_emission:
          title: Is activity based emission
          type: boolean
          readOnly: true
        activity_data:
          title: Activity data
          type: object
          readOnly: true
          nullable: true
        emission_factor:
          title: Emission factor
          type: integer
          readOnly: true
          nullable: true
        emission_unit:
          title: Emission unit
          type: integer
          readOnly: true
          nullable: true
        emission_unit_name:
          title: Emission unit name
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        emission_factor_data:
          title: Emission factor data
          type: object
          readOnly: true
          nullable: true
        classification_category:
          title: Classification category
          type: integer
          readOnly: true
          nullable: true
        classification_category_name:
          title: Classification category name
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        sub_category:
          title: Sub category
          type: integer
          readOnly: true
          nullable: true
        sub_category_name:
          title: Sub category name
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        category:
          title: Category
          type: integer
          readOnly: true
          nullable: true
        category_name:
          title: Category name
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        ghg_category:
          title: Ghg category
          type: integer
          readOnly: true
          nullable: true
        ghg_category_name:
          title: Ghg category name
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        scope:
          title: Scope
          type: string
          enum:
            - '1'
            - '2'
            - '3'
            - Offset
            - Excluded
          readOnly: true
        is_tag_along:
          title: Is tag along
          type: boolean
          readOnly: true
        main_emission:
          title: Main emission
          type: integer
          readOnly: true
          nullable: true
        created_by:
          title: Created by
          type: integer
          readOnly: true
          nullable: true
        classification_source:
          title: Classification source
          type: string
          enum:
            - auto
            - script
            - manual
          readOnly: true
        confidence:
          title: Confidence
          type: number
          readOnly: true
          nullable: true
        confidence_threshold:
          title: Confidence threshold
          type: number
          readOnly: true
          nullable: true
        confidence_status:
          title: Confidence status
          type: string
          enum:
            - confident
            - needs_attention
          readOnly: true
          nullable: true
        co2_kg:
          title: Co2 kg
          type: number
          readOnly: true
          nullable: true
        flags:
          title: Flags
          type: object
          readOnly: true
          nullable: true
        deleted_at:
          title: Deleted at
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    EmissionCsvExport:
      type: object
      properties:
        accounting_date:
          title: Accounting date
          type: string
          format: date-time
          nullable: true
        journal:
          title: Journal
          type: string
          maxLength: 255
          nullable: true
        title:
          title: Title
          type: string
          maxLength: 255
          nullable: true
        vendor_name:
          title: Vendor name
          type: string
          maxLength: 255
          nullable: true
        description:
          title: Description
          type: string
          maxLength: 1024
          nullable: true
        company_tags_names:
          title: Company tags names
          type: string
          minLength: 1
        volume:
          title: Volume
          type: number
          nullable: true
        volume_unit:
          title: Volume unit
          type: string
          maxLength: 255
          nullable: true
        co2_kg:
          title: Co2 kg
          type: number
          nullable: true
        scope:
          title: Scope
          type: string
          enum:
            - '1'
            - '2'
            - '3'
            - Offset
            - Excluded
        ghg_category_name:
          title: Ghg category name
          type: string
          maxLength: 255
          nullable: true
        category_name:
          title: Category name
          type: string
          maxLength: 255
          nullable: true
        ef_title:
          title: Ef title
          type: string
          minLength: 1
        ef_description:
          title: Ef description
          type: string
          minLength: 1
        ef_multiplier:
          title: Ef multiplier
          type: string
          minLength: 1
        emission_unit_name:
          title: Emission unit name
          type: string
          maxLength: 255
          nullable: true
        ef_source:
          title: Ef source
          type: string
          minLength: 1
        ef_year:
          title: Ef year
          type: string
          minLength: 1
        is_activity_based_emission:
          title: Is activity based emission
          type: boolean
        is_tag_along:
          title: Is tag along
          type: boolean
        transaction:
          title: Transaction
          type: integer
          nullable: true
    DocxExport:
      required:
        - report_type
        - start_date
        - end_date
      type: object
      properties:
        report_type:
          title: Report type
          type: string
          enum:
            - climatiq_emission
            - ghg_emission
        start_date:
          title: Start date
          type: string
          format: date
        end_date:
          title: End date
          type: string
          format: date
    GreenhouseGasCategory:
      required:
        - title
        - scope
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        slug:
          title: Slug
          type: string
          maxLength: 255
          nullable: true
        title:
          title: Title
          type: string
          maxLength: 255
          minLength: 1
        scope:
          title: Scope
          type: string
          enum:
            - '1'
            - '2'
            - '3'
            - Offset
            - Excluded
        emission_direction:
          title: Emission direction
          type: string
          enum:
            - upstream
            - downstream
          nullable: true
    ETransaction:
      required:
        - net_amount
        - currency
        - date
        - ledger
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        net_amount:
          title: Net amount
          type: number
        currency:
          title: Currency
          type: string
          maxLength: 10
          minLength: 1
        vendor_name:
          title: Vendor name
          type: string
          maxLength: 255
          nullable: true
        date:
          title: Date
          type: string
          format: date-time
        end_date:
          title: End date
          type: string
          format: date-time
          nullable: true
        ledger:
          title: Ledger
          type: string
          maxLength: 255
          minLength: 1
        journal:
          title: Journal
          type: string
          maxLength: 255
          nullable: true
        description:
          title: Description
          type: string
          maxLength: 1024
          nullable: true
        tags:
          type: array
          items:
            type: string
          readOnly: true
        status:
          title: Status
          type: string
          enum:
            - new
            - classified
        source:
          title: Source
          type: string
          enum:
            - codat
            - chift
            - lune
            - regreener
            - csv
        total_co2_kg:
          title: Total co2 kg
          type: string
          readOnly: true
        emissions:
          title: Emissions
          type: string
          readOnly: true
    TransactionStatistics:
      required:
        - count
        - total_amount
        - currency
        - total_co2_kg
      type: object
      properties:
        count:
          title: Count
          type: integer
        total_amount:
          title: Total amount
          type: number
        currency:
          title: Currency
          type: string
          minLength: 1
        total_co2_kg:
          title: Total co2 kg
          type: number
    SimpleCompanyTag:
      required:
        - name
      type: object
      properties:
        name:
          title: Name
          type: string
          maxLength: 20
          minLength: 1
    SimpleEmissionFactorCategory:
      required:
        - title
      type: object
      properties:
        title:
          title: Title
          type: string
          maxLength: 255
          minLength: 1
    SimpleGreenhouseGasCategory:
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        slug:
          title: Slug
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        title:
          title: Title
          type: string
          readOnly: true
          minLength: 1
        scope:
          title: Scope
          type: string
          enum:
            - '1'
            - '2'
            - '3'
            - Offset
            - Excluded
          readOnly: true
        emission_direction:
          title: Emission direction
          type: string
          enum:
            - upstream
            - downstream
          readOnly: true
          nullable: true
        color:
          title: Color
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        icon:
          title: Icon
          type: string
          readOnly: true
          format: uri
          nullable: true
    RelatedEmission:
      required:
        - classification_category
        - sub_category
        - category
        - ghg_category
        - company_name
        - company
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        company_tags:
          type: array
          items:
            $ref: '#/components/schemas/SimpleCompanyTag'
          readOnly: true
        transaction_vendor_name:
          title: Transaction vendor name
          type: string
          minLength: 1
          nullable: true
        transaction_description:
          title: Transaction description
          type: string
          minLength: 1
          nullable: true
        classification_category:
          $ref: '#/components/schemas/SimpleEmissionFactorCategory'
        sub_category:
          $ref: '#/components/schemas/SimpleEmissionFactorCategory'
        category:
          $ref: '#/components/schemas/SimpleEmissionFactorCategory'
        ghg_category:
          $ref: '#/components/schemas/SimpleGreenhouseGasCategory'
        tag_along_emissions:
          title: Tag along emissions
          type: object
          readOnly: true
        transaction_total_net_amount:
          title: Transaction total net amount
          type: number
          readOnly: true
        transaction_net_amount:
          title: Transaction net amount
          type: number
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
        company_name:
          title: Company name
          type: string
          maxLength: 1024
          minLength: 1
        emission_group_id:
          title: Emission group id
          type: string
          format: uuid
        total_volume:
          title: Total volume
          type: number
          nullable: true
        volume:
          title: Volume
          type: number
          nullable: true
        volume_unit:
          title: Volume unit
          type: string
          maxLength: 255
          nullable: true
        journal:
          title: Journal
          type: string
          maxLength: 255
          nullable: true
        title:
          title: Title
          type: string
          maxLength: 255
          nullable: true
        description:
          title: Description
          type: string
          maxLength: 1024
          nullable: true
        vendor_name:
          title: Vendor name
          type: string
          maxLength: 255
          nullable: true
        accounting_date:
          title: Accounting date
          type: string
          format: date-time
          nullable: true
        accounting_end_date:
          title: Accounting end date
          type: string
          format: date-time
          nullable: true
        transaction_is_visible:
          title: Transaction is visible
          type: boolean
          nullable: true
        transaction_data:
          title: Transaction data
          type: object
          nullable: true
        is_activity_based_emission:
          title: Is activity based emission
          type: boolean
        activity_data:
          title: Activity data
          type: object
          nullable: true
        emission_unit_name:
          title: Emission unit name
          type: string
          maxLength: 255
          nullable: true
        emission_factor_data:
          title: Emission factor data
          type: object
          nullable: true
        classification_category_name:
          title: Classification category name
          type: string
          maxLength: 255
          nullable: true
        sub_category_name:
          title: Sub category name
          type: string
          maxLength: 255
          nullable: true
        category_name:
          title: Category name
          type: string
          maxLength: 255
          nullable: true
        ghg_category_name:
          title: Ghg category name
          type: string
          maxLength: 255
          nullable: true
        scope:
          title: Scope
          type: string
          enum:
            - '1'
            - '2'
            - '3'
            - Offset
            - Excluded
        is_tag_along:
          title: Is tag along
          type: boolean
        classification_source:
          title: Classification source
          type: string
          enum:
            - auto
            - script
            - manual
        confidence:
          title: Confidence
          type: number
          nullable: true
        confidence_threshold:
          title: Confidence threshold
          type: number
          nullable: true
        confidence_status:
          title: Confidence status
          type: string
          enum:
            - confident
            - needs_attention
          nullable: true
        co2_kg:
          title: Co2 kg
          type: number
          nullable: true
        ml_metadata:
          title: Ml metadata
          type: object
          nullable: true
        testing_data:
          title: Testing data
          type: boolean
        flags:
          title: Flags
          type: object
          nullable: true
        deleted_at:
          title: Deleted at
          type: string
          format: date-time
          nullable: true
        company:
          title: Company
          type: integer
        transaction:
          title: Transaction
          type: integer
          nullable: true
        emission_factor:
          title: Emission factor
          type: integer
          nullable: true
        emission_unit:
          title: Emission unit
          type: integer
          nullable: true
        main_emission:
          title: Main emission
          type: integer
          nullable: true
        created_by:
          title: Created by
          type: integer
          nullable: true
    AirtableRequest:
      required:
        - url
      type: object
      properties:
        url:
          title: Url
          type: string
          format: uri
          minLength: 1
    SyncChiftTransactions:
      required:
        - company_id
        - integration_id
      type: object
      properties:
        company_id:
          title: Company id
          type: integer
        integration_id:
          title: Integration id
          type: integer
    AccountingSelection:
      required:
        - name
        - type
        - journal
        - company
        - integration
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        transaction_count:
          title: Transaction count
          type: string
          readOnly: true
        journal_name:
          title: Journal name
          type: string
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
        name:
          title: Name
          type: string
          maxLength: 1024
          nullable: true
        type:
          title: Type
          type: string
          enum:
            - ledger
            - journal
        external_id:
          title: External id
          type: string
          maxLength: 255
          nullable: true
        is_included_in_analysis:
          title: Is included in analysis
          type: boolean
          nullable: true
        journal:
          title: Journal
          type: integer
          nullable: true
        company:
          title: Company
          type: integer
        integration:
          title: Integration
          type: integer
    Integration:
      required:
        - type
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        type:
          title: Type
          type: string
          enum:
            - codat
            - chift
            - lune
            - regreener
            - csv
        name:
          title: Name
          type: string
          maxLength: 1024
          nullable: true
        lune_account_id:
          title: Lune account id
          type: string
          maxLength: 1024
          nullable: true
        type_access_token:
          title: Type access token
          type: string
          maxLength: 1024
          nullable: true
        company:
          title: Company
          type: integer
        created_by:
          title: Created by
          type: integer
          nullable: true
        last_synced_at:
          title: Last synced at
          type: string
          format: date-time
          nullable: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
        logs:
          title: Logs
          type: object
          nullable: true
        linked_by_first_name:
          title: Linked by first name
          type: string
          readOnly: true
        linked_by_last_name:
          title: Linked by last name
          type: string
          readOnly: true
        linked_by_email:
          title: Linked by email
          type: string
          readOnly: true
        transactions_count:
          title: Transactions count
          type: string
          readOnly: true
        status:
          title: Status
          type: string
          enum:
            - inactive
            - uploading
            - importing transactions
            - upload failed
            - needs review
            - analysis running
            - analysis completed
          nullable: true
        connection_status:
          title: Connection status
          type: string
          enum:
            - active
            - inactive
          nullable: true
    CreateManualInputTransactions:
      required:
        - sub_category_id
      type: object
      properties:
        sub_category_id:
          title: Sub category id
          type: integer
    CommentListRequest:
      required:
        - identifiers
      type: object
      properties:
        identifiers:
          type: array
          items:
            type: string
            nullable: true
    CommentListResponse:
      required:
        - id
        - message
        - identifier
        - company_id
        - author_id
        - submitted_at
        - is_edited
      type: object
      properties:
        id:
          title: Id
          type: integer
        message:
          title: Message
          type: string
          minLength: 1
        identifier:
          title: Identifier
          type: string
          maxLength: 1024
          minLength: 1
        company_id:
          title: Company id
          type: integer
        author_id:
          title: Author id
          type: integer
        submitted_at:
          title: Submitted at
          type: string
          format: date-time
        return_url:
          title: Return url
          type: string
          format: uri
          minLength: 1
          nullable: true
        created_at:
          title: Created at
          type: string
          format: date-time
        is_edited:
          title: Is edited
          type: boolean
    ContributorListResponse:
      required:
        - id
        - type
        - contributor_id
        - identifier
        - company_id
        - user_company_id
        - created_at
      type: object
      properties:
        id:
          title: Id
          type: integer
        type:
          title: Type
          type: string
          enum:
            - assignee
            - reviewer
            - auditor
            - owner
        contributor_id:
          title: Contributor id
          type: integer
        identifier:
          title: Identifier
          type: string
          maxLength: 1024
          minLength: 1
        company_id:
          title: Company id
          type: integer
        user_company_id:
          title: User company id
          type: integer
        created_at:
          title: Created at
          type: string
          format: date-time
    ContributorListRequest:
      required:
        - identifiers
      type: object
      properties:
        type:
          title: Type
          type: string
          enum:
            - assignee
            - reviewer
            - auditor
            - owner
        contributor_ids:
          type: array
          items:
            type: integer
        identifiers:
          type: array
          items:
            type: string
            minLength: 1
    CompanyForPulse:
      required:
        - name
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        name:
          title: Name
          type: string
          maxLength: 1024
          minLength: 1
    UserCompanyForPulse:
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        company_id:
          title: Company id
          type: string
          readOnly: true
        data_room_consumer_id:
          title: Data room consumer id
          type: string
          maxLength: 1024
          nullable: true
    DocumentListRequest:
      type: object
      properties:
        company:
          $ref: '#/components/schemas/CompanyForPulse'
        user_company:
          $ref: '#/components/schemas/UserCompanyForPulse'
        name:
          title: Name
          type: string
          minLength: 1
        identifiers:
          type: array
          items:
            type: string
            minLength: 1
    DocumentListResponse:
      required:
        - id
        - name
        - file_path
        - source
        - company_id
        - user_company_id
        - created_at
        - updated_at
        - pulse_params
      type: object
      properties:
        id:
          title: Id
          type: integer
        name:
          title: Name
          type: string
          minLength: 1
        file_path:
          title: File path
          type: string
          minLength: 1
        description:
          title: Description
          type: string
          nullable: true
        source:
          title: Source
          type: string
          enum:
            - pdf
            - docx
            - doc
            - xlsx
            - xls
            - pptx
            - ppt
            - csv
            - txt
            - rtf
            - jpg
            - jpeg
            - png
            - xml
            - json
            - md
            - tex
        company_id:
          title: Company id
          type: integer
        user_company_id:
          title: User company id
          type: integer
        created_at:
          title: Created at
          type: string
          format: date-time
        updated_at:
          title: Updated at
          type: string
          format: date-time
        pulse_params:
          title: Pulse params
          type: object
          additionalProperties:
            type: string
            nullable: true
        identifiers:
          type: array
          items:
            type: string
            nullable: true
    SSOSignup:
      type: object
      properties:
        user_invitation_id:
          title: User invitation id
          type: string
          maxLength: 1024
    Signup:
      required:
        - password
        - repeated_password
        - first_name
        - last_name
        - email
      type: object
      properties:
        password:
          title: Password
          type: string
          maxLength: 1024
          minLength: 1
        repeated_password:
          title: Repeated password
          type: string
          maxLength: 1024
          minLength: 1
        first_name:
          title: First name
          type: string
          maxLength: 1024
          minLength: 1
        last_name:
          title: Last name
          type: string
          maxLength: 1024
          minLength: 1
        company:
          title: Company
          type: string
          maxLength: 1024
        job_title:
          title: Job title
          type: string
          maxLength: 1024
        email:
          title: Email
          type: string
          maxLength: 1024
          minLength: 1
        user_invitation_id:
          title: User invitation id
          type: string
          maxLength: 1024
    Survey:
      required:
        - name
        - questions
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        name:
          title: Name
          type: string
          maxLength: 255
          minLength: 1
        questions:
          title: Questions
          type: object
        survey_questions:
          title: Survey questions
          type: string
          readOnly: true
        survey_answers:
          title: Survey answers
          type: string
          readOnly: true
    SurveyAnswer:
      required:
        - year
        - answers
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        year:
          title: Year
          type: string
          format: date
        answers:
          title: Answers
          type: object
    Answer:
      required:
        - question
        - year
        - text
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        question:
          title: Question
          type: integer
        year:
          title: Year
          type: string
          format: date
        text:
          title: Text
          type: string
          maxLength: 255
          minLength: 1
    BasicIntegration:
      required:
        - type
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        type:
          title: Type
          type: string
          enum:
            - codat
            - chift
            - lune
            - regreener
            - csv
        name:
          title: Name
          type: string
          maxLength: 1024
          nullable: true
    TransactionEmissionClassification:
      required:
        - transaction
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        transaction:
          title: Transaction
          type: integer
        emission_factor:
          $ref: '#/components/schemas/EmissionFactor'
        confidence:
          title: Confidence
          type: number
          nullable: true
        source:
          title: Source
          type: string
          enum:
            - auto
            - manual
        auto_classification_version:
          title: Auto classification version
          type: string
          maxLength: 16
          nullable: true
        co2_kg:
          title: Co2 kg
          type: number
          nullable: true
    ManualInputAnswer:
      type: object
      properties:
        manual_input_id:
          title: Manual input id
          type: string
          readOnly: true
        emission_factor_title:
          title: Emission factor title
          type: string
          readOnly: true
        value:
          title: Value
          type: number
          nullable: true
    Transaction:
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        type:
          title: Type
          type: string
          enum:
            - income
            - expense
          readOnly: true
        vat_rate:
          title: Vat rate
          type: number
          readOnly: true
          nullable: true
        net_amount:
          title: Net amount
          type: number
          readOnly: true
        gross_amount:
          title: Gross amount
          type: number
          readOnly: true
        currency:
          title: Currency
          type: string
          readOnly: true
          minLength: 1
        vendor_name:
          title: Vendor name
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        date:
          title: Date
          type: string
          format: date-time
          readOnly: true
        end_date:
          title: End date
          type: string
          format: date-time
          readOnly: true
          nullable: true
        title:
          title: Title
          type: string
          readOnly: true
        ledger:
          title: Ledger
          type: string
          readOnly: true
          minLength: 1
        journal:
          title: Journal
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        status:
          title: Status
          type: string
          enum:
            - new
            - classified
          readOnly: true
        description:
          title: Description
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        external_id:
          title: External id
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        integration:
          $ref: '#/components/schemas/BasicIntegration'
        emission_classification:
          $ref: '#/components/schemas/TransactionEmissionClassification'
        company:
          title: Company
          type: integer
          readOnly: true
        skip_manual_input:
          title: Skip manual input
          type: boolean
          readOnly: true
        manual_input_completed:
          title: Manual input completed
          type: boolean
          readOnly: true
        manual_input_answers:
          type: array
          items:
            $ref: '#/components/schemas/ManualInputAnswer'
        tags:
          title: Tags
          type: string
          readOnly: true
    BulkClassificationConfidenceRequest:
      required:
        - transaction_ids
        - source
      type: object
      properties:
        transaction_ids:
          type: array
          items:
            type: integer
        source:
          title: Source
          type: string
          enum:
            - auto
            - manual
    BulkClassificationRequest:
      required:
        - transaction_id
      type: object
      properties:
        transaction_id:
          title: Transaction id
          type: integer
        emission_factor_id:
          title: Emission factor id
          type: integer
    Insights:
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        name:
          title: Name
          type: string
          readOnly: true
          minLength: 1
        description:
          title: Description
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        detailed_description:
          title: Detailed description
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        result_score:
          title: Result score
          type: integer
          readOnly: true
    CreateUserInvitationMultiCompany:
      required:
        - email
        - auth_group
      type: object
      properties:
        id:
          title: Id
          type: string
          format: uuid
          readOnly: true
        email:
          title: Email
          type: string
          format: email
          maxLength: 1024
          minLength: 1
        auth_group:
          title: Auth group
          type: integer
    RetrieveUserInvitation:
      required:
        - is_existing_user
      type: object
      properties:
        id:
          title: Id
          type: string
          format: uuid
          readOnly: true
        email:
          title: Email
          type: string
          format: email
          maxLength: 1024
          nullable: true
        company:
          $ref: '#/components/schemas/Company'
        auth_group_id:
          title: Auth group id
          type: string
          readOnly: true
        is_existing_user:
          title: Is existing user
          type: boolean
        is_active:
          title: Is active
          type: string
          readOnly: true
        is_mfa_enabled:
          title: Is mfa enabled
          type: string
          readOnly: true
    SimpleUserCompany:
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        user_id:
          title: User id
          type: string
          readOnly: true
        company_id:
          title: Company id
          type: string
          readOnly: true
        auth_group_id:
          title: Auth group id
          type: string
          readOnly: true
        data_room_consumer_id:
          title: Data room consumer id
          type: string
          maxLength: 1024
          nullable: true
        config:
          title: Config
          type: object
      nullable: true
    User:
      required:
        - first_name
        - last_name
      type: object
      properties:
        first_name:
          title: First name
          type: string
          maxLength: 1024
          minLength: 1
        last_name:
          title: Last name
          type: string
          maxLength: 1024
          minLength: 1
        email:
          title: Email
          type: string
          format: email
          maxLength: 1024
          nullable: true
        id:
          title: ID
          type: integer
          readOnly: true
        firebase_uid:
          title: Firebase uid
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        active_user_company_id:
          title: Active user company id
          type: integer
        user_company:
          $ref: '#/components/schemas/SimpleUserCompany'
        company:
          $ref: '#/components/schemas/Company'
        job_title:
          title: Job title
          type: string
          maxLength: 1024
          nullable: true
        profile_picture:
          title: Profile picture
          type: string
          readOnly: true
          format: uri
          nullable: true
        auth_group:
          $ref: '#/components/schemas/Group'
        is_mfa_enrolled:
          title: Is mfa enrolled
          type: string
          readOnly: true
        is_mfa_required:
          title: Is mfa required
          type: string
          readOnly: true
        data_room_consumer_id:
          title: Data room consumer id
          type: string
          readOnly: true
    ResetPassword:
      required:
        - email
      type: object
      properties:
        email:
          title: Email
          type: string
          format: email
          minLength: 1
    UserCompany:
      required:
        - workspace_name
        - workspace_id
      type: object
      properties:
        workspace_name:
          title: Workspace name
          type: string
          minLength: 1
        workspace_id:
          title: Workspace id
          type: integer
        workspace_logo:
          title: Workspace logo
          type: string
          readOnly: true
          format: uri
        member_count:
          title: Member count
          type: string
          readOnly: true
        is_mfa_enabled:
          title: Is mfa enabled
          type: string
          readOnly: true
    UserUpdate:
      required:
        - first_name
        - last_name
      type: object
      properties:
        first_name:
          title: First name
          type: string
          maxLength: 1024
          minLength: 1
        last_name:
          title: Last name
          type: string
          maxLength: 1024
          minLength: 1
        email:
          title: Email
          type: string
          format: email
          maxLength: 1024
          nullable: true
        job_title:
          title: Job title
          type: string
          maxLength: 1024
          nullable: true
        profile_picture:
          title: Profile picture
          type: string
          readOnly: true
          format: uri
          nullable: true
    Marketplace:
      required:
        - focus_areas
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        name:
          title: Name
          type: string
          readOnly: true
          minLength: 1
        description:
          title: Description
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        detailed_description:
          title: Detailed description
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        result_score:
          title: Result score
          type: integer
          readOnly: true
        vendor_type:
          title: Vendor type
          type: string
          enum:
            - normal
            - sustainable
            - reduction tool
          readOnly: true
        logo:
          title: Logo
          type: string
          readOnly: true
          format: uri
          nullable: true
        url:
          title: Url
          type: string
          format: uri
          readOnly: true
          minLength: 1
          nullable: true
        source:
          title: Source
          type: string
          format: uri
          readOnly: true
          minLength: 1
          nullable: true
        commitment_description:
          title: Commitment description
          type: string
          readOnly: true
          minLength: 1
          nullable: true
        sustainability_type:
          title: Sustainability type
          type: string
          enum:
            - carbon neutral
            - optionally carbon neutral
          readOnly: true
          nullable: true
        maturity:
          title: Maturity
          type: string
          enum:
            - established
            - growth
            - startup
          readOnly: true
          nullable: true
        reviewed_at:
          title: Reviewed at
          type: string
          format: date
          readOnly: true
          nullable: true
        focus_areas:
          type: array
          items:
            $ref: '#/components/schemas/EmissionFactorCategory'
        locations:
          title: Locations
          type: string
          readOnly: true
    BatchChannelAuth:
      required:
        - socket_id
        - channel_names
      type: object
      properties:
        socket_id:
          title: Socket id
          type: string
          maxLength: 100
          minLength: 1
        channel_names:
          type: array
          items:
            type: string
            maxLength: 100
            minLength: 1
    ChannelAuth:
      required:
        - channel_name
        - socket_id
      type: object
      properties:
        channel_name:
          title: Channel name
          type: string
          maxLength: 100
          minLength: 1
        socket_id:
          title: Socket id
          type: string
          maxLength: 100
          minLength: 1
    TeamMember:
      required:
        - first_name
        - last_name
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        first_name:
          title: First name
          type: string
          maxLength: 1024
          minLength: 1
        last_name:
          title: Last name
          type: string
          maxLength: 1024
          minLength: 1
        job_title:
          title: Job title
          type: string
          maxLength: 1024
          nullable: true
        profile_picture:
          title: Profile picture
          type: string
          readOnly: true
          format: uri
          nullable: true
        email:
          title: Email
          type: string
          format: email
          maxLength: 1024
          nullable: true
    WorkspaceTeamMember:
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        user:
          $ref: '#/components/schemas/TeamMember'
        auth_group:
          title: Auth group
          type: integer
          nullable: true
        auth_group_name:
          title: Auth group name
          type: string
          readOnly: true
          minLength: 1
        data_room_consumer_id:
          title: Data room consumer id
          type: string
          maxLength: 1024
          nullable: true
  securitySchemes:
    Bearer:
      description: >-
        Our firebase api token, used to authenticate. Bearer prefix required
        before token
      type: apiKey
      name: Authorization
      in: header
security:
  - Bearer: []
tags:
  - name: emission_calculations
