---
openapi: "3.0.3"
info:
  title: "VertiCer Trader API"
  contact:
    name: "VertiCer support"
    url: "https://verticer.eu/nl/contact/"
  version: "1.0"
servers:
- url: "/myverticer/api/trader/"
  description: "Proxy Server"
- url: "https://acce-my.verticer.eu/myverticer/api/trader/"
  description: "ACC Server"
- url: "https://my.verticer.eu/myverticer/api/trader/"
  description: "PRD Server"
security:
- apiKey: []
tags:
- name: "Certificate"
  description: "Endpoints for retrieving of certificate data"
- name: "Transaction"
  description: "Endpoints to do trading transactions"
paths:
  /certificate/tradable/search:
    post:
      tags:
      - "Certificate"
      summary: "Retrieve tradable certificates"
      description: "Retrieve all valid certificates that can be used for trading purposes.\
        \ The returned id should be used as the id for rangeIds in the transactions\
        \ The details of the certificate correspond with the AIB specifications"
      operationId: "searchTradableCertificates"
      responses:
        "200":
          description: "List of tradable certificates"
          content:
            application/json:
              schema:
                type: "array"
                items:
                  $ref: "#/components/schemas/TradableCertificateDto"
        "400":
          $ref: "#/components/responses/400"
        "500":
          $ref: "#/components/responses/500"
  /transaction/export:
    post:
      tags:
      - "Transaction"
      summary: "Export Certificate"
      description: "Export given certificates"
      operationId: "executeExport"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CertificateExportDto"
        required: true
      responses:
        "200":
          description: "Hardcoded true response"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SimpleResponseDto"
        "400":
          $ref: "#/components/responses/400"
        "500":
          $ref: "#/components/responses/500"
  /transaction/redeem:
    post:
      tags:
      - "Transaction"
      summary: "Redeem Certificate"
      description: "Redeem given certificates"
      operationId: "executeRedeem"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CertificateRedeemDTO"
        required: true
      responses:
        "200":
          description: "Hardcoded true response"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SimpleResponseDto"
        "400":
          $ref: "#/components/responses/400"
        "500":
          $ref: "#/components/responses/500"
  /transaction/search/{offset}/{limit}:
    post:
      tags:
      - "Transaction"
      summary: "Search Transactions"
      description: "Search for certificate transactions, according to the specified\
        \ parameters. The max results is capped on 100 records"
      operationId: "searchTransactions"
      parameters:
      - name: "sort"
        in: "query"
        schema:
          $ref: "#/components/schemas/TransactionSortType"
      - $ref: "#/components/parameters/limit"
      - $ref: "#/components/parameters/offset"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TransactionSummarySearchDto"
        required: true
      responses:
        "200":
          description: "An object with a list of all the searched transactions"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionSummariesDto"
        "400":
          $ref: "#/components/responses/400"
        "500":
          $ref: "#/components/responses/500"
  /transaction/transfer:
    post:
      tags:
      - "Transaction"
      summary: "Transfer Certificate"
      description: "Transfer given certificates"
      operationId: "executeTransfer"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CertificateTransferDto"
        required: true
      responses:
        "200":
          description: "Hardcoded true response"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SimpleResponseDto"
        "400":
          $ref: "#/components/responses/400"
        "500":
          $ref: "#/components/responses/500"
components:
  schemas:
    AbsoluteGHGEmissionSaved:
      type: "object"
      properties:
        value:
          type: "number"
        calculationMethod:
          type: "string"
          xml:
            attribute: true
        unit:
          type: "string"
          xml:
            attribute: true
    Address:
      type: "object"
      properties:
        country:
          type: "string"
          xml:
            name: "Country"
            attribute: true
        city:
          type: "string"
          xml:
            name: "City"
            attribute: true
        postCode:
          type: "string"
          xml:
            name: "PostCode"
            attribute: true
    AibISO8601Mangler:
      type: "object"
      properties:
        time:
          format: "date-time"
          type: "string"
          example: "2022-03-10T12:15:50-04:00"
        formatter:
          type: "object"
    CalorificValue:
      type: "object"
      properties:
        value:
          type: "string"
        type:
          allOf:
          - $ref: "#/components/schemas/CalorificValueType"
          - xml:
              attribute: true
        unit:
          type: "string"
          xml:
            attribute: true
    CalorificValueType:
      enum:
      - "LOWER"
      - "HIGHER"
      type: "string"
    Capacity:
      type: "object"
      properties:
        electricalCapacity:
          type: "number"
          xml:
            name: "ElectricalCapacity"
        mechanicalCapacity:
          type: "number"
          xml:
            name: "MechanicalCapacity"
        thermalCapacity:
          type: "number"
          xml:
            name: "ThermalCapacity"
        gasProductionCapacity:
          type: "number"
          xml:
            name: "GasProductionCapacity"
    CertificateExportDto:
      title: "CertificateExportDto"
      description: "The dto needed for an export"
      required:
      - "executionDate"
      - "amount"
      - "reference"
      - "receivingParty"
      type: "object"
      properties:
        executionDate:
          format: "date"
          description: "The date the transaction has to be executed. Always use ISO\
            \ 8601 formatting"
          type: "string"
          example: "2022-03-10"
        amount:
          format: "int32"
          description: "The amount of certificates that should be used in the transaction"
          minimum: 1
          type: "integer"
        reference:
          description: "The transaction reference that is a correlation ID"
          maxLength: 255
          minLength: 1
          type: "string"
        rangeIds:
          description: "A list of Id's from ranges that should be used in the given\
            \ transaction XOR with collectionId. The rangeIds that are available for\
            \ trading can be retrieved from post tradable search"
          uniqueItems: true
          type: "array"
          items:
            format: "int64"
            type: "integer"
        collectionId:
          format: "int64"
          description: "An Id of the collection that should be used XOR with rangeIds.\
            \ Use the rangeIds if you want control which range of certificates should\
            \ be used for your transaction. If collectionId is used the application\
            \ uses the oldest ranges within the collections first."
          type: "integer"
        receivingParty:
          description: "The receiving party's account holder id"
          pattern: "^\\d{2}X[A-Z0-9]{6}[A-Z0-9]$"
          type: "string"
    CertificateRedeemDTO:
      title: "CertificateRedeemDTO"
      description: "A redeem object"
      required:
      - "executionDate"
      - "amount"
      - "reference"
      - "redeemType"
      - "receivingParty"
      type: "object"
      properties:
        executionDate:
          format: "date"
          description: "The date the transaction has to be executed. Always use ISO\
            \ 8601 formatting"
          type: "string"
          example: "2022-03-10"
        amount:
          format: "int32"
          description: "The amount of certificates that should be used in the transaction"
          minimum: 1
          type: "integer"
        reference:
          description: "The transaction reference that is a correlation ID"
          maxLength: 255
          minLength: 1
          type: "string"
        rangeIds:
          description: "A list of Id's from ranges that should be used in the given\
            \ transaction XOR with collectionId. The rangeIds that are available for\
            \ trading can be retrieved from post tradable search"
          uniqueItems: true
          type: "array"
          items:
            format: "int64"
            type: "integer"
        collectionId:
          format: "int64"
          description: "An Id of the collection that should be used XOR with rangeIds.\
            \ Use the rangeIds if you want control which range of certificates should\
            \ be used for your transaction. If collectionId is used the application\
            \ uses the oldest ranges within the collections first."
          type: "integer"
        redeemType:
          allOf:
          - $ref: "#/components/schemas/RedeemType"
          - description: "The redeem type"
        receivingParty:
          description: "The receiving party's account holder id"
          pattern: "^\\d{2}X[A-Z0-9]{6}[A-Z0-9]$"
          type: "string"
      oneOf:
      - $ref: "#/components/schemas/ConversionRedeemDto"
      - $ref: "#/components/schemas/EndUserRedeemDto"
      - $ref: "#/components/schemas/RedeemDto"
    CertificateTransactionStatus:
      title: "CertificateTransactionStatus"
      description: "The status of certificate transaction"
      enum:
      - "FAILED"
      - "EXECUTED"
      - "PENDING"
      - "SCHEDULED"
      type: "string"
    CertificateTransactionType:
      title: "CertificateTransactionType"
      description: "The type of certificate transaction"
      enum:
      - "IMPORT"
      - "EXPORT"
      - "INCOMING_TRANSFER"
      - "OUTGOING_TRANSFER"
      - "WITHDRAWAL"
      - "ISSUE"
      - "REDEEM"
      - "EXPIRY"
      type: "string"
    CertificateTransferDto:
      title: "CertificateTransferDto"
      description: "The dto needed for a transfer"
      required:
      - "executionDate"
      - "amount"
      - "reference"
      - "receivingParty"
      type: "object"
      properties:
        executionDate:
          format: "date"
          description: "The date the transaction has to be executed. Always use ISO\
            \ 8601 formatting"
          type: "string"
          example: "2022-03-10"
        amount:
          format: "int32"
          description: "The amount of certificates that should be used in the transaction"
          minimum: 1
          type: "integer"
        reference:
          description: "The transaction reference that is a correlation ID"
          maxLength: 255
          minLength: 1
          type: "string"
        rangeIds:
          description: "A list of Id's from ranges that should be used in the given\
            \ transaction XOR with collectionId. The rangeIds that are available for\
            \ trading can be retrieved from post tradable search"
          uniqueItems: true
          type: "array"
          items:
            format: "int64"
            type: "integer"
        collectionId:
          format: "int64"
          description: "An Id of the collection that should be used XOR with rangeIds.\
            \ Use the rangeIds if you want control which range of certificates should\
            \ be used for your transaction. If collectionId is used the application\
            \ uses the oldest ranges within the collections first."
          type: "integer"
        receivingParty:
          description: "The receiving party's account holder id"
          pattern: "^\\d{2}X[A-Z0-9]{6}[A-Z0-9]$"
          type: "string"
    Certificates:
      type: "object"
      properties:
        startCertificateNumber:
          allOf:
          - $ref: "#/components/schemas/StartCertificateNumber"
          - xml:
              name: "StartCertificateNumber"
        endCertificateNumber:
          allOf:
          - $ref: "#/components/schemas/EndCertificateNumber"
          - xml:
              name: "EndCertificateNumber"
        issuingBody:
          type: "string"
          xml:
            name: "IssuingBody"
        countryOfIssue:
          type: "string"
          xml:
            name: "CountryOfIssue"
        dateOfIssue:
          format: "date"
          type: "string"
          xml:
            name: "DateOfIssue"
          example: "2022-03-10"
        productionPeriod:
          allOf:
          - $ref: "#/components/schemas/ProductionPeriod"
          - xml:
              name: "ProductionPeriod"
        energyCarrier:
          type: "string"
          xml:
            name: "EnergyCarrier"
        conversion:
          allOf:
          - $ref: "#/components/schemas/Conversion"
          - xml:
              name: "Conversion"
        storage:
          allOf:
          - $ref: "#/components/schemas/Storage"
          - xml:
              name: "Storage"
        product:
          type: "array"
          items:
            $ref: "#/components/schemas/Product"
          xml:
            name: "Product"
        productionDeviceID:
          allOf:
          - $ref: "#/components/schemas/ProductionDeviceID"
          - xml:
              name: "ProductionDeviceID"
        productionDeviceName:
          type: "string"
          xml:
            name: "ProductionDeviceName"
        dateOperational:
          format: "date"
          type: "string"
          xml:
            name: "DateOperational"
          example: "2022-03-10"
        capacity:
          allOf:
          - $ref: "#/components/schemas/Capacity"
          - xml:
              name: "Capacity"
        module:
          allOf:
          - $ref: "#/components/schemas/Module"
          - xml:
              name: "Module"
        productionTechnology:
          allOf:
          - $ref: "#/components/schemas/ProductionTechnology"
          - xml:
              name: "ProductionTechnology"
        energySource:
          allOf:
          - $ref: "#/components/schemas/EnergySource"
          - xml:
              name: "EnergySource"
        sourceShares:
          type: "string"
          xml:
            name: "SourceShares"
        supportFlag:
          allOf:
          - $ref: "#/components/schemas/SupportFlag"
          - xml:
              name: "SupportFlag"
        productionSupportDescription:
          type: "string"
          xml:
            name: "ProductionSupportDescription"
        investmentSupportDescription:
          type: "string"
          xml:
            name: "InvestmentSupportDescription"
        productionDeviceLocation:
          allOf:
          - $ref: "#/components/schemas/ProductionDeviceLocation"
          - xml:
              name: "ProductionDeviceLocation"
        disseminationLevel:
          type: "string"
          xml:
            name: "DisseminationLevel"
        cogeneration:
          allOf:
          - $ref: "#/components/schemas/Cogeneration"
          - xml:
              name: "Cogeneration"
        electricalEfficiency:
          type: "number"
          xml:
            name: "ElectricalEfficiency"
        thermalEfficiency:
          type: "number"
          xml:
            name: "ThermalEfficiency"
        gas:
          allOf:
          - $ref: "#/components/schemas/Gas"
          - xml:
              name: "Gas"
        calorificValue:
          allOf:
          - $ref: "#/components/schemas/CalorificValue"
          - xml:
              name: "CalorificValue"
        ghgEmissions:
          allOf:
          - $ref: "#/components/schemas/GHGEmissions"
          - xml:
              name: "GHGEmissions"
        radioactiveWasteProduced:
          allOf:
          - $ref: "#/components/schemas/RadioactiveWasteProduced"
          - xml:
              name: "RadioactiveWasteProduced"
        sustainability:
          allOf:
          - $ref: "#/components/schemas/Sustainability"
          - xml:
              name: "Sustainability"
        label:
          type: "array"
          items:
            type: "string"
          xml:
            name: "Label"
        additionalInfo:
          type: "string"
          xml:
            name: "AdditionalInfo"
        faceValue:
          allOf:
          - $ref: "#/components/schemas/FaceValue"
          - xml:
              attribute: true
    Cogeneration:
      type: "object"
      properties:
        useOfHeat:
          type: "string"
          xml:
            name: "UseOfHeat"
        percentagePrimaryEnergySaved:
          type: "number"
          xml:
            name: "PercentagePrimaryEnergySaved"
        amountPrimaryEnergySaved:
          type: "number"
          xml:
            name: "AmountPrimaryEnergySaved"
        overallPrimaryEnergySavings:
          type: "number"
          xml:
            name: "OverallPrimaryEnergySavings"
        usefulHeat:
          type: "number"
          xml:
            name: "UsefulHeat"
        hecCriteriaMet:
          type: "boolean"
          xml:
            name: "HECCriteriaMet"
            attribute: true
    ConstraintType:
      title: "ConstraintType"
      description: "The type of the constraint validation"
      enum:
      - "CLASS"
      - "FIELD"
      - "PROPERTY"
      - "PARAMETER"
      - "RETURN_VALUE"
      type: "string"
    ConstraintViolation:
      title: "ConstraintViolation"
      description: "A singular ConstraintViolation"
      type: "object"
      properties:
        constraintType:
          $ref: "#/components/schemas/ConstraintType"
        path:
          description: "The path in the request that was submitted to the backend"
          type: "string"
        message:
          description: "The custom message that helps to understand the problem"
          type: "string"
        value:
          description: "The given value that is in error"
          type: "string"
    Conversion:
      type: "object"
      properties:
        tag:
          type: "string"
          xml:
            attribute: true
        preConversionSupportFlag:
          type: "string"
          xml:
            attribute: true
    ConversionRedeemDto:
      title: "ConversionRedeemDto"
      description: "The dto needed for a conversion redeem"
      required:
      - "executionDate"
      - "amount"
      - "reference"
      - "redeemType"
      - "receivingParty"
      - "supplyPeriod"
      - "ean"
      - "conversionTechnique"
      type: "object"
      properties:
        executionDate:
          format: "date"
          description: "The date the transaction has to be executed. Always use ISO\
            \ 8601 formatting"
          type: "string"
          example: "2022-03-10"
        amount:
          format: "int32"
          description: "The amount of certificates that should be used in the transaction"
          minimum: 1
          type: "integer"
        reference:
          description: "The transaction reference that is a correlation ID"
          maxLength: 255
          minLength: 1
          type: "string"
        rangeIds:
          description: "A list of Id's from ranges that should be used in the given\
            \ transaction XOR with collectionId. The rangeIds that are available for\
            \ trading can be retrieved from post tradable search"
          uniqueItems: true
          type: "array"
          items:
            format: "int64"
            type: "integer"
        collectionId:
          format: "int64"
          description: "An Id of the collection that should be used XOR with rangeIds.\
            \ Use the rangeIds if you want control which range of certificates should\
            \ be used for your transaction. If collectionId is used the application\
            \ uses the oldest ranges within the collections first."
          type: "integer"
        redeemType:
          allOf:
          - $ref: "#/components/schemas/RedeemType"
          - description: "The redeem type"
        receivingParty:
          description: "The receiving party's account holder id"
          pattern: "^\\d{2}X[A-Z0-9]{6}[A-Z0-9]$"
          type: "string"
        supplyPeriod:
          allOf:
          - $ref: "#/components/schemas/DatePeriod"
          - description: "The supply period for the redeem, should always be the first\
              \ of the month/year. A redeem on CONVERSION should always be exactly\
              \ 1 month (startDate 2026-01-01 - endDate 2026-02-01)"
        ean:
          format: "int64"
          description: "The EAN code of the electrolyzer"
          maximum: 999999999999999999
          minimum: 100000000000000000
          type: "integer"
        conversionTechnique:
          allOf:
          - $ref: "#/components/schemas/ConversionTechniqueType"
          - description: "The conversion technique that is used"
    ConversionTechniqueType:
      title: "ConversionTechniqueType"
      description: "Supported conversion techniques:\n - ELECTROLYZER: should always\
        \ be used in conjunction with the VertiCer ELECTROLYZER end consumer (07XVERTI11)"
      enum:
      - "ELECTROLYZER"
      type: "string"
    Coordinates:
      type: "object"
      properties:
        longitude:
          type: "string"
          xml:
            name: "Longitude"
            attribute: true
        latitude:
          type: "string"
          xml:
            name: "Latitude"
            attribute: true
        coordinateCode:
          type: "string"
          xml:
            name: "CoordinateCode"
            attribute: true
    DatePeriod:
      type: "object"
      properties:
        startDate:
          format: "date"
          description: "Start date of the period."
          type: "string"
          example: "2022-03-10"
        endDate:
          format: "date"
          description: "End date of the period."
          type: "string"
          example: "2022-03-10"
    EndCertificateNumber:
      type: "object"
      properties:
        value:
          type: "string"
        cs:
          type: "string"
          xml:
            name: "cS"
            attribute: true
    EndUserRedeemDto:
      title: "EndUserRedeemDto"
      description: "The dto needed for an end user redeem"
      required:
      - "executionDate"
      - "amount"
      - "reference"
      - "redeemType"
      - "receivingParty"
      - "supplyPeriod"
      type: "object"
      properties:
        executionDate:
          format: "date"
          description: "The date the transaction has to be executed. Always use ISO\
            \ 8601 formatting"
          type: "string"
          example: "2022-03-10"
        amount:
          format: "int32"
          description: "The amount of certificates that should be used in the transaction"
          minimum: 1
          type: "integer"
        reference:
          description: "The transaction reference that is a correlation ID"
          maxLength: 255
          minLength: 1
          type: "string"
        rangeIds:
          description: "A list of Id's from ranges that should be used in the given\
            \ transaction XOR with collectionId. The rangeIds that are available for\
            \ trading can be retrieved from post tradable search"
          uniqueItems: true
          type: "array"
          items:
            format: "int64"
            type: "integer"
        collectionId:
          format: "int64"
          description: "An Id of the collection that should be used XOR with rangeIds.\
            \ Use the rangeIds if you want control which range of certificates should\
            \ be used for your transaction. If collectionId is used the application\
            \ uses the oldest ranges within the collections first."
          type: "integer"
        redeemType:
          allOf:
          - $ref: "#/components/schemas/RedeemType"
          - description: "The redeem type"
        receivingParty:
          description: "The receiving party's account holder id"
          pattern: "^\\d{2}X[A-Z0-9]{6}[A-Z0-9]$"
          type: "string"
        supplyPeriod:
          allOf:
          - $ref: "#/components/schemas/DatePeriod"
          - description: "The supply period for the redeem, should always be the first\
              \ of the month/year. A redeem on END_CONSUMER should always be exactly\
              \ 1 year (startDate 2026-01-01 - endDate 2027-01-01"
    EnergySource:
      type: "object"
      properties:
        value:
          type: "string"
        cs:
          type: "string"
          xml:
            name: "cS"
            attribute: true
        advancedBiomassFeedstock:
          type: "boolean"
          xml:
            attribute: true
    ErrorDto:
      title: "ErrorDto"
      description: "An error object containing the error message"
      type: "object"
      properties:
        message:
          type: "string"
    FaceValue:
      enum:
      - "M_WH"
      type: "string"
    GHGEmissionProduced:
      type: "object"
      properties:
        value:
          type: "number"
        calculationMethod:
          type: "string"
          xml:
            attribute: true
        unit:
          type: "string"
          xml:
            attribute: true
    GHGEmissions:
      type: "object"
      properties:
        ghgEmissionProduced:
          allOf:
          - $ref: "#/components/schemas/GHGEmissionProduced"
          - xml:
              name: "GHGEmissionProduced"
        absoluteGHGEmissionSaved:
          allOf:
          - $ref: "#/components/schemas/AbsoluteGHGEmissionSaved"
          - xml:
              name: "AbsoluteGHGEmissionSaved"
        ghgSavingsCriteriaMet:
          type: "boolean"
          xml:
            name: "GHGSavingsCriteriaMet"
            attribute: true
    Gas:
      type: "object"
      properties:
        compositionPurity:
          type: "string"
          xml:
            name: "CompositionPurity"
        gasCompositionCriteria:
          type: "string"
          xml:
            name: "GasCompositionCriteria"
        gasUsage:
          type: "string"
          xml:
            name: "GasUsage"
        type:
          type: "string"
          xml:
            attribute: true
    LegalStatus:
      enum:
      - "LC"
      - "NGC"
      type: "string"
    Module:
      type: "object"
      properties:
        moduleCapacity:
          type: "number"
          xml:
            name: "ModuleCapacity"
        moduleDateOperational:
          format: "date"
          type: "string"
          xml:
            name: "ModuleDateOperational"
          example: "2022-03-10"
        moduleDescription:
          type: "string"
          xml:
            name: "ModuleDescription"
    Product:
      type: "object"
      properties:
        purpose:
          type: "array"
          items:
            type: "string"
          xml:
            name: "Purpose"
        competentAuthority:
          type: "array"
          items:
            type: "string"
          xml:
            name: "CompetentAuthority"
        productType:
          type: "array"
          items:
            $ref: "#/components/schemas/ProductType"
          xml:
            name: "ProductType"
        name:
          type: "string"
          xml:
            attribute: true
        legalStatus:
          allOf:
          - $ref: "#/components/schemas/LegalStatus"
          - xml:
              attribute: true
    ProductType:
      type: "object"
      properties:
        value:
          type: "string"
        type:
          type: "string"
          xml:
            attribute: true
    ProductionDeviceID:
      type: "object"
      properties:
        value:
          type: "string"
        cs:
          type: "string"
          xml:
            name: "cS"
            attribute: true
    ProductionDeviceLocation:
      type: "object"
      properties:
        coordinates:
          allOf:
          - $ref: "#/components/schemas/Coordinates"
          - xml:
              name: "Coordinates"
        address:
          allOf:
          - $ref: "#/components/schemas/Address"
          - xml:
              name: "Address"
    ProductionPeriod:
      type: "object"
      properties:
        start:
          allOf:
          - $ref: "#/components/schemas/AibISO8601Mangler"
          - xml:
              attribute: true
        end:
          allOf:
          - $ref: "#/components/schemas/AibISO8601Mangler"
          - xml:
              attribute: true
    ProductionTechnology:
      type: "object"
      properties:
        value:
          type: "string"
        cs:
          type: "string"
          xml:
            name: "cS"
            attribute: true
    RadioactiveWasteProduced:
      type: "object"
      properties:
        value:
          type: "number"
        calculationMethod:
          type: "string"
          xml:
            attribute: true
    RedeemDto:
      title: "RedeemDto"
      description: "The dto needed for a redeem"
      required:
      - "executionDate"
      - "amount"
      - "reference"
      - "redeemType"
      - "receivingParty"
      - "supplyPeriod"
      type: "object"
      properties:
        executionDate:
          format: "date"
          description: "The date the transaction has to be executed. Always use ISO\
            \ 8601 formatting"
          type: "string"
          example: "2022-03-10"
        amount:
          format: "int32"
          description: "The amount of certificates that should be used in the transaction"
          minimum: 1
          type: "integer"
        reference:
          description: "The transaction reference that is a correlation ID"
          maxLength: 255
          minLength: 1
          type: "string"
        rangeIds:
          description: "A list of Id's from ranges that should be used in the given\
            \ transaction XOR with collectionId. The rangeIds that are available for\
            \ trading can be retrieved from post tradable search"
          uniqueItems: true
          type: "array"
          items:
            format: "int64"
            type: "integer"
        collectionId:
          format: "int64"
          description: "An Id of the collection that should be used XOR with rangeIds.\
            \ Use the rangeIds if you want control which range of certificates should\
            \ be used for your transaction. If collectionId is used the application\
            \ uses the oldest ranges within the collections first."
          type: "integer"
        redeemType:
          allOf:
          - $ref: "#/components/schemas/RedeemType"
          - description: "The redeem type"
        receivingParty:
          description: "The receiving party's account holder id"
          pattern: "^\\d{2}X[A-Z0-9]{6}[A-Z0-9]$"
          type: "string"
        supplyPeriod:
          allOf:
          - $ref: "#/components/schemas/DatePeriod"
          - description: "The supply period for the redeem, should always be the first\
              \ of the month/year. A redeem on ENERGY_SUPPLIER should always be exactly\
              \ 1 month (startDate 2026-01-01 - endDate 2026-02-01)"
        product:
          description: "The product. If this is a new product GUI users will not see\
            \ this in the dropdown, but they do see it in the transaction details\
            \ when downloaded."
          maxLength: 255
          type: "string"
    RedeemType:
      title: "RedeemType"
      description: "Supported redeem types:\n - CONVERSION: Used for redeem on electrolyzer\
        \ and other techniques, always use in combination with the correct end consumer.\
        \ \n - ENERGY_SUPPLIER: Used for redeem on own trader. \n - END_CONSUMER:\
        \ Used for redeem on end consumers (other then conversion)"
      enum:
      - "CONVERSION"
      - "ENERGY_SUPPLIER"
      - "END_CONSUMER"
      type: "string"
    SimpleResponseDto:
      title: "SimpleResponseDto"
      description: "A simple string response"
      required:
      - "response"
      type: "object"
      properties:
        response:
          type: "string"
    StartCertificateNumber:
      type: "object"
      properties:
        value:
          type: "string"
        cs:
          type: "string"
          xml:
            name: "cS"
            attribute: true
    Storage:
      type: "object"
      properties:
        tag:
          type: "string"
          xml:
            attribute: true
    SupportFlag:
      type: "object"
      properties:
        value:
          format: "byte"
          type: "string"
        cs:
          type: "string"
          xml:
            name: "cS"
            attribute: true
    Sustainability:
      type: "object"
      properties:
        requirementReference:
          type: "string"
          xml:
            name: "RequirementReference"
        scheme:
          type: "string"
          xml:
            name: "Scheme"
        auditReport:
          type: "string"
          xml:
            name: "AuditReport"
        sustainabilityAdditionalInfo:
          type: "string"
          xml:
            name: "SustainabilityAdditionalInfo"
        sustainabilityCriteriaMet:
          type: "boolean"
          xml:
            attribute: true
        certificationBody:
          type: "string"
          xml:
            attribute: true
    TradableCertificateDto:
      title: "TradableCertificateDto"
      description: "A tradable certificate"
      required:
      - "rangeId"
      - "certificate"
      - "expirationDate"
      type: "object"
      properties:
        rangeId:
          format: "int64"
          description: "The unique ID of the certificate range"
          type: "integer"
        certificate:
          allOf:
          - $ref: "#/components/schemas/Certificates"
          - description: "The V80 certificate as described by the AIB"
        expirationDate:
          format: "date-time"
          description: "The expiration date of this certificate"
          type: "string"
          example: "2022-03-10T12:15:50"
    TransactionSortType:
      enum:
      - "EXECUTION_DATE"
      - "STATUS"
      type: "string"
    TransactionSummariesDto:
      title: "TransactionSummariesDto"
      description: "The transaction summaries"
      required:
      - "amountOfTransactionSummaries"
      - "transactionSummaries"
      type: "object"
      properties:
        amountOfTransactionSummaries:
          format: "int64"
          description: "Total amount off transactions that the search criteria can\
            \ select"
          type: "integer"
        transactionSummaries:
          description: "A list of transactions"
          type: "array"
          items:
            $ref: "#/components/schemas/TransactionSummaryDto"
    TransactionSummaryDto:
      title: "TransactionSummaryDto"
      description: "The summary of a transaction"
      required:
      - "transactionId"
      - "status"
      - "executionDate"
      - "type"
      - "amountOfCertificates"
      - "amountOfSeries"
      - "fromRelationAccountHolderId"
      - "fromRelationName"
      - "toRelationAccountHolderId"
      - "toRelationName"
      - "reference"
      type: "object"
      properties:
        transactionId:
          format: "int64"
          description: "The transaction Id"
          type: "integer"
        status:
          allOf:
          - $ref: "#/components/schemas/CertificateTransactionStatus"
          - description: "The status"
        executionDate:
          format: "date-time"
          description: "The execution date"
          type: "string"
          example: "2022-03-10T12:15:50"
        type:
          allOf:
          - $ref: "#/components/schemas/CertificateTransactionType"
          - description: "The type"
        amountOfCertificates:
          format: "int32"
          description: "The amount of certificates"
          type: "integer"
        amountOfSeries:
          format: "int32"
          description: "The amount of certificate series"
          type: "integer"
        collectionName:
          description: "The name of the collection"
          type: "string"
        collectionId:
          format: "int64"
          description: "The id of the collection"
          type: "integer"
        fromRelationAccountHolderId:
          description: "The account holder id of the sending party"
          type: "string"
        fromRelationName:
          description: "The name of the sending party"
          type: "string"
        toRelationAccountHolderId:
          description: "The account holder id of the receiving party"
          type: "string"
        toRelationName:
          description: "The name of the receiving party"
          type: "string"
        invoiceId:
          format: "int64"
          description: "The id of the invoice where this is invoice under"
          type: "integer"
        reference:
          description: "The reference that was given (CorrelationId)"
          type: "string"
        failureReason:
          description: "The failure reason, when the transaction failed"
          type: "string"
    TransactionSummarySearchDto:
      title: "TransactionSummarySearchDto"
      description: "The search parameters for transaction summaries"
      type: "object"
      properties:
        counterparty:
          description: "The account holder id of the counterparty"
          pattern: "^\\d{2}X[A-Z0-9]{6}[A-Z0-9]$"
          type: "string"
        invoiceId:
          format: "int64"
          description: "The invoice number of the invoice"
          type: "integer"
        transactionDateFrom:
          format: "date"
          description: "The transaction date from"
          type: "string"
          example: "2022-03-10"
        transactionDateTo:
          format: "date"
          description: "The transaction date to"
          type: "string"
          example: "2022-03-10"
        reference:
          description: "The reference that was given at the initiation of the transaction\
            \ (correlationId)"
          type: "string"
        types:
          description: "A list of certificate transaction types"
          type: "array"
          items:
            $ref: "#/components/schemas/CertificateTransactionType"
        statuses:
          description: "A list of certificate transaction statuses"
          type: "array"
          items:
            $ref: "#/components/schemas/CertificateTransactionStatus"
    ViolationReport:
      title: "ViolationReport"
      description: "The validation violations that occurred in the backend"
      type: "object"
      properties:
        exception:
          description: "The exception text"
          type: "string"
        fieldViolations:
          description: "The violations that went off on field level"
          type: "array"
          items:
            $ref: "#/components/schemas/ConstraintViolation"
        propertyViolations:
          description: "The violations that went off on property level"
          type: "array"
          items:
            $ref: "#/components/schemas/ConstraintViolation"
        classViolations:
          description: "The violations that went off on class level"
          type: "array"
          items:
            $ref: "#/components/schemas/ConstraintViolation"
        parameterViolations:
          description: "The violations that went off on parameter level"
          type: "array"
          items:
            $ref: "#/components/schemas/ConstraintViolation"
        returnValueViolations:
          description: "The violations that went off on return value level"
          type: "array"
          items:
            $ref: "#/components/schemas/ConstraintViolation"
  responses:
    "400":
      description: "The validation violations that occurred in the backend"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ViolationReport"
    "500":
      description: "An error object containing the error message"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorDto"
  parameters:
    ean18:
      name: "ean18"
      in: "query"
      description: "A valid Ean18 code"
      schema:
        format: "int64"
        type: "integer"
    limit:
      name: "limit"
      in: "path"
      description: "The max amount of records"
      required: true
      schema:
        format: "int32"
        type: "integer"
    offset:
      name: "offset"
      in: "path"
      description: "The starting record"
      required: true
      schema:
        format: "int32"
        type: "integer"
  securitySchemes:
    apiKey:
      type: "apiKey"
      name: "x-api-key"
      in: "header"