ofOpen Finance Guide
GlossaireSTETBlogContact
ISO20022object

TaxRecord

Record of tax details

Fields (9)

  • typestring

    High level code to identify the type of tax details.

    Constraints: maxLength: 35

  • categorystring

    Specifies the tax code as published by the tax authority.

    Constraints: maxLength: 35

  • categoryDetailsstring

    Provides further details of the category tax code.

    Constraints: maxLength: 35

  • debtorStatusstring

    Code provided by local authority to identify the status of the party that has drawn up the settlement document.

    Constraints: maxLength: 35

  • certificateIdentificationstring

    Identification number of the tax report as assigned by the taxing authority.

    Constraints: maxLength: 35

  • formsCodestring

    Identifies, in a coded form, on which template the tax report is to be provided.

    Constraints: maxLength: 35

  • periodTaxPeriod

    Set of elements used to provide details on the period of time related to the tax payment.

    Schema: TaxPeriod

    Set of elements used to provide details on the period of time related to the tax payment.

    • yearstring (int32)

      Year related to the tax payment.

    • typeTaxRecordPeriodCode

      Identification of the period related to the tax payment.

      Schema: TaxRecordPeriodCode

      CodeDescription
      MM01
      		FirstMonth Tax is related to the second month of the period.
      MM02
      		SecondMonth Tax is related to the first month of the period.
      MM03
      		ThirdMonth Tax is related to the third month of the period.
      MM04
      		FourthMonth Tax is related to the fourth month of the period.
      MM05
      		FifthMonth Tax is related to the fifth month of the period.
      MM06
      		SixthMonth Tax is related to the sixth month of the period.
      MM07
      		SeventhMonth Tax is related to the seventh month of the period.
      MM08
      		EighthMonth Tax is related to the eighth month of the period.
      MM09
      		NinthMonth Tax is related to the ninth month of the period.
      MM10
      		TenthMonth Tax is related to the tenth month of the period.
      MM11
      		EleventhMonth Tax is related to the eleventh month of the period.
      MM12
      		TwelfthMonth Tax is related to the twelfth month of the period.
      QTR1
      		FirstQuarter Tax is related to the first quarter of the period.
      QTR2
      		SecondQuarter Tax is related to the second quarter of the period.
      QTR3
      		ThirdQuarter Tax is related to the third quarter of the period.
      QTR4
      		FourthQuarter Tax is related to the fourth quarter of the period.
      HLF1
      		FirstHalf Tax is related to the first half of the period.
      HLF2
      		SecondHalf Tax is related to the second half of the period.
    • fromDatestring (date)ISO 8601

      Start date of the range.

    • toDatestring (date)ISO 8601

      End date of the range.

  • taxAmountTaxAmount

    Set of elements used to provide information on the amount of the tax record.

    Schema: TaxAmount

    Set of elements used to provide information on the amount of the tax record.

    • ratePercentageRate

      Rate used to calculate the tax.

      Schema: PercentageRate

      Rate expressed as a percentage, ie, in hundredths, eg, 0.7 is 7/10 of a percent, and 7.0 is 7%.

      Type: number (float)

    • taxableBaseAmountAmountType

      Amount of money on which the tax is based.

      Schema: AmountType

      Structure aiming to embed the amount and the currency to be used.

      • amountnumber (float)required

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

      • currencyCurrencyCodeISO 4217required

        Specifies the currency of the amount or of the account.

        Schema: CurrencyCode

        Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

        Type: string

        Constraints: pattern: `^[A-Z]{3,3}$`

    • totalAmountAmountType

      Total amount that is the result of the calculation of the tax for the record.

      Schema: AmountType

      Structure aiming to embed the amount and the currency to be used.

      • amountnumber (float)required

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

      • currencyCurrencyCodeISO 4217required

        Specifies the currency of the amount or of the account.

        Schema: CurrencyCode

        Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

        Type: string

        Constraints: pattern: `^[A-Z]{3,3}$`

    • detailsarray<TaxRecordDetails>

      Set of elements used to provide details on the tax period and amount.

      Item: TaxRecordDetails

      Elements used to provide details on the tax period and amount.

      • periodTaxPeriod

        Set of elements used to provide details on the period of time related to the tax payment.

        Schema: TaxPeriod

        Set of elements used to provide details on the period of time related to the tax payment.

        • yearstring (int32)

          Year related to the tax payment.

        • typeTaxRecordPeriodCode

          Identification of the period related to the tax payment.

          Schema: TaxRecordPeriodCode

          CodeDescription
          MM01
          		FirstMonth Tax is related to the second month of the period.
          MM02
          		SecondMonth Tax is related to the first month of the period.
          MM03
          		ThirdMonth Tax is related to the third month of the period.
          MM04
          		FourthMonth Tax is related to the fourth month of the period.
          MM05
          		FifthMonth Tax is related to the fifth month of the period.
          MM06
          		SixthMonth Tax is related to the sixth month of the period.
          MM07
          		SeventhMonth Tax is related to the seventh month of the period.
          MM08
          		EighthMonth Tax is related to the eighth month of the period.
          MM09
          		NinthMonth Tax is related to the ninth month of the period.
          MM10
          		TenthMonth Tax is related to the tenth month of the period.
          MM11
          		EleventhMonth Tax is related to the eleventh month of the period.
          MM12
          		TwelfthMonth Tax is related to the twelfth month of the period.
          QTR1
          		FirstQuarter Tax is related to the first quarter of the period.
          QTR2
          		SecondQuarter Tax is related to the second quarter of the period.
          QTR3
          		ThirdQuarter Tax is related to the third quarter of the period.
          QTR4
          		FourthQuarter Tax is related to the fourth quarter of the period.
          HLF1
          		FirstHalf Tax is related to the first half of the period.
          HLF2
          		SecondHalf Tax is related to the second half of the period.
        • fromDatestring (date)ISO 8601

          Start date of the range.

        • toDatestring (date)ISO 8601

          End date of the range.

      • amountAmountTyperequired

        Underlying tax amount related to the specified period.

        Schema: AmountType

        Structure aiming to embed the amount and the currency to be used.

        • amountnumber (float)required

          ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

          ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

          Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

        • currencyCurrencyCodeISO 4217required

          Specifies the currency of the amount or of the account.

          Schema: CurrencyCode

          Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

          Type: string

          Constraints: pattern: `^[A-Z]{3,3}$`

  • additionalInformationstring

    Further details of the tax record.

    Constraints: maxLength: 140