ofOpen Finance Guide
GlossaireSTETBlogContact
ISO20022object

TaxRecordDetails

ISO20022: Elements used to provide details on the tax period and amount. API: Amounts must always be set as positive values.

PropertyDescription
periodSet of elements used to provide details on the period of time related to the tax payment.
amountUnderlying tax amount related to the specified period.

Fields (2)

  • 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. The [type] property aims to identify the period related to the tax payment.

    • yearstring

      Year related to the tax payment.

      Constraints: pattern: `^[0-9]{4,4}$`

    • 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

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

    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}$`