Feedback

Improving our services is important to us. Therefore, sending us feedback helps us. Through the endpoint Create a feedback this is possible.

Each feedback has a module and type. The module gives us information about the context of the feedback, e.g., the service or module the feedback is about. The type corresponds to the information that is given to us, on which we can act upon. Both of these fields are related to each other and can only be used in these combinations:

Module	Supported Types
contractor	rating, interaction
cockpit	cockpit
company-logos	missing-logo, wrong-logo, outdated-logo

Important: Each type influences the required feedback-field model!

Type: rating

---

"feedback":{
    "rating": "<int>"
}

Limitations:

• rating value in range: minimum: 1 and maximum: 5

---

Type: interaction

---

"feedback":{
    "interaction": "<string>"
}

Limitations:

• interaction any value of: tagChange

---

Type: cockpit

---

"feedback": {
    "rating": "<int>",
    "cockpitID": "<string>",
    "cockpitTenantID": "<string>",
    "cockpitLink": "<string>"
}

Limitations:

• rating is optional and may contain a value in range: 1 - 5
• cockpitLink is optional

---

Type: missing-logo, wrong-logo, outdated-logo

---

"feedback": {
    "url": "<string>",
    "squareURL": "<string>",
    "bankCode": "<string>",
    "bic":"<string>",
    "creditorID":"<string>",
    "domain":"<string>",
    "iban":"<string>",
    "name":"<string>",
    "companyID":"<string>",
    "requestBody":"<object>",
    "logoTypes":"<[]string>"
}

Limitations:

• logoTypes is optional and may contain any value of: default or square
• logoTypes default value is ["default"]
• At least one of the following fields must be set (we encourage you to set more fields):
  • url
  • squareURL
  • bankCode
  • bic
  • creditorID
  • domain
  • iban
  • name
  • companyID
  • requestBody

---

Type: renter-information-selection

---

{
  "feedback": {
    "userSelections": [
      {
        "transactionIDs": ["<transactionID>"],
        "category": "salary"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "fallbackIncome"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "rental"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "fallbackRental"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "salesOfSecurities"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "childBenefit"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "rentalIncoming"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "pocketMoney"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "governmentSupport"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "governmentChildSupport"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "commissionIncome"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "studentLoan"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "parentalAllowance"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "maternityAllowance"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "cryptocurrencyPayout"
      },
      {
        "transactionIDs": ["<transactionID>"],
        "category": "studiesSupport"
      }
    ]
  }
}

Limitations:

• <transactionID> values are of type string and the selected transactions in the renter information scope

---