Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system.
- Is optional
- Type:
object
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
| Strd | Object | Optional | Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form. |
Ustrd | String | Required | Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. This is additional remittance information that the debtor wants to provide the creditor. Usage Guidelines:
|
| Property | Type | Required | Description |
|---|---|---|---|
| RfrdDocInf | Object | Optional | Provides the identification and the content of the referred document. |
| RfrdDocAmt | Object | Optional | Provides details on the amounts of the referred document. |
| CdtrRefInf | Object | Optional | Reference information provided by the creditor to allow the identification of the underlying documents. |
| Invcr | Object | Optional | Identification of the organization issuing the invoice, when it is different from the creditor or ultimate creditor. |
| Invcee | Object | Optional | Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor. |
| TaxRmt | Object | Optional | Provides the identification and the content of the referred document. |
| GrnshmtRmt | Object | Optional | Provides the identification and the content of the referred document. |
AddtlRmtInf | Array | Optional | Additional information, in the form of an array of strings, to complement the structured remittance information. Maximum of 4 lines to ensure consistency with the ISO20022 specification. |
Provides the identification and the content of the referred document.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
Tp | Object | Optional | Specifies the type of referred document. |
Tp.CdOrPrtry | Object | Optional | Provides the type details of the referred document. |
Tp.CdOrPrtry.Cd | String | Optional | Document type in a coded form. As defined in ISO list DocumentType6Code. The value of this property must be equal to one of the known values. |
Tp.CdOrPrtry.Prtry | String | Optional | Field to support proprietary value. |
Tp.Issr | String | Optional | Identification of the issuer of the Reference document type. Maximum length 35 characters |
Nb | String | Optional | Unique and unambiguous identification of the referred document. Maximum length: 35 characters |
RltdDt | String | Optional | Date associated with the referred document. Format: date-time |
LineDtls | Array | Optional | Quantity of cash resulting from the calculation of the tax. |
| Value | Description |
|---|---|
MSIN | Metered Service Invoice |
CNFA | Credit Note Related To Financial Adjustment |
DNFA | Debit Note Related To Financial Adjustment |
CINV | Commercial Invoice |
CREN | Credit Note |
DEBN | Debit Note |
HIRI | Hire Invoice |
SBIN | Self Billed Invoice |
CMCN | Commercial Contract |
SOAC | Statement Of Account |
DISP | Dispatch Advice |
BOLD | Bill Of Lading |
VCHR | Voucher |
AROI | Account Receivable Open Item |
TSUT | Trade Services Utility Transaction |
PUOR | Purchase Order |
Set of elements used to provide the content of the referred document line.
With the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
Id | Object | Optional | Provides identification of the document line. |
Id.Tp | Object | Optional | Specifies the type of referred document line identification. |
Id.Tp.CdOrPrtry | Object | Optional | Provides the type details of the referred document line identification. |
Id.Tp.CdOrPrtry.Cd | String | Optional | Line identification type in a coded form. Uses ISO list ExternalDocumentLineType1Code. The value of this property must be equal to one of the known values below. |
Id.Tp.CdOrPrtry.Prtry | String | Optional | Field to support proprietary value. Maximum length 35 characters |
Id.Tp.Issr | String | Optional | Identification of the issuer of the Reference document line identification type. |
Id.Nb | String | Optional | Identification of the type specified for the referred document line. Maximum length: 35 characters |
Id.RltdDt | String | Optional | Date associated with the referred document line. Format: Date-time |
Desc | String | Optional | Description associated with the document line. Maximum length: 2048 characters |
Amt | Object | Optional | Provides details on the amounts of the document line. |
The Amt object has the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
DuePyblAmt | Object | Optional | Amount specified is the exact amount due and payable to the creditor. |
DuePyblAmt.amount | string | optional | Amount. Maximum length: 19 characters |
DuePyblAmt.currency | string | optional | Currency for the amount, defined in #/definitions/currency |
DscntApldAmt | Object | Optional | Amount specified for the referred document is the amount of discount to be applied to the amount due and payable to the creditor. |
DscntApldAmt.Tp | String | Optional | Specifies the type of the amount. |
DscntApldAmt.Tp.Cd | String | Optional | Specifies the amount type, in a coded form. Based on ISO ExternalDiscountAmountType1Code, the value of this property must be equal to one of the known values. |
DscntApldAmt.Tp.Prtry | String | Optional | Field to support proprietary value. Maximum length 35 characters |
DscntApldAmt.Amt | String | Optional | Amount of money, which has been typed. |
| CdtNoteAmt | Object | Optional | Amount specified for the referred document is the amount of a credit note. |
| TaxAmt | Object | Optional | Quantity of cash resulting from the calculation of the tax. |
| AdjstmntAmtAndRsn | Object | Optional | Specifies detailed information on the amount and reason of the document adjustment. |
| RmtdAmt | Object | Optional | Amount of money remitted for the referred document. |
| Value | Description |
|---|---|
ADPI | Additional Product Identification Assigned by the Manufacturer. Line item Reference is an additional product identification assigned by the manufacturer. |
AISB | Alternate ISBN. Line item Reference is an alternate International Standard Book Number (ISBN). |
ASNB | Asset Number. Line item Reference is an asset number. |
CTNB | Catalog Number. Line item Reference is a catalog number. |
DBSP | Dun & Bradstreet Standard Product and Service Code. Line item Reference is Dun & Bradstreet Standard Product and Service code. |
EANN | European Article Number (EAN) (2-5-5-1). Line item Reference is an European Article Number (EAN). |
EINB | Equipment Identification Number. Line item Reference is an equipment identification number. |
GSNB | General Specification Number. Line item Reference is a general specification number. |
HIBC | HIBC (Health Care Industry Bar Code). Line item Reference is a Health Care Industry Bar Code (HIBC) |
ISBN | International Standard Book Number (ISBN). Line item Reference is an International Standard Book Number (ISBN). |
LTNB | Lot Number. Line item Reference is a lot number. |
MDNB | Model Number. Line item Reference is a model number. |
PRNB | Part Number. Line item Reference is a part Reference number. |
PTCD | Product Type Code. Line item Reference is a product type code. |
SKNB | Stock Number. Line item Reference is a stock number. |
STNB | Style Number. Line item Reference is a style number. |
TONB | Technical Order Number. Line item Reference is a technical order number. |
UPCC | UPC Consumer Package Code. Line item Reference is an UPC consumer package code. |
UPNB | Universal Product Number. Line item Reference is an Universal Product Number. |
| Value | Description |
|---|---|
APDS | Additional Promotional Discount |
STDS | Standing Discount |
TMDS | Terms Discount |
Click to expand
{
"type": "object",
"description": "Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form.",
"properties": {
"RfrdDocInf": {
"type": "object",
"description": "Provides the identification and the content of the referred document.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of referred document.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Provides the type details of the referred document.",
"properties": {
"Cd": {
"type": "string",
"description": "Document type in a coded form. As defined in ISO list DocumentType6Code ",
"enum": [
"MSIN",
"CNFA",
"DNFA",
"CINV",
"CREN",
"DEBN",
"HIRI",
"SBIN",
"CMCN",
"SOAC",
"DISP",
"BOLD",
"VCHR",
"AROI",
"TSUT",
"PUOR"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary values",
"maxLength": 35
}
},
"Issr": {
"type": "string",
"description": "Identification of the issuer of the Reference document type.",
"maxLength": 35
}
}
}
},
"Nb": {
"type": "string",
"description": "Unique and unambiguous identification of the referred document.",
"maxLength": 35
},
"RltdDt": {
"type": "string",
"description": "Date associated with the referred document.",
"format": "date-time"
},
"LineDtls": {
"type": "array",
"description": "Set of elements used to provide the content of the referred document line.",
"items": [
{
"Id": {
"type": "object",
"description": "Provides identification of the document line.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of referred document line identification.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Provides the type details of the referred document line identification.",
"properties": {
"Cd": {
"type": "string",
"description": "Line identification type in a coded form. Uses ISO list ExternalDocumentLineType1Code",
"enum": [
"CINV",
"CNFA",
"CONT",
"CREN",
"DEBN",
"DISP",
"DNFA",
"HIRI",
"INVS",
"MSIN",
"PROF",
"PUOR",
"QUOT",
"SBIN",
"SPRR",
"TISH",
"USAR"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
},
"Issr": {
"type": "string",
"description": "Identification of the issuer of the Reference document line identification type.",
"maxLength": 35
}
}
},
"Nb": {
"type": "string",
"description": "Identification of the type specified for the referred document line.",
"maxLength": 35
},
"RltdDt": {
"type": "string",
"description": "Date associated with the referred document line.",
"format": "date-time"
}
}
},
"Desc": {
"type": "string",
"description": "Description associated with the document line.",
"maxLength": 2048
},
"Amt": {
"type": "object",
"description": "Provides details on the amounts of the document line.",
"properties": {
"DuePyblAmt": {
"type": "object",
"description": "Amount specified is the exact amount due and payable to the creditor.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"DscntApldAmt": {
"type": "object",
"description": "Amount of discount to be applied to the amount due and payable to the creditor.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount.",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on ISO list ExternalDiscountAmountType1Code",
"enum": [
"APDS",
"STDS",
"TMDS"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
}
},
"CdtNoteAmt": {
"type": "object",
"description": "Amount of a credit note.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"TaxAmt": {
"type": "object",
"description": "Amount of the tax.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount.",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on ISO ExternalTaxAmountType1Code list",
"enum": [
"CITY",
"CNTY",
"LOCL",
"PROV",
"STAT"
]
},
"Prtry": {
"type": "string",
"description": "Specifies the amount type, in a free-text form.",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"AdjstmntAmtAndRsn": {
"type": "object",
"description": "Specifies detailed information on the amount and reason of the adjustment.",
"properties": {
"Amt": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"CdtDbtInd": {
"type": "string",
"description": "Specifies whether the adjustment must be subtracted or added to the total amount.",
"enum": [
"CRDT",
"DBIT"
]
},
"Rsn": {
"type": "string",
"description": "Specifies the reason for the adjustment.",
"maxLength": 4
},
"AddtlInf": {
"type": "string",
"description": "Provides further details on the document adjustment.",
"maxLength": 140
}
}
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
}
}
]
}
}
},
"RfrdDocAmt": {
"type": "object",
"description": "Provides details on the amounts of the referred document.",
"properties": {
"DuePyblAmt": {
"type": "object",
"description": "Amount specified is the exact amount due and payable to the creditor.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"DscntApldAmt": {
"type": "object",
"description": "Amount specified for the referred document is the amount of discount to be applied to the amount due and payable to the creditor.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount.",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on ISO ExternalDiscountAmountType1Code",
"enum": [
"APDS",
"STDS",
"TMDS"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"CdtNoteAmt": {
"type": "object",
"description": "t specified for the referred document is the amount of a credit note.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"TaxAmt": {
"type": "object",
"description": "Quantity of cash resulting from the calculation of the tax.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount. Based on the ISO ExternalTaxAmountType1Code list",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on the ISO ExternalTaxAmountType1Code list",
"enum": [
"CITY",
"CNTY",
"LOCL",
"PROV",
"STAT"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"AdjstmntAmtAndRsn": {
"type": "object",
"description": "Specifies detailed information on the amount and reason of the document adjustment.",
"properties": {
"Amt": {
"type": "object",
"description": "Amount of money of the document adjustment.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"CdtDbtInd": {
"type": "string",
"description": "Specifies whether the adjustment must be substracted or added to the total amount.",
"enum": [
"CRDT",
"DBIT"
]
},
"Rsn": {
"type": "string",
"description": "Specifies the reason for the adjustment.",
"maxLength": 4
},
"AddtlInf": {
"type": "string",
"description": "Provides further details on the document adjustment.",
"maxLength": 140
}
}
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted for the referred document.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"CdtrRefInf": {
"type": "object",
"description": "Reference information provided by the creditor to allow the identification of the underlying documents.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of creditor reference.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Coded or proprietary format creditor Reference type.",
"properties": {
"Cd": {
"type": "string",
"description": "Type of creditor reference, in a coded form. Based on ISO DocumentType3Code list",
"enum": [
"RADM",
"RPIN",
"FXDR",
"DISP",
"PUOR",
"SCOR"
]
},
"Prtry": {
"type": "string",
"description": "Creditor Reference type, in a proprietary form.",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Entity that assigns the credit Reference type.",
"maxLength": 35
}
}
},
"Ref": {
"type": "string",
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.",
"maxLength": 35
}
}
},
"Invcr": {
"type": "object",
"description": "Identification of the organization issuing the invoice, when it is different from the creditor or ultimate creditor.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"$ref": "#/definitions/country"
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Id": {
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"$ref": "#/definitions/contact_details"
}
}
},
"Invcee": {
"type": "object",
"description": "Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"$ref": "#/definitions/country"
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Id": {
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"$ref": "#/definitions/contact_details"
}
}
},
"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
}
}
}
}
}
}
},
"GrnshmtRmt": {
"type": "object",
"description": "Provides remittance information about a payment for garnishment-related purposes.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of garnishment.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Provides the type details of the garnishment.",
"properties": {
"Cd": {
"type": "string",
"description": "Garnishment type in a coded form. Based on ISO ExternalGarnishmentType1Code list",
"enum": [
"GNCS",
"GNDP",
"GTPP"
]
},
"Prtry": {
"type": "string",
"description": "Proprietary identification of the type of garnishment.",
"maxLength": 35
}
}
}
},
"Issr": {
"type": "string",
"description": "Identification of the issuer of the garnishment type.",
"maxLength": 35
}
},
"Grnshee": {
"type": "object",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the garnisher.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"$ref": "#/definitions/country"
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Id": {
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"$ref": "#/definitions/contact_details"
}
}
},
"GrnshmyAdmstr": {
"type": "object",
"description": "Party on the credit side of the transaction who administers the garnishment on behalf of the ultimate beneficiary.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"$ref": "#/definitions/country"
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Id": {
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"$ref": "#/definitions/contact_details"
}
}
},
"RefNb": {
"type": "string",
"description": "Reference information that is specific to the agency receiving the garnishment.",
"maxLength": 140
},
"Dt": {
"type": "string",
"description": "Date of payment which garnishment was taken from.",
"format": "date-time"
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted for the referred document.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"FmlyMdcllnsrncInd": {
"type": "boolean",
"description": "Indicates if the person to whom the garnishment applies (that is, the ultimate debtor) has family medical insurance coverage available."
},
"MplyeeTermntnInd": {
"type": "boolean",
"description": "Indicates if the employment of the person to whom the garnishment applies (that is, the ultimate debtor) has been terminated."
}
}
},
"AddtlRmtInf": {
"type": "array",
"description": "Additional information, in the form of an array of strings, to complement the structured remittance information. Maximum of 4 lines to ensure consistency with the ISO20022 specification."
}
}
}