TaxRmt
Provides remittance information about a payment made for tax-related purposes.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
| Cdtr | Object | Optional | Party on the credit side of the transaction to which the tax applies. |
| Dbtr | Object | Optional | Identifies the party on the debit side of the transaction to which the tax applies. |
| UltmtDbtr | Object | Optional | Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority |
AdmstnZone |
String | Optional | Territorial part of a country to which the tax payment is related. Maximum length: 35 characters |
RefNb |
String | Optional | Tax Reference information that is specific to a taxing agency. Maximum length: 140 characters |
Mtd |
String | Optional | Method used to indicate the underlying business or how the tax is paid. Maximum length: 35 characters |
| TtlTaxblBaseAmt | Object | Optional | Total amount of money on which the tax is based. |
| TtlTaxAmt | Object | Optional | Total amount of money as result of the calculation of the tax. |
Dt |
String | Optional | Date by which tax is due. Format: date-time. |
SeqNb |
integer | Optional | Sequential number of the tax report. |
| Rcrd | Object | Optional | Record of tax details. |
Cdtr
Party on the credit side of the transaction to which the tax applies.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
TaxId |
string | optional | Tax identification number of the creditor. Maximum length: 35 characters |
RegnId |
string | optional | Unique identification, as assigned by an organization, to unambiguously identify a party. Maximum length: 35 characters |
TaxTp |
string | optional | Type of tax payer. Maximum length: 35 characters |
Dbtr
Identifies the party on the debit side of the transaction to which the tax applies.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
TaxId |
string | optional | Tax identification number of the creditor. Maximum length: 35 characters |
RegnId |
string | optional | Unique identification, as assigned by an organization, to unambiguously identify a party. Maximum length: 35 characters |
TaxTp |
string | optional | Type of tax payer. Maximum length: 35 characters |
| Authstn | object | optional | Details of the authorised tax paying party. |
Dbtr.Authstn
Details of the authorised tax paying party.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
Titl |
string | optional | Title or position of debtor or the debtor's authorised representative.. Maximum length: 35 characters |
Nm |
string | optional | Name of the debtor or the debtor's authorised representative. Maximum length: 140 characters |
UltmtDbtr
Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
TaxId |
string | optional | Tax identification number of the creditor. Maximum length: 35 characters |
RegnId |
string | optional | Unique identification, as assigned by an organization, to unambiguously identify a party. Maximum length: 35 characters |
TaxTp |
string | optional | Type of tax payer. Maximum length: 35 characters |
| Authstn | object | optional | Details of the authorised tax paying party. |
UltmtDbtr.Authstn
Details of the authorised tax paying party.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
Titl |
string | optional | Title or position of debtor or the debtor's authorised representative. Maximum length: 35 characters |
Nm |
string | optional | Name of the debtor or the debtor's authorised representative. Maximum length: 140 characters |
TtlTaxblBaseAmt
Total amount of money on which the tax is based.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
amount |
string | optional | Amount. Maximum length: 19 characters |
currency |
string | optional | Currency for the amount, defined in #/definitions/currency |
TtlTaxAmt
Total amount of money as result of the calculation of the tax.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
amount |
string | optional | Amount. Maximum length: 19 characters |
currency |
string | optional | Currency for the amount, defined in #/definitions/currency |
Rcrd
Record of tax details.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
Tp |
string | optional | High level code to identify the type of tax details. Maximum length: 35 characters |
Ctgy |
string | optional | Specifies the tax code as published by the tax authority. Maximum length: 35 characters |
CtgyDtls |
string | optional | Provides further details of the category tax code. Maximum length: 35 characters |
DbtrSts |
string | optional | Code provided by local authority to identify the status of the party that has drawn up the settlement document. Maximum length: 35 characters |
CertId |
string | optional | Identification number of the tax report as assigned by the taxing authority. Maximum length: 35 characters |
FrmsCd |
string | optional | Identifies, in a coded form, on which template the tax report is to be provided. Maximum length: 35 characters |
| Prd | object | optional | Set of elements used to provide details on the period of time related to the tax payment. |
| TaxAmt | object | optional | Set of elements used to provide information on the amount of the tax record. |
Rcrd.Prd
Set of elements used to provide details on the period of time related to the tax payment.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
Yr |
string | optional | Year related to the tax payment. Format: date-time |
Tp |
string | optional | Identification of the period related to the tax payment. Based on ISO TaxRecordPeriod1Code, the value of this property must be equal to one of the known values below. |
| FrToDt | object | optional | Range of time between a start date and an end date for which the tax report is provided. |
Prd.Tp known values
| Value | Description |
|---|---|
MM01 |
First Month |
MM02 |
Second Month |
MM03 |
Third Month |
MM04 |
Fourth Month |
MM05 |
Fifth Month |
MM06 |
Sixth Month |
MM07 |
Seventh Month |
MM08 |
Eighth Month |
MM09 |
Ninth Month |
MM10 |
Tenth Month |
MM11 |
Eleventh Month |
MM12 |
Twelfth Month |
QTR1 |
First Quarter |
QTR2 |
Second Quarter |
QTR3 |
Third Quarter |
QTR4 |
Fourth Quarter |
HLF1 |
First Half |
HLF2 |
Second Half |
Rcrd.Prd.FrToDt
Range of time between a start date and an end date for which the tax report is provided.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
FrDt |
string | optional | Start date of the range. Format: date-time |
ToDt |
string | optional | End date of the range. Format: date-time |
TaxAmt
Set of elements used to provide information on the amount of the tax record.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
Rate |
number | optional | Rate used to calculate the tax. Percentage, minimum 0, maximum 100 |
| TtlTaxblBaseAmt | object | optional | Amount of money on which the tax is based. |
| TtlAmt | object | optional | Total amount that is the result of the calculation of the tax for the record. |
Dtls |
object | optional | Set of elements used to provide details on the tax period and amount. |
AddtlInf |
string | optional | Further details of the tax record. Max length 140 characters |
TaxAmt.TtlTaxblBaseAmt
Amount of money on which the tax is based.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
amount |
string | optional | Amount. Maximum length: 19 characters |
currency |
string | optional | Currency for the amount, defined in #/definitions/currency |
TtlAmt
Total amount that is the result of the calculation of the tax for the record.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
amount |
string | optional | Amount. Maximum length: 19 characters |
currency |
string | optional | Currency for the amount, defined in #/definitions/currency |
Dtls
Set of elements used to provide details on the tax period and amount.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
| Prd | object | optional | Set of elements used to provide details on the period of time related to the tax payment. |
| Amt | sobject | optional | Underlying tax amount related to the specified period. |
Dtls.Prd
Set of elements used to provide details on the period of time related to the tax payment.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
Yr |
string | optional | Year related to the tax payment. Format: date-time |
Tp |
string | optional | Identification of the period related to the tax payment. Based on ISO TaxRecordPeriod1Code, the value of this property must be equal to one of the known values below. |
| FrToDt | object | optional | Range of time between a start date and an end date for which the tax report is provided. |
Dtls.Prd.Tp Known Values
| Value | Description |
|---|---|
MM01 |
First Month |
MM02 |
Second Month |
MM03 |
Third Month |
MM04 |
Fourth Month |
MM05 |
Fifth Month |
MM06 |
Sixth Month |
MM07 |
Seventh Month |
MM08 |
Eighth Month |
MM09 |
Ninth Month |
MM10 |
Tenth Month |
MM11 |
Eleventh Month |
MM12 |
Twelfth Month |
QTR1 |
First Quarter |
QTR2 |
Second Quarter |
QTR3 |
Third Quarter |
QTR4 |
Fourth Quarter |
HLF1 |
First Half |
HLF2 |
Second Half |
Dtls.Prd.FrToDt
Range of time between a start date and an end date for which the tax report is provided.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
FrDt |
string | optional | Start date of the range. Format: date-time |
ToDt |
string | optional | End date of the range. Format: date-time |
Dtls.Amt
Underlying tax amount related to the specified period.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
amount |
string | optional | Amount. Maximum length: 19 characters |
currency |
string | optional | Currency for the amount, defined in #/definitions/currency |
JSON schema extract
Click to expand
"TaxRmt": {
"type": "object",
"description": "Provides remittance information about a payment made for tax-related purposes.",
"properties": {
"Cdtr": {
"type": "object",
"description": "Party on the credit side of the transaction to which the tax applies.",
"properties": {
"TaxId": {
"type": "string",
"description": "Tax identification number of the creditor.",
"maxLength": 35
},
"RegnId": {
"type": "string",
"description": "Unique identification, as assigned by an organization, to unambiguously identify a party.",
"maxLength": 35
},
"TaxTp": {
"type": "string",
"description": "Type of tax payer.",
"maxLength": 35
}
}
},
"Dbtr": {
"type": "object",
"description": "Identifies the party on the debit side of the transaction to which the tax applies.",
"properties": {
"TaxId": {
"type": "string",
"description": "Tax identification number of the debtor.",
"maxLength": 35
},
"RegnId": {
"type": "string",
"description": "Unique identification, as assigned by an organization, to unambiguously identify a party.",
"maxLength": 35
},
"TaxTp": {
"type": "string",
"description": "Type of tax payer.",
"maxLength": 35
},
"Authstn": {
"type": "object",
"description": "Details of the authorised tax paying party.",
"properties": {
"Titl": {
"type": "string",
"description": "Title or position of debtor or the debtor's authorised representative.",
"maxLength": 35
},
"Nm": {
"type": "string",
"description": "Name of the debtor or the debtor's authorised representative.",
"maxLength": 140
}
}
}
}
},
"UltmtDbtr": {
"type": "object",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.",
"properties": {
"TaxId": {
"type": "string",
"description": "Tax identification number of the debtor.",
"maxLength": 35
},
"RegnId": {
"type": "string",
"description": "Unique identification, as assigned by an organization, to unambiguously identify a party.",
"maxLength": 35
},
"TaxTp": {
"type": "string",
"description": "Type of tax payer.",
"maxLength": 35
},
"Authstn": {
"type": "object",
"description": "Details of the authorised tax paying party.",
"properties": {
"Titl": {
"type": "string",
"description": "Title or position of debtor or the debtor's authorised representative.",
"maxLength": 35
},
"Nm": {
"type": "string",
"description": "Name of the debtor or the debtor's authorised representative.",
"maxLength": 140
}
}
}
}
},
"AdmstnZone": {
"type": "string",
"description": "Territorial part of a country to which the tax payment is related.",
"maxLength": 35
},
"RefNb": {
"type": "string",
"description": "Tax Reference information that is specific to a taxing agency.",
"maxLength": 140
},
"Mtd": {
"type": "string",
"description": "Method used to indicate the underlying business or how the tax is paid.",
"maxLength": 35
},
"TtlTaxblBaseAmt": {
"type": "object",
"description": "Total amount of money on which the tax is based.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"TtlTaxAmt": {
"type": "object",
"description": "Total amount of money as result of the calculation of the tax.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"Dt": {
"type": "string",
"description": "Date by which tax is due.",
"format": "date-time"
},
"SeqNb": {
"type": "integer",
"description": "Sequential number of the tax report."
},
"Rcrd": {
"type": "object",
"description": "Record of tax details.",
"properties": {
"Tp": {
"type": "string",
"description": "High level code to identify the type of tax details.",
"maxLength": 35
},
"Ctgy": {
"type": "string",
"description": "Specifies the tax code as published by the tax authority.",
"maxLength": 35
},
"CtgyDtls": {
"type": "string",
"description": "Provides further details of the category tax code.",
"maxLength": 35
},
"DbtrSts": {
"type": "string",
"description": "Code provided by local authority to identify the status of the party that has drawn up the settlement document.",
"maxLength": 35
},
"CertId": {
"type": "string",
"description": "Identification number of the tax report as assigned by the taxing authority.",
"maxLength": 35
},
"FrmsCd": {
"type": "string",
"description": "Identifies, in a coded form, on which template the tax report is to be provided.",
"maxLength": 35
},
"Prd": {
"type": "object",
"description": "Set of elements used to provide details on the period of time related to the tax payment.",
"properties": {
"Yr": {
"type": "string",
"description": "Year related to the tax payment.",
"format": "date-time"
},
"Tp": {
"type": "string",
"description": "Identification of the period related to the tax payment. Based on ISO TaxRecordPeriod1Code",
"enum": [
"MM01",
"MM02",
"MM03",
"MM04",
"MM05",
"MM06",
"MM07",
"MM08",
"MM09",
"MM10",
"MM11",
"MM12",
"QTR1",
"QTR2",
"QTR3",
"QTR4",
"HLF1",
"HLF2"
]
},
"FrToDt": {
"type": "object",
"description": "Range of time between a start date and an end date for which the tax report is provided.",
"properties": {
"FrDt": {
"type": "string",
"description": "Start date of the range.",
"format": "date-time"
},
"ToDt": {
"type": "string",
"description": "End date of the range.",
"format": "date-time"
}
}
}
}
},
"TaxAmt": {
"type": "object",
"description": "Set of elements used to provide information on the amount of the tax record.",
"properties": {
"Rate": {
"type": "number",
"description": "Rate used to calculate the tax. ",
"minimum": 0,
"maximum": 100,
"multiplpeOf": 1e-10
},
"TtlTaxblBaseAmt": {
"type": "object",
"description": "Amount of money on which the tax is based.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"TtlAmt": {
"type": "object",
"description": "Total amount that is the result of the calculation of the tax for the record.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"Dtls": {
"type": "object",
"description": "Set of elements used to provide details on the tax period and amount.",
"properties": {
"Prd": {
"type": "object",
"description": "Set of elements used to provide details on the period of time related to the tax payment.",
"properties": {
"Yr": {
"type": "string",
"description": "Year related to the tax payment.",
"format": "date-time"
},
"Tp": {
"type": "string",
"description": "Identification of the period related to the tax payment. Based on ISO TaxRecordPeriod1Code",
"enum": [
"MM01",
"MM02",
"MM03",
"MM04",
"MM05",
"MM06",
"MM07",
"MM08",
"MM09",
"MM10",
"MM11",
"MM12",
"QTR1",
"QTR2",
"QTR3",
"QTR4",
"HLF1",
"HLF2"
]
},
"FrToDt": {
"type": "object",
"description": "Range of time between a start date and an end date for which the tax report is provided.",
"properties": {
"FrDt": {
"type": "string",
"description": "Start date of the range.",
"format": "date-time"
},
"ToDt": {
"type": "string",
"description": "End date of the range.",
"format": "date-time"
}
}
}
}
},
"Amt": {
"type": "object",
"description": "Underlying tax amount related to the specified period.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"AddtlInf": {
"type": "string",
"description": "Further details of the tax record.",
"maxLength": 140
}
}
}
}
}
}
}