ISO20022object

TaxInformation

ISO20022: Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account. API: Amounts must always be set as positive values. The [totalTaxableBaseAmount] property indicates the total amount of money on which the tax is based. The [totalTaxAmount] property indicates the total amount of money as result of the calculation of the tax.

Fields (11)

creditorTaxParty
Set of elements used to identify a party of the transaction to which the tax applies.
Schema: TaxParty
Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party.
- taxIdentificationstring
  Tax identification number of the party.
  Constraints: maxLength: 35
- registrationIdentificationstring
  Unique identification, as assigned by an organisation, to unambiguously identify a party.
  Constraints: maxLength: 35
- taxTypestring
  Type of tax payer.
  Constraints: maxLength: 35
- authorisationTitleAndName
  Title and Name of the party or the party's authorised reprensentative.
  Schema: TitleAndName
  Title and Name of the party or the party's authorised reprensentative.
  titlestring
  Title or position of the party or the party's authorised reprensentative.
  Constraints: maxLength: 35
  namestring
  Name of the party or the party's authorised reprensentative.
  Constraints: maxLength: 140
debtorTaxParty
Set of elements used to identify a party of the transaction to which the tax applies.
Schema: TaxParty
Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party.
- taxIdentificationstring
  Tax identification number of the party.
  Constraints: maxLength: 35
- registrationIdentificationstring
  Unique identification, as assigned by an organisation, to unambiguously identify a party.
  Constraints: maxLength: 35
- taxTypestring
  Type of tax payer.
  Constraints: maxLength: 35
- authorisationTitleAndName
  Title and Name of the party or the party's authorised reprensentative.
  Schema: TitleAndName
  Title and Name of the party or the party's authorised reprensentative.
  titlestring
  Title or position of the party or the party's authorised reprensentative.
  Constraints: maxLength: 35
  namestring
  Name of the party or the party's authorised reprensentative.
  Constraints: maxLength: 140
ultimateDebtorTaxParty
Set of elements used to identify a party of the transaction to which the tax applies.
Schema: TaxParty
Set of elements used to identify a party of the transaction to which the tax applies. The [authorization] property aims to provide the details of the authorised tax paying party.
- taxIdentificationstring
  Tax identification number of the party.
  Constraints: maxLength: 35
- registrationIdentificationstring
  Unique identification, as assigned by an organisation, to unambiguously identify a party.
  Constraints: maxLength: 35
- taxTypestring
  Type of tax payer.
  Constraints: maxLength: 35
- authorisationTitleAndName
  Title and Name of the party or the party's authorised reprensentative.
  Schema: TitleAndName
  Title and Name of the party or the party's authorised reprensentative.
  titlestring
  Title or position of the party or the party's authorised reprensentative.
  Constraints: maxLength: 35
  namestring
  Name of the party or the party's authorised reprensentative.
  Constraints: maxLength: 140
administrationZonestring
Territorial part of a country to which the tax payment is related.
Constraints: maxLength: 35
referenceNumberstring
Tax reference information that is specific to a taxing agency.
Constraints: maxLength: 140
methodstring
Method used to indicate the underlying business or how the tax is paid.
Constraints: maxLength: 35
totalTaxableBaseAmountAmountType
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}$`
totalTaxAmountAmountType
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}$`
datestring (date)ISO 8601
Date by which tax is due.
sequenceNumberinteger (int32)
Sequential number of the tax report.

recordarray<TaxRecord>

Records of tax details

Item: TaxRecord

Record of tax details the [period] property embbeds the set of elements used to provide details on the period of time related to the tax payment. the [amount] property embbeds the set of elements used to provide information on the amount of the tax record.

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. 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

Code	Description
`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

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

Schema: TaxAmount

ISO20022: Set of elements used to provide information on the amount of the tax record. API: Amounts must always be set as positive values.

Property	Description
rate	Rate used to calculate the tax.
taxableBaseAmount	Amount of money on which the tax is based.
totalAmount	Total amount that is the result of the calculation of the tax for the record.
details	Set of elements used to provide details on the tax period and amount.

ratePercentageRate
Rate expressed as a percentage, ie, in hundredths, eg, 0.7 is 7/10 of a percent, and 7.0 is 7%.
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
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}$`
totalAmountAmountType
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}$`

detailsarray<TaxRecordDetails>

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

Item: TaxRecordDetails

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

Property	Description
period	Set of elements used to provide details on the period of time related to the tax payment.
amount	Underlying tax amount related to the specified period.