components:
  examples:

    # 400

    formatNino:
      description: The format of the supplied NINO field is not valid.
      value:
        code: FORMAT_NINO
        message: The provided NINO is invalid

    formatTaxYear:
      description: The format of the supplied taxYear value is not valid.
      value:
        code: FORMAT_TAX_YEAR
        message: The provided tax year is invalid

    formatBusinessId:
      description: The format of the supplied Business ID field is not valid.
      value:
        code: FORMAT_BUSINESS_ID
        message: The provided Business ID is invalid

    formatPropertyId:
      description: The format of the supplied property ID field is not valid.
      value:
        code: FORMAT_PROPERTY_ID
        message: The provided property ID is invalid

    ruleTaxYearNotSupported:
      description: |
        The specified tax year is not supported. That is, the tax year specified is before the minimum tax year value.
      value:
        code: RULE_TAX_YEAR_NOT_SUPPORTED
        message: The specified tax year is not supported. The tax year specified is before the minimum tax year value

    ruleTaxYearRangeInvalid:
      description: Tax year range invalid. A tax year range of one year is required.
      value:
        code: RULE_TAX_YEAR_RANGE_INVALID
        message: Tax year range invalid. A tax year range of one year is required

    ruleTypeOfBusinessIncorrectUk:
      description: The supplied Business ID does not represent a UK property business.
      value:
        code: RULE_TYPE_OF_BUSINESS_INCORRECT
        message: The businessId is for a different type of business

    formatValue:
      description: One or more values have been added with the incorrect format.
      value:
        code: FORMAT_VALUE
        message: The value must be between 0 and 99999999999.99

    formatDate:
      description: The supplied date format is not valid.
      value:
        code: FORMAT_DATE
        message: The supplied date format is not valid

    formatPropertyName:
      description: The format of the supplied property name is not valid.
      value:
        code: FORMAT_PROPERTY_NAME
        message: The provided property name is invalid

    formatEndDate:
      description: The format of the supplied end date is not valid.
      value:
        code: FORMAT_END_DATE
        message: The provided end date is invalid

    formatEndReason:
      description: The format of the supplied end reason is not valid.
      value:
        code: FORMAT_END_REASON
        message: The provided end reason is invalid

    formatString:
      description: One or more strings have been added with the incorrect format.
      value:
        code: FORMAT_STRING
        message: The supplied string format is not valid

    ruleIncorrectGovTestScenario:
      description: The request did not match any available Sandbox data. Check that the supplied Gov-Test-Scenario is correct for this endpoint version. This error will only be returned in the Sandbox environment.
      value:
        code: RULE_INCORRECT_GOV_TEST_SCENARIO
        message: The supplied Gov-Test-Scenario is not valid

    ruleIncorrectOrEmptyBody:
      description: An empty or non-matching body was submitted.
      value:
        code: RULE_INCORRECT_OR_EMPTY_BODY_SUBMITTED
        message: An empty or non-matching body was submitted

    ruleBothAllowancesSupplied:
      description: |
        Both allowances and property income allowance must not be present at the same time.
      value:
        code: RULE_BOTH_ALLOWANCES_SUPPLIED
        message: Both allowances and property allowances must not be present at the same time

    ruleBuildingNameNumber:
      description: One of building name or number must be supplied.
      value:
        code: RULE_BUILDING_NAME_NUMBER
        message: Postcode must be supplied along with at least one of name or number

    rulePropertyIncomeAllowance:
      description: The propertyIncomeAllowance cannot be submitted if privateUseAdjustment is supplied.
      value:
        code: RULE_PROPERTY_INCOME_ALLOWANCE
        message: The propertyIncomeAllowance cannot be submitted if privateUseAdjustment is supplied

    ruleBothExpensesSupplied:
      description: Both Expenses and Consolidated Expenses must not be present at the same time.
      value:
        code: RULE_BOTH_EXPENSES_SUPPLIED
        message: Both expenses and consolidatedExpenses can not be present at the same time

    ruleBothExpensesSuppliedWithForeignProperty:
      description: |
        Both Expenses and Consolidated Expenses must not be present at the same time.
      value:
        code: RULE_BOTH_EXPENSES_SUPPLIED
        message: Only one of either expenses or consolidatedExpenses can be supplied. A single expense type must be used for all foreign properties

    formatFromDate:
      description: The format of the supplied From date field is not valid.
      value:
        code: FORMAT_FROM_DATE
        message: The provided From date is invalid

    formatToDate:
      description: The format of the supplied To date field is not valid.
      value:
        code: FORMAT_TO_DATE
        message: The provided To date is invalid

    ruleToDateBeforeFromDate:
      description: The To date is earlier than the From date.
      value:
        code: RULE_TO_DATE_BEFORE_FROM_DATE
        message: The To date cannot be earlier than the From date

    ruleOverlappingPeriod:
      description: Period summary overlaps with any of the existing period summaries.
      value:
        code: RULE_OVERLAPPING_PERIOD
        message: Period summary overlaps with any of the existing period summaries

    ruleMisalignedPeriod:
      description: Period summary overlaps with any of the existing period summaries.
      value:
        code: RULE_MISALIGNED_PERIOD
        message: Period summary is not within the accounting period

    ruleNotContiguousPeriod:
      description: Period summaries are not contiguous.
      value:
        code: RULE_NOT_CONTIGUOUS_PERIOD
        message: Period summaries are not contiguous

    ruleDuplicateSubmission:
      description: Period summaries are not contiguous.
      value:
        code: RULE_DUPLICATE_SUBMISSION
        message: A summary has already been submitted for the period specified

    formatSubmissionId:
      description: The format of the supplied Submission ID field is not valid.
      value:
        code: FORMAT_SUBMISSION_ID
        message: The provided Submission ID is invalid

    formatFhlValue:
      description: One or more values have been added with the incorrect format.
      value:
        code: FORMAT_VALUE
        message: One or more monetary fields are invalid

    formatPeriodId:
      description: The format of the supplied Period ID field is not valid.
      value:
        code: FORMAT_PERIOD_ID
        message: The provided period id is invalid

    formatCountryCode:
      description: The format of the supplied Country Code field is not valid.
      value:
        code: FORMAT_COUNTRY_CODE
        message: The provided Country code is invalid

    missingFromDate:
      description: The From date parameter is missing.
      value:
        code: MISSING_FROM_DATE
        message: The From date parameter is missing

    missingToDate:
      description: The To date parameter is missing.
      value:
        code: MISSING_TO_DATE
        message: The To date parameter is missing

    invalidSubmissionEndDate:
      description: The submitted end date must be the end of the quarter.
      value:
        code: RULE_INVALID_SUBMISSION_END_DATE
        message: The submitted end date must be the end of the quarter

    invalidSubmissionPeriod:
      description: Property income and expenses submissions cannot be more than 10 days before the end of the Period.
      value:
        code: RULE_INVALID_SUBMISSION_PERIOD
        message: Property income and expenses submissions cannot be more than 10 days before the end of the Period

    ruleTaxYearNotSupportedMinMax:
      description: |
        The specified tax year is not supported.
        Either the tax year specified is before the minimum tax year value, or it is after the maximum tax year value.
      value:
        code: RULE_TAX_YEAR_NOT_SUPPORTED
        message: The tax year specified does not lie within the supported range

    rulePeriodTaxYearNotSupported:
      description: The specified period does not lie within the supported range.
      value:
        code: RULE_TAX_YEAR_NOT_SUPPORTED
        message: The tax year specified does not lie within the supported range

    ruleTypeOfBusinessIncorrectForeign:
      description: The supplied Business ID does not represent a foreign property business.
      value:
        code: RULE_TYPE_OF_BUSINESS_INCORRECT
        message: The businessId is for a different type of business

    ruleCountryCode:
      description: Not a permitted ISO 3166-1 alpha-3 country code.
      value:
        code: RULE_COUNTRY_CODE
        message: The country code is not a permitted ISO 3166-1 alpha-3 country code

    ruleDuplicateCountryCode:
      description: |
        The same countryCode cannot be supplied for multiple properties.
        If there are multiple properties per country the adjustments and allowances should be the total across all properties.
      value:
        code: RULE_DUPLICATE_COUNTRY_CODE
        message: You cannot supply the same country code for multiple properties

    ruleDuplicateCountryCodePeriodics:
      description: |
        You cannot supply the same country code for multiple properties.
        If there are multiple properties per country the income and expenses should be the total across all properties.
      value:
        code: RULE_DUPLICATE_COUNTRY_CODE
        message: You cannot supply the same country code for multiple properties

    ruleDuplicatePropertyId:
      description: |
        You cannot supply the same property ID for multiple properties.
      value:
        code: RULE_DUPLICATE_PROPERTY_ID
        message: The property ID '8e8b8450-dc1b-4360-8109-7067337b42cb' is duplicated for multiple properties

    rulePropertyIdMismatch:
      description: |
        The supplied property ID is not associated with the income source on record.
      value:
        code: RULE_PROPERTY_ID_MISMATCH
        message: The supplied property ID is not valid for this income source

    ruleDuplicatePropertyName:
      description: The foreign property name already exists for the same country.
      value:
        code: RULE_DUPLICATE_PROPERTY_NAME
        message: Foreign property name already exists for the same country

    ruleTaxYearBeforeBusinessStart:
      description: The requested tax year is before the first tax year in which the Foreign Property business was reported.
      value:
        code: RULE_TAX_YEAR_BEFORE_BUSINESS_START
        message: Foreign property cannot be reported for a tax year before the first tax year of the business

    ruleEndDateBeforeTaxYearStart:
      description: The end date is before the start of the tax year.
      value:
        code: RULE_END_DATE_BEFORE_TAX_YEAR_START
        message: The end date is before the start of the tax year

    ruleEndDateAfterTaxYearEnd:
      description: The end date is after the end of the tax year.
      value:
        code: RULE_END_DATE_AFTER_TAX_YEAR_END
        message: The end date is after the end of the tax year

    rulePropertyBusinessCeased:
      description: This foreign property business income source has ceased.
      value:
        code: RULE_PROPERTY_BUSINESS_CEASED
        message: Foreign property business income source has ceased

    ruleMissingEndDetails:
      description: A foreign property with an end date must have an end reason, and a foreign property with an end reason must have an end date.
      value:
        code: RULE_MISSING_END_DETAILS
        message: End date and end reason must be supplied together

    ruleAdvanceSubmissionRequiresPeriodEndDate:
      description: To submit in advance, submission end date must be the end of the period.
      value:
        code: RULE_ADVANCE_SUBMISSION_REQUIRES_PERIOD_END_DATE
        message: For advance submission, end date must be the end of the period

    ruleSubmissionEndDateCannotMoveBackwards:
      description: Submission end date cannot be earlier than existing submission.
      value:
        code: RULE_SUBMISSION_END_DATE_CANNOT_MOVE_BACKWARDS
        message: Submission end date cannot be earlier than existing submission

    ruleStartDateNotAlignedWithReportingType:
      description: |
        Start date does not align with the reporting type: must start at either the 6th or the 1st of the month.
      value:
        code: RULE_START_DATE_NOT_ALIGNED_WITH_REPORTING_TYPE
        message: Start date does not align with the reporting type

    ruleStartDateNotAlignedToCommencementDate:
      description: Start date does not align with the commencement date.
      value:
        code: RULE_START_DATE_NOT_ALIGNED_TO_COMMENCEMENT_DATE
        message: Start date does not align with the commencement date

    ruleEndDateNotAlignedWithReportingType:
      description: End date does not align wiih the reporting type.
      value:
         code: RULE_END_DATE_NOT_ALIGNED_WITH_REPORTING_TYPE
         message: End date does not align with the reporting type

    ruleMissingSubmissionDates:
      description: Submission start/end date not provided.
      value:
         code: RULE_MISSING_SUBMISSION_DATES
         message: Submission start/end date not provided

    ruleStartAndEndDateNotAllowed:
      description: Start/end date not accepted for annual/latent submission.
      value:
        code: RULE_START_AND_END_DATE_NOT_ALLOWED
        message: Start/end date not accepted for annual/latent submission

    ruleOutsideAmendmentWindow:
      description: Request cannot be completed as you are outside the amendment window.
      value:
        code: RULE_OUTSIDE_AMENDMENT_WINDOW
        message: You are outside the amendment window

    ruleEarlyDataSubmissionNotAccepted:
      description: Cannot submit data more than 10 days before end of period.
      value:
        code: RULE_EARLY_DATA_SUBMISSION_NOT_ACCEPTED
        message: Cannot submit data more than 10 days before end of period

    # 403

    clientOrAgentNotAuthorised:
      description: |
        The client and/or agent is not authorised. This is normally because: the client is not subscribed to MTD, the agent is not subscribed to Agent Services, or the client has not authorised the agent to act on their behalf.
      value:
        code: CLIENT_OR_AGENT_NOT_AUTHORISED
        message: The client and/or agent is not authorised



    # 404

    notFound:
      description: The supplied income source could not be found.
      value:
        code: MATCHING_RESOURCE_NOT_FOUND
        message: Matching resource not found