{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-document-req-schema.json",
"title": "DocumentReq",
"description": "Payment initiation request body.",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/citi-pacs-00800108-api-openapi.yml#/components/schemas/DocumentReq",
"required": [
"FIToFICstmrCdtTrf"
],
"properties": {
"FIToFICstmrCdtTrf": {
"$ref": "#/$defs/FIToFICustomerCreditTransferV08"
}
},
"$defs": {
"AccountIdentification4Choice": {
"type": "object",
"properties": {
"IBAN": {
"$ref": "#/$defs/IBAN2007Identifier"
},
"Othr": {
"$ref": "#/$defs/GenericAccountIdentification1"
}
},
"description": "Unique identification for the account between the account owner and the account servicer. Either the`iban` or the `Othr` parameter should be passed in the request ."
},
"ActiveCurrencyAndAmount": {
"type": "object",
"properties": {
"Ccy": {
"type": "object",
"description": "Currency code. Passed as the tag attribute.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
}
]
},
"Value": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount_SimpleType"
}
}
},
"ActiveOrHistoricCurrencyAndAmount": {
"type": "object",
"properties": {
"Ccy": {
"type": "object",
"description": "Currency code. Passed as the tag attribute.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
}
]
},
"Value": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount_SimpleType"
}
}
},
"ActiveOrHistoricCurrencyAndAmount_SimpleType": {
"maxLength": 18,
"type": "string",
"description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217. The number of fractional digits in the amount should not be more than 5."
},
"ActiveOrHistoricCurrencyCode": {
"pattern": "[A-Z]{3,3}",
"type": "string"
},
"AddressType3Choice": {
"type": "object",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the type of address.
ADDR: Address is the complete postal address.
PBOX: Address is a postal office (PO) box.
HOME: Address is the home address.
BIZZ: Address is the business address.
MLTO: Address is the address to which mail is sent.
DLVY: Address is the address to which delivery is to take place.",
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
]
},
"Prtry": {
"$ref": "#/$defs/GenericIdentification30"
}
},
"description": "Identifies the nature of the postal address. Either Code or Proprietary parameter should be passed in the request ."
},
"BaseOneRate": {
"maxLength": 11,
"type": "string",
"description": "Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. The number of fractional digits in the rate should not be more than 10."
},
"BranchAndFinancialInstitutionIdentification6": {
"required": [
"FinInstnId"
],
"type": "object",
"properties": {
"BrnchId": {
"$ref": "#/$defs/BranchData3"
},
"FinInstnId": {
"$ref": "#/$defs/FinancialInstitutionIdentification18"
}
}
},
"BranchData3": {
"type": "object",
"properties": {
"Id": {
"type": "object",
"description": "Unique identification of a branch of a financial institution.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"LEI": {
"pattern": "[A-Z0-9]{18,18}[0-9]{2,2}",
"type": "string",
"description": "Legal entity identifier of the financial institution."
},
"Nm": {
"type": "object",
"description": "Name by which an agent is known and which is usually used to identify that agent.",
"allOf": [
{
"$ref": "#/$defs/Max140Text"
}
]
},
"PstlAdr": {
"$ref": "#/$defs/PostalAddress24"
}
},
"description": "Identifies a specific branch of a financial institution."
},
"CashAccount38": {
"required": [
"Id"
],
"type": "object",
"properties": {
"Ccy": {
"type": "object",
"description": "Identification of the currency in which the account is held.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
}
]
},
"Id": {
"$ref": "#/$defs/AccountIdentification4Choice"
},
"Nm": {
"type": "object",
"description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.",
"allOf": [
{
"$ref": "#/$defs/Max70Text"
}
]
},
"Tp": {
"$ref": "#/$defs/CashAccountType2Choice"
},
"Prxy": {
"$ref": "#/$defs/ProxyAccountIdentification1"
}
}
},
"CashAccountType2Choice": {
"type": "object",
"properties": {
"Cd": {
"maxLength": 4,
"minLength": 1,
"type": "string",
"description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org."
},
"Prtry": {
"type": "object",
"description": "Name of the cash account, in a free text form.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Specifies the nature, or use of the account. Either the `code` or the `proprietary` parameter should be passed in the request."
},
"CategoryPurpose1Choice": {
"type": "object",
"properties": {
"Cd": {
"maxLength": 4,
"minLength": 1,
"type": "string",
"description": "Category purpose, as published in an external category purpose code list."
},
"Prtry": {
"type": "object",
"description": "Category purpose, in a proprietary form.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Specifies the high level purpose of the instruction based on a set of pre-defined categories. Either the `code` or the `proprietary` parameter should be passed in the request ."
},
"ChargeBearerType1Code": {
"type": "string",
"description": "Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
DEBT: All transaction charges are to be borne by the debtor.
CRED: All transaction charges are to be borne by the creditor.
SHAR: In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.
SLEV: Charges are to be applied following the rules agreed in the service level and/or scheme.",
"enum": [
"DEBT",
"CRED",
"SHAR",
"SLEV"
]
},
"Charges7": {
"type": "object",
"properties": {
"Amt": {
"type": "object",
"description": "Transaction charges to be paid by the charge bearer.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"Agt": {
"type": "object",
"description": "Agent that takes the transaction charges or to which the transaction charges are due.",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
}
}
},
"ClearingChannel2Code": {
"type": "string",
"description": "Specifies the clearing channel to be used to process the payment instruction.
RTGS: Clearing channel is a real-time gross settlement system.
RTNS: Clearing channel is a real-time net settlement system.
MPNS: Clearing channel is a mass payment net settlement system.
BOOK: Payment through internal book transfer.",
"enum": [
"RTGS",
"RTNS",
"MPNS",
"BOOK"
]
},
"ClearingSystemIdentification3Choice": {
"type": "object",
"properties": {
"Cd": {
"maxLength": 3,
"minLength": 1,
"type": "string",
"description": "Infrastructure through which the payment instruction is processed, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org."
},
"Prtry": {
"type": "object",
"description": "Clearing system identification in a proprietary form.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed. Either the `code` or the `proprietary` parameter should be passed in the request ."
},
"ClearingSystemMemberIdentification2": {
"required": [
"MmbId"
],
"type": "object",
"properties": {
"ClrSysId": {
"type": "object",
"properties": {
"Cd": {
"maxLength": 5,
"minLength": 1,
"type": "string",
"description": "Identification of a clearing system, in a coded form as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org."
},
"Prtry": {
"type": "object",
"description": "Identification code for a clearing system, that has not yet been identified in the list of clearing systems.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed. Either the `code` or the `proprietary` parameter should be passed in the request ."
},
"MmbId": {
"type": "object",
"description": "Identification of a member of a clearing system.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Information used to identify a member within a clearing system."
},
"Contact4": {
"type": "object",
"properties": {
"NmPrfx": {
"$ref": "#/$defs/NamePrefix2Code"
},
"Nm": {
"type": "object",
"description": "Name by which a party is known and which is usually used to identify that party.",
"allOf": [
{
"$ref": "#/$defs/Max140Text"
}
]
},
"PhneNb": {
"type": "object",
"description": "Collection of information that identifies a phone number, as defined by telecom services.",
"allOf": [
{
"$ref": "#/$defs/PhoneNumber"
}
]
},
"MobNb": {
"type": "object",
"description": "Collection of information that identifies a mobile phone number, as defined by telecom services.",
"allOf": [
{
"$ref": "#/$defs/PhoneNumber"
}
]
},
"FaxNb": {
"type": "object",
"description": "Collection of information that identifies a FAX number, as defined by telecom services.",
"allOf": [
{
"$ref": "#/$defs/PhoneNumber"
}
]
},
"EmailAdr": {
"type": "object",
"description": "Address for electronic mail (e-mail).",
"allOf": [
{
"$ref": "#/$defs/Max2048Text"
}
]
},
"EmailPurp": {
"type": "object",
"description": "Purpose for which an email address may be used.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"JobTitl": {
"type": "object",
"description": "Title of the function.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"Rspnsblty": {
"type": "object",
"description": "Role of a person in an organization.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"Dept": {
"type": "object",
"description": "Identification of a division of a large organization or building.",
"allOf": [
{
"$ref": "#/$defs/Max70Text"
}
]
},
"Othr": {
"type": "array",
"description": "Contact details in another form.",
"items": {
"$ref": "#/$defs/OtherContact1"
}
},
"PrefrdMtd": {
"$ref": "#/$defs/PreferredContactMethod1Code"
}
},
"description": "Set of elements used to indicate how to contact the party."
},
"CountryCode": {
"pattern": "[A-Z]{2,2}",
"type": "string",
"description": "Nation with its own government. The code is checked against the list of country names obtained from the United Nations (ISO 3166, Alpha-2 code)."
},
"CreditDebitCode": {
"type": "string",
"description": "Specifies whether the adjustment must be subtracted or added to the total amount.
CRDT: Operation is an increase.
DBIT: Operation is a decrease.",
"enum": [
"CRDT",
"DBIT"
]
},
"CreditTransferTransaction39": {
"required": [
"Cdtr",
"CdtrAgt",
"ChrgBr",
"Dbtr",
"DbtrAgt",
"IntrBkSttlmAmt",
"PmtId"
],
"type": "object",
"properties": {
"PmtId": {
"$ref": "#/$defs/PaymentIdentification7"
},
"PmtTpInf": {
"$ref": "#/$defs/PaymentTypeInformation28"
},
"IntrBkSttlmAmt": {
"type": "object",
"description": "Amount of money moved between the instructing agent and the instructed agent.",
"allOf": [
{
"$ref": "#/$defs/ActiveCurrencyAndAmount"
}
]
},
"IntrBkSttlmDt": {
"type": "string",
"description": "Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.",
"format": "date"
},
"SttlmPrty": {
"type": "object",
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the settlement instruction.",
"allOf": [
{
"$ref": "#/$defs/Priority3Code"
}
]
},
"SttlmTmIndctn": {
"type": "object",
"properties": {
"DbtDtTm": {
"type": "string",
"description": "Date and time at which a payment has been debited at the transaction administrator. In the case of TARGET, the date and time at which the payment has been debited at the central bank, expressed in Central European Time (CET).",
"format": "date-time"
},
"CdtDtTm": {
"type": "string",
"description": "Date and time at which a payment has been credited at the transaction administrator. In the case of TARGET, the date and time at which the payment has been credited at the receiving central bank, expressed in Central European Time (CET).",
"format": "date-time"
}
},
"description": "Provides information on the occurred settlement time(s) of the payment transaction."
},
"SttlmTmReq": {
"type": "object",
"properties": {
"CLSTm": {
"type": "string",
"description": "Time by which the amount of money must be credited, with confirmation, to the CLS Bank's account at the central bank.",
"format": "partial-time"
},
"TillTm": {
"type": "string",
"description": "Time until when the payment may be settled.",
"format": "partial-time"
},
"FrTm": {
"type": "string",
"description": "Time as from when the payment may be settled.",
"format": "partial-time"
},
"RjctTm": {
"type": "string",
"description": "Time by when the payment must be settled to avoid rejection.",
"format": "partial-time"
}
},
"description": "Provides information on the requested settlement time(s) of the payment instruction."
},
"AccptncDtTm": {
"type": "string",
"description": "Point in time when the payment order from the initiating party meets the processing conditions of the account servicing agent. This means that the account servicing agent has received the payment order and has applied checks such as authorisation, availability of funds.",
"format": "date-time"
},
"PoolgAdjstmntDt": {
"type": "object",
"description": "Date used for the correction of the value date of a cash pool movement that has been posted with a different value date.",
"allOf": [
{
"$ref": "#/$defs/ISODate"
}
]
},
"InstdAmt": {
"type": "object",
"description": "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.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"XchgRate": {
"$ref": "#/$defs/BaseOneRate"
},
"ChrgBr": {
"$ref": "#/$defs/ChargeBearerType1Code"
},
"ChrgsInf": {
"type": "array",
"description": "Provides information on the charges to be paid by the charge bearer(s) related to the payment transaction.",
"items": {
"$ref": "#/$defs/Charges7"
}
},
"PrvsInstgAgt1": {
"type": "object",
"description": "Agent immediately prior to the instructing agent.",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
},
"PrvsInstgAgt1Acct": {
"type": "object",
"description": "Unambiguous identification of the account of the previous instructing agent at its servicing agent in the payment chain.",
"allOf": [
{
"$ref": "#/$defs/CashAccount38"
}
]
},
"PrvsInstgAgt2": {
"type": "object",
"description": "Agent immediately prior to the instructing agent.",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
},
"PrvsInstgAgt2Acct": {
"type": "object",
"description": "Unambiguous identification of the account of the previous instructing agent at its servicing agent in the payment chain.",
"allOf": [
{
"$ref": "#/$defs/CashAccount38"
}
]
},
"PrvsInstgAgt3": {
"type": "object",
"description": "Agent immediately prior to the instructing agent.",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
},
"PrvsInstgAgt3Acct": {
"type": "object",
"description": "Unambiguous identification of the account of the previous instructing agent at its servicing agent in the payment chain.",
"allOf": [
{
"$ref": "#/$defs/CashAccount38"
}
]
},
"InstgAgt": {
"type": "object",
"description": "Agent that instructs the next party in the chain to carry out the (set of) instruction(s).",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
},
"InstdAgt": {
"type": "object",
"description": "Agent that is instructed by the previous party in the chain to carry out the (set of) instruction(s).",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
},
"IntrmyAgt1": {
"type": "object",
"description": "Agent between the debtor's agent and the creditor's agent.",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
},
"IntrmyAgt1Acct": {
"type": "object",
"description": "Unambiguous identification of the account of the intermediary agent 1 at its servicing agent in the payment chain.",
"allOf": [
{
"$ref": "#/$defs/CashAccount38"
}
]
},
"IntrmyAgt2": {
"type": "object",
"description": "Agent between the debtor's agent and the creditor's agent.",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
},
"IntrmyAgt2Acct": {
"type": "object",
"description": "Unambiguous identification of the account of the intermediary agent 2 at its servicing agent in the payment chain.",
"allOf": [
{
"$ref": "#/$defs/CashAccount38"
}
]
},
"IntrmyAgt3": {
"type": "object",
"description": "Agent between the debtor's agent and the creditor's agent.",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
},
"IntrmyAgt3Acct": {
"type": "object",
"description": "Unambiguous identification of the account of the intermediary agent 3 at its servicing agent in the payment chain.",
"allOf": [
{
"$ref": "#/$defs/CashAccount38"
}
]
},
"UltmtDbtr": {
"type": "object",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor.",
"allOf": [
{
"$ref": "#/$defs/PartyIdentification135"
}
]
},
"InitgPty": {
"type": "object",
"description": "Party that initiates the payment.",
"allOf": [
{
"$ref": "#/$defs/PartyIdentification135"
}
]
},
"Dbtr": {
"type": "object",
"description": "Party that owes an amount of money to the creditor.",
"allOf": [
{
"$ref": "#/$defs/PartyIdentification135"
}
]
},
"DbtrAcct": {
"type": "object",
"description": "Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.",
"allOf": [
{
"$ref": "#/$defs/CashAccount38"
}
]
},
"DbtrAgt": {
"type": "object",
"description": "Financial institution servicing an account for the debtor.",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
},
"DbtrAgtAcct": {
"type": "object",
"description": "Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain.",
"allOf": [
{
"$ref": "#/$defs/CashAccount38"
}
]
},
"Cdtr": {
"type": "object",
"description": "Party to which an amount of money is due.",
"allOf": [
{
"$ref": "#/$defs/PartyIdentification135"
}
]
},
"CdtrAcct": {
"type": "object",
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.",
"allOf": [
{
"$ref": "#/$defs/CashAccount38"
}
]
},
"CdtrAgt": {
"type": "object",
"description": "Financial institution servicing an account for the creditor.",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
},
"CdtrAgtAcct": {
"type": "object",
"description": "Unambiguous identification of the account of the creditor agent at its servicing agent to which a credit entry will be made as a result of the payment transaction.",
"allOf": [
{
"$ref": "#/$defs/CashAccount38"
}
]
},
"UltmtCdtr": {
"type": "object",
"description": "Ultimate party to which an amount of money is due.",
"allOf": [
{
"$ref": "#/$defs/PartyIdentification135"
}
]
},
"InstrForCdtrAgt": {
"type": "array",
"description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.",
"items": {
"$ref": "#/$defs/InstructionForCreditorAgent1"
}
},
"InstrForNxtAgt": {
"type": "array",
"description": "Further information related to the processing of the payment instruction that may need to be acted upon by the next agent.",
"items": {
"$ref": "#/$defs/InstructionForNextAgent1"
}
},
"Purp": {
"$ref": "#/$defs/Purpose2Choice"
},
"RgltryRptg": {
"maxItems": 10,
"type": "array",
"description": "Information needed due to regulatory and statutory requirements.",
"items": {
"$ref": "#/$defs/RegulatoryReporting3"
}
},
"Tax": {
"$ref": "#/$defs/TaxInformation8"
},
"RltdRmtInf": {
"maxItems": 10,
"type": "array",
"description": "Provides information related to the handling of the remittance information by any of the agents in the transaction processing chain.",
"items": {
"$ref": "#/$defs/RemittanceLocation7"
}
},
"RmtInf": {
"type": "object",
"description": "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.",
"allOf": [
{
"$ref": "#/$defs/RemittanceInformation16"
}
]
},
"SplmtryData": {
"type": "array",
"description": "Additional information that can not be captured in the structured fields and/or any other specific block.",
"items": {
"$ref": "#/$defs/SupplementaryData1"
}
}
}
},
"CreditorReferenceInformation2": {
"type": "object",
"properties": {
"Ref": {
"type": "object",
"description": "Unique reference, as assigned by the creditor, to refer to the payment transaction.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"Tp": {
"$ref": "#/$defs/CreditorReferenceType2"
}
},
"description": "Reference information provided by the creditor to allow the identification of the underlying documents."
},
"CreditorReferenceType1Choice": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/DocumentType3Code"
},
"Prtry": {
"type": "object",
"description": "Creditor reference type, in a proprietary form.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Coded or proprietary format creditor reference type. Either Code or Proprietary field value should be passed on request."
},
"CreditorReferenceType2": {
"required": [
"CdOrPrtry"
],
"type": "object",
"properties": {
"CdOrPrtry": {
"$ref": "#/$defs/CreditorReferenceType1Choice"
},
"Issr": {
"type": "object",
"description": "Entity that assigns the credit reference type.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Specifies the type of creditor reference."
},
"DateAndPlaceOfBirth": {
"required": [
"BirthDt",
"CityOfBirth",
"CtryOfBirth"
],
"type": "object",
"properties": {
"BirthDt": {
"type": "object",
"description": "Date on which a person is born.",
"allOf": [
{
"$ref": "#/$defs/ISODate"
}
]
},
"PrvcOfBirth": {
"type": "object",
"description": "Province where a person was born.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"CityOfBirth": {
"type": "object",
"description": "City where a person was born.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"CtryOfBirth": {
"type": "object",
"description": "Country where a person was born.",
"allOf": [
{
"$ref": "#/$defs/CountryCode"
}
]
}
},
"description": "Date and place of birth of a person."
},
"DatePeriodDetails": {
"required": [
"FrDt",
"ToDt"
],
"type": "object",
"properties": {
"FrDt": {
"type": "object",
"description": "Start date of the range.",
"allOf": [
{
"$ref": "#/$defs/ISODate"
}
]
},
"ToDt": {
"type": "object",
"description": "End date of the range.",
"allOf": [
{
"$ref": "#/$defs/ISODate"
}
]
}
},
"description": "Range of time between a start date and an end date for which the tax report is provided."
},
"DiscountAmountAndType1": {
"required": [
"Amt"
],
"type": "object",
"properties": {
"Tp": {
"$ref": "#/$defs/DiscountAmountType1Choice"
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
}
}
},
"DiscountAmountType1Choice": {
"type": "object",
"properties": {
"Cd": {
"type": "object",
"description": "Specifies the nature, or use, of the amount in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.",
"allOf": [
{
"$ref": "#/$defs/Max4Text"
}
]
},
"Prtry": {
"type": "object",
"description": "Specifies type of amount, as a proprietary code.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Specifies the type of the amount. Either the `code` or the `proprietary` parameter should be passed in the request ."
},
"DocumentAdjustment1": {
"required": [
"Amt"
],
"type": "object",
"properties": {
"AddtlInf": {
"type": "object",
"description": "Provides further details on the document adjustment.",
"allOf": [
{
"$ref": "#/$defs/Max140Text"
}
]
},
"Amt": {
"type": "object",
"description": "Amount of money of the document adjustment.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"CdtDbtInd": {
"$ref": "#/$defs/CreditDebitCode"
},
"Rsn": {
"type": "object",
"description": "Specifies the reason for the adjustment.",
"allOf": [
{
"$ref": "#/$defs/Max4Text"
}
]
}
}
},
"DocumentLineIdentification1": {
"type": "object",
"properties": {
"Nb": {
"type": "object",
"description": "Identification of the type specified for the referred document line.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"RltdDt": {
"type": "object",
"description": "Date associated with the referred document line.",
"allOf": [
{
"$ref": "#/$defs/ISODate"
}
]
},
"Tp": {
"$ref": "#/$defs/DocumentLineType1"
}
}
},
"DocumentLineInformation1": {
"required": [
"Id"
],
"type": "object",
"properties": {
"Id": {
"minItems": 1,
"type": "array",
"description": "Set of elements used to provide the content of the referred document line.",
"items": {
"$ref": "#/$defs/DocumentLineIdentification1"
}
},
"Desc": {
"type": "object",
"description": "Description associated with the document line.",
"allOf": [
{
"$ref": "#/$defs/Max2048Text"
}
]
},
"Amt": {
"$ref": "#/$defs/RemittanceAmount3"
}
}
},
"DocumentLineType1": {
"required": [
"CdOrPrtry"
],
"type": "object",
"properties": {
"CdOrPrtry": {
"$ref": "#/$defs/DocumentLineType1Choice"
},
"Issr": {
"type": "object",
"description": "Identification of the issuer of the reference document line identificationtype.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Specifies the type of referred document line identification."
},
"DocumentLineType1Choice": {
"type": "object",
"properties": {
"Cd": {
"type": "object",
"description": "Specifies the document line type as published in an external document type code list.",
"allOf": [
{
"$ref": "#/$defs/Max4Text"
}
]
},
"Prtry": {
"type": "object",
"description": "Proprietary identification of the type of the document line.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Provides the type details of the referred document line identification. Either the `code` or the `proprietary` parameter should be passed in the request ."
},
"DocumentType3Code": {
"type": "string",
"description": "Type of creditor reference, in a coded form.
RADM: Document is a remittance advice sent separately from the current transaction.
RPIN: Document is a linked payment instruction to which the current payment instruction is related, for example, in a cover scenario.
FXDR: Document is a pre-agreed or pre-arranged foreign exchange transaction to which the payment transaction refers.
DISP: Document is a dispatch advice.
PUOR: Document is a purchase order
SCOR: Document is a structured communication reference provided by the creditor to identify the referred transaction.",
"enum": [
"RADM",
"RPIN",
"FXDR",
"DISP",
"PUOR",
"SCOR"
]
},
"DocumentType6Code": {
"type": "string",
"description": "Specifies a type of financial or commercial document.
MSIN: Document is an invoice claiming payment for the supply of metered services, for example gas or electricity supplied to a fixed meter.
CNFA: Document is a credit note for the final amount settled for a commercial transaction.
DNFA: Document is a debit note for the final amount settled for a commercial transaction.
CINV: Document is an invoice.
CREN: Document is a credit note.
DEBN: Document is a debit note.
HIRI: Document is an invoice for the hiring of human resources or renting goods or equipment.
SBIN: Document is an invoice issued by the debtor.
SVGS: Account used for savings.
CMCN: Document is an agreement between the parties, stipulating the terms and conditions of the delivery of goods or services.
SOAC: Document is a statement of the transactions posted to the debtor's account at the supplier.
DISP: Document is a dispatch advice.
BOLD: Document is a shipping notice.
VCHR: Document is an electronic payment document.
AROI: Document is a payment that applies to a specific source document.
TSUT: Document is a transaction identifier as assigned by the Trade Services Utility.
PUOR: Document is a purchase order.",
"enum": [
"MSIN",
"CNFA",
"DNFA",
"CINV",
"CREN",
"DEBN",
"HIRI",
"SBIN",
"CMCN",
"SOAC",
"DISP",
"BOLD",
"VCHR",
"AROI",
"TSUT",
"PUOR"
]
},
"FIToFICustomerCreditTransferV08": {
"required": [
"CdtTrfTxInf",
"GrpHdr"
],
"type": "object",
"properties": {
"GrpHdr": {
"$ref": "#/$defs/GroupHeader93"
},
"CdtTrfTxInf": {
"minItems": 1,
"type": "array",
"description": "Provides further details specific to the individual transaction(s) included in the message.",
"items": {
"$ref": "#/$defs/CreditTransferTransaction39"
}
},
"SplmtryData": {
"type": "array",
"description": "Additional information that can not be captured in the structured parameters and/or any other specific block.",
"items": {
"$ref": "#/$defs/SupplementaryData1"
}
}
},
"description": "The `FinancialInstitutionToFinancialInstitutionCustomerCreditTransfer` message is sent by the debtor agent to the creditor agent, directly or through other agents and/or a payment clearing and settlement system. It is used to move funds from a debtor account to a creditor."
},
"FinancialIdentificationSchemeName1Choice": {
"type": "object",
"properties": {
"Cd": {
"maxLength": 4,
"minLength": 1,
"type": "string",
"description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org."
},
"Prtry": {
"type": "object",
"description": "Name of the identification scheme, in a free text form.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Name of the identification scheme. Either the `code` or the `proprietary` parameter should be passed in the request ."
},
"FinancialInstitutionIdentification18": {
"type": "object",
"properties": {
"BICFI": {
"pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}",
"type": "string",
"description": "Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"."
},
"ClrSysMmbId": {
"$ref": "#/$defs/ClearingSystemMemberIdentification2"
},
"LEI": {
"pattern": "[A-Z0-9]{18,18}[0-9]{2,2}",
"type": "string",
"description": "Legal entity identifier of the financial institution."
},
"Nm": {
"type": "object",
"description": "Name by which an agent is known and which is usually used to identify that agent.",
"allOf": [
{
"$ref": "#/$defs/Max140Text"
}
]
},
"Othr": {
"$ref": "#/$defs/GenericFinancialIdentification1"
},
"PstlAdr": {
"$ref": "#/$defs/PostalAddress24"
}
},
"description": "Unique identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme."
},
"Garnishment3": {
"required": [
"Tp"
],
"type": "object",
"properties": {
"Tp": {
"$ref": "#/$defs/GarnishmentType1"
},
"Grnshee": {
"type": "object",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the garnisher.",
"allOf": [
{
"$ref": "#/$defs/PartyIdentification135"
}
]
},
"GrnshmtAdmstr": {
"type": "object",
"description": "Party on the credit side of the transaction who administers the garnishment on behalf of the ultimate beneficiary.",
"allOf": [
{
"$ref": "#/$defs/PartyIdentification135"
}
]
},
"RefNb": {
"type": "object",
"description": "Reference information that is specific to the agency receiving the garnishment.",
"allOf": [
{
"$ref": "#/$defs/Max140Text"
}
]
},
"Dt": {
"type": "object",
"description": "Date of payment which garnishment was taken from.",
"allOf": [
{
"$ref": "#/$defs/ISODate"
}
]
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted for the referred document.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"FmlyMdclInsrncInd": {
"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."
}
},
"description": "Provides remittance information about a payment for garnishment-related purposes."
},
"GarnishmentType1": {
"required": [
"CdOrPrtry"
],
"type": "object",
"properties": {
"CdOrPrtry": {
"$ref": "#/$defs/GarnishmentType1Choice"
},
"Issr": {
"type": "object",
"description": "Identification of the issuer of the garnishment type.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Specifies the type of garnishment."
},
"GarnishmentType1Choice": {
"type": "object",
"properties": {
"Cd": {
"type": "object",
"description": "Specifies the garnishment type as published in an external document type code list.",
"allOf": [
{
"$ref": "#/$defs/Max4Text"
}
]
},
"Prtry": {
"type": "object",
"description": "Proprietary identification of the type of the garnishment.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Provides the type details of the garnishment. Either the `code` or the `proprietary` parameter should be passed in the request ."
},
"GenericAccountIdentification1": {
"required": [
"Id"
],
"type": "object",
"properties": {
"Id": {
"type": "object",
"description": "Identification assigned by an institution.",
"allOf": [
{
"$ref": "#/$defs/Max34Text"
}
]
},
"Issr": {
"type": "object",
"description": "Entity that assigns the identification.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"SchmeNm": {
"type": "object",
"description": "Name of the identification scheme.",
"allOf": [
{
"$ref": "#/$defs/FinancialIdentificationSchemeName1Choice"
}
]
}
},
"description": "Unique identification of an account, as assigned by the account servicer, using an identification scheme."
},
"GenericFinancialIdentification1": {
"required": [
"Id"
],
"type": "object",
"properties": {
"Id": {
"type": "object",
"description": "Unique identification of a person.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"Issr": {
"type": "object",
"description": "Entity that assigns the identification.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"SchmeNm": {
"$ref": "#/$defs/FinancialIdentificationSchemeName1Choice"
}
},
"description": "Unique identification of an agent, as assigned by an institution, using an identification scheme."
},
"GenericIdentification30": {
"required": [
"Id",
"Issr"
],
"type": "object",
"properties": {
"Id": {
"pattern": "[a-zA-Z0-9]{4}",
"type": "string",
"description": "Proprietary information, often a code, issued by the data source scheme issuer."
},
"Issr": {
"type": "object",
"description": "Entity that assigns the identification.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"SchmeNm": {
"type": "object",
"description": "Short textual description of the scheme.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Information related to an identification, for example, party identification or account identification."
},
"GenericOrganisationIdentification1": {
"required": [
"Id"
],
"type": "object",
"properties": {
"Id": {
"type": "object",
"description": "Identification assigned by an institution.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"SchmeNm": {
"type": "object",
"description": "Name of the identification scheme.",
"allOf": [
{
"$ref": "#/$defs/IdentificationSchemeName1Choice"
}
]
},
"Issr": {
"type": "object",
"description": "Entity that assigns the identification.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
}
},
"GenericPersonIdentification1": {
"required": [
"Id"
],
"type": "object",
"properties": {
"Id": {
"type": "object",
"description": "Unique identification of a person.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"SchmeNm": {
"type": "object",
"description": "Name of the identification scheme.",
"allOf": [
{
"$ref": "#/$defs/IdentificationSchemeName1Choice"
}
]
},
"Issr": {
"type": "object",
"description": "Entity that assigns the identification.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Unique identification of a person, as assigned by an institution, using an identification scheme."
},
"GroupHeader93": {
"required": [
"CreDtTm",
"MsgId",
"NbOfTxs",
"SttlmInf"
],
"type": "object",
"properties": {
"MsgId": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to identify the message."
},
"CreDtTm": {
"type": "string",
"description": "Date and time at which the message was created.",
"format": "date-time"
},
"BtchBookg": {
"type": "boolean",
"description": "Identifies whether a single entry per individual transaction or a batch entry for the sum of the amounts of all transactions within the group of a message is requested."
},
"NbOfTxs": {
"type": "object",
"description": "Number of individual transactions contained in the message.",
"allOf": [
{
"$ref": "#/$defs/Max15NumericText"
}
]
},
"CtrlSum": {
"maxLength": 18,
"type": "string",
"description": "Total of all individual amounts included in the message, irrespective of currencies. The number of fractional digits in the amount should not be more than 17."
},
"TtlIntrBkSttlmAmt": {
"type": "object",
"description": "Total amount of money moved between the instructing agent and the instructed agent.",
"allOf": [
{
"$ref": "#/$defs/ActiveCurrencyAndAmount"
}
]
},
"IntrBkSttlmDt": {
"type": "string",
"description": "Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.",
"format": "date"
},
"SttlmInf": {
"$ref": "#/$defs/SettlementInstruction7"
},
"PmtTpInf": {
"$ref": "#/$defs/PaymentTypeInformation28"
},
"InstgAgt": {
"type": "object",
"description": "Agent that instructs the next party in the chain to carry out the (set of) instruction(s).",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
},
"InstdAgt": {
"type": "object",
"description": "Agent that is instructed by the previous party in the chain to carry out the (set of) instruction(s).",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
}
},
"description": "Group header details. Set of characteristics shared by all individual transactions included in the message."
},
"IBAN2007Identifier": {
"pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
"type": "string",
"description": ">- International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 \"Banking and related financial services - International Bank Account Number (IBAN)\" version 1997-10-01, or later revisions."
},
"ISODate": {
"type": "string",
"format": "date"
},
"IdentificationSchemeName1Choice": {
"required": [
"Cd",
"Prtry"
],
"type": "object",
"properties": {
"Cd": {
"maxLength": 4,
"minLength": 1,
"type": "string",
"description": "Name of the identification scheme, in a coded form as published in an external list."
},
"Prtry": {
"type": "object",
"description": "Name of the identification scheme, in a free text form.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
}
},
"Instruction3Code": {
"type": "string",
"description": "Coded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.
CHQB: (Ultimate) creditor must be paid by cheque.
HOLD: Amount of money must be held for the (ultimate) creditor, who will call. Pay on identification.
PHOB: Please advise/contact (ultimate) creditor/claimant by phone.
TELB: Please advise/contact (ultimate) creditor/claimant by the most efficient means of telecommunication.",
"enum": [
"CHQB",
"HOLD",
"PHOB",
"TELB"
]
},
"Instruction4Code": {
"type": "string",
"description": "Coded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.
PHOA: Please advise/contact next agent by phone.
TELA: Please advise/contact next agent by the most efficient means of telecommunication.",
"enum": [
"PHOA",
"TELA"
]
},
"InstructionForCreditorAgent1": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/Instruction3Code"
},
"InstrInf": {
"type": "object",
"description": "Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.",
"allOf": [
{
"$ref": "#/$defs/Max140Text"
}
]
}
}
},
"InstructionForNextAgent1": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/Instruction4Code"
},
"InstrInf": {
"type": "object",
"description": "Further information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.",
"allOf": [
{
"$ref": "#/$defs/Max140Text"
}
]
}
}
},
"LocalInstrument2Choice": {
"type": "object",
"properties": {
"Cd": {
"type": "object",
"description": "Specifies the local instrument, as published in an external local instrument code list.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"Prtry": {
"type": "object",
"description": "Specifies the local instrument, as a proprietary code.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "User community specific instrument. Either the `code` or the `proprietary` parameter should be passed in the request ."
},
"Max10Text": {
"maxLength": 10,
"minLength": 1,
"type": "string"
},
"Max140Text": {
"maxLength": 140,
"minLength": 1,
"type": "string"
},
"Max15NumericText": {
"pattern": "[0-9]{1,15}",
"type": "string"
},
"Max16Text": {
"maxLength": 16,
"minLength": 1,
"type": "string"
},
"Max2048Text": {
"maxLength": 2048,
"minLength": 1,
"type": "string"
},
"Max34Text": {
"maxLength": 34,
"minLength": 1,
"type": "string"
},
"Max35Text": {
"maxLength": 35,
"minLength": 1,
"type": "string"
},
"Max4Text": {
"maxLength": 4,
"minLength": 1,
"type": "string"
},
"Max70Text": {
"maxLength": 70,
"minLength": 1,
"type": "string"
},
"NameAndAddress16": {
"required": [
"Adr",
"Nm"
],
"type": "object",
"properties": {
"Adr": {
"$ref": "#/$defs/PostalAddress24"
},
"Nm": {
"type": "object",
"description": "Name by which a party is known and is usually used to identify that party.",
"allOf": [
{
"$ref": "#/$defs/Max140Text"
}
]
}
}
},
"NamePrefix2Code": {
"type": "string",
"description": "Specifies the terms used to formally address a person.
DOCT: Title of the person is Doctor or Dr.
MIST: Title of the person is Mister or Mr.
MISS: Title of the person is Miss.
MADM: Title of the person is Madam.
MIKS: Title of the person is gender neutral (Mx).",
"enum": [
"DOCT",
"MIST",
"MISS",
"MADM",
"MIKS"
]
},
"Number": {
"maxLength": 18,
"type": "number"
},
"OrganisationIdentification29": {
"type": "object",
"properties": {
"AnyBIC": {
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}",
"type": "string",
"description": "Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - \"Banking - Banking telecommunication messages - Business identifier code (BIC)\"."
},
"Othr": {
"type": "array",
"description": "Unique identification of an organization, as assigned by an institution, using an identification scheme.",
"items": {
"$ref": "#/$defs/GenericOrganisationIdentification1"
}
},
"LEI": {
"pattern": "[A-Z0-9]{18,18}[0-9]{2,2}",
"type": "string",
"description": "Legal entity identification as an alternate identification for a party."
}
},
"description": "Unique way to identify an organization."
},
"OtherContact1": {
"required": [
"ChanlTp"
],
"type": "object",
"properties": {
"ChanlTp": {
"type": "object",
"description": "Method used to contact the financial institution’s contact for the specific tax region.",
"allOf": [
{
"$ref": "#/$defs/Max4Text"
}
]
},
"Id": {
"maxLength": 128,
"minLength": 1,
"type": "string",
"description": "Communication value such as phone number or email address."
}
}
},
"PartyIdentification135": {
"type": "object",
"properties": {
"Nm": {
"type": "object",
"description": "Name by which a party is known and which is usually used to identify that party.",
"allOf": [
{
"$ref": "#/$defs/Max140Text"
}
]
},
"PstlAdr": {
"$ref": "#/$defs/PostalAddress24"
},
"Id": {
"type": "object",
"properties": {
"OrgId": {
"$ref": "#/$defs/OrganisationIdentification29"
},
"PrvtId": {
"$ref": "#/$defs/PersonIdentification13"
}
},
"description": "Unique identification of a party. Should pass either OrgId or PrvtId for organization and private respectively in the request."
},
"CtryOfRes": {
"type": "object",
"description": "Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.",
"allOf": [
{
"$ref": "#/$defs/CountryCode"
}
]
},
"CtctDtls": {
"$ref": "#/$defs/Contact4"
}
}
},
"PaymentIdentification7": {
"required": [
"EndToEndId"
],
"type": "object",
"properties": {
"EndToEndId": {
"type": "object",
"description": "Unique identification, as assigned by the initiating party, to identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"InstrId": {
"type": "object",
"description": "Unique identification as assigned by an instructing party for an instructed party to identify the instruction.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"TxId": {
"type": "object",
"description": "Unique identification, as assigned by the first instructing agent, to identify the transaction that is passed on, unchanged, throughout the entire interbank chain.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"UETR": {
"pattern": "[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}",
"type": "string",
"description": "Universally unique identifier to provide an end-to-end reference of a payment transaction."
},
"ClrSysRef": {
"type": "object",
"description": "Unique reference, as assigned by a clearing system, to identify the instruction.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Set of elements used to reference a payment instruction."
},
"PaymentTypeInformation28": {
"type": "object",
"properties": {
"CtgyPurp": {
"$ref": "#/$defs/CategoryPurpose1Choice"
},
"InstrPrty": {
"$ref": "#/$defs/Priority2Code"
},
"LclInstrm": {
"$ref": "#/$defs/LocalInstrument2Choice"
},
"SvcLvl": {
"type": "array",
"items": {
"$ref": "#/$defs/ServiceLevel8Choice"
}
},
"ClrChanl": {
"$ref": "#/$defs/ClearingChannel2Code"
}
},
"description": "Set of elements used to further specify the type of transaction."
},
"PersonIdentification13": {
"type": "object",
"properties": {
"DtAndPlcOfBirth": {
"$ref": "#/$defs/DateAndPlaceOfBirth"
},
"Othr": {
"type": "array",
"description": "Unique identification of a person, as assigned by an institution, using an identification scheme.",
"items": {
"$ref": "#/$defs/GenericPersonIdentification1"
}
}
},
"description": "Unique way to identify a person."
},
"PhoneNumber": {
"pattern": "\\+[0-9]{1,3}-[0-9()+\\-]{1,30}",
"type": "string"
},
"PostalAddress24": {
"type": "object",
"properties": {
"AdrTp": {
"$ref": "#/$defs/AddressType3Choice"
},
"Dept": {
"type": "object",
"description": "Identification of a division of a large organization or building.",
"allOf": [
{
"$ref": "#/$defs/Max70Text"
}
]
},
"SubDept": {
"type": "object",
"description": "Identification of a sub-division of a large organization or building.",
"allOf": [
{
"$ref": "#/$defs/Max70Text"
}
]
},
"StrtNm": {
"type": "object",
"description": "Name of a street or thoroughfare.",
"allOf": [
{
"$ref": "#/$defs/Max70Text"
}
]
},
"BldgNb": {
"type": "object",
"description": "Number that identifies the position of a building on a street.",
"allOf": [
{
"$ref": "#/$defs/Max16Text"
}
]
},
"BldgNm": {
"type": "object",
"description": "Name of the building or house.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"Flr": {
"type": "object",
"description": "Floor or storey within a building.",
"allOf": [
{
"$ref": "#/$defs/Max70Text"
}
]
},
"PstBx": {
"type": "object",
"description": "Numbered box in a post office, assigned to a person or organization, where letters are kept until called for.",
"allOf": [
{
"$ref": "#/$defs/Max16Text"
}
]
},
"Room": {
"type": "object",
"description": "Building room number.",
"allOf": [
{
"$ref": "#/$defs/Max70Text"
}
]
},
"PstCd": {
"type": "object",
"description": "Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.",
"allOf": [
{
"$ref": "#/$defs/Max16Text"
}
]
},
"TwnNm": {
"type": "object",
"description": "Name of a built-up area, with defined boundaries, and a local government.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"TwnLctnNm": {
"type": "object",
"description": "Specific location name within the town.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"DstrctNm": {
"type": "object",
"description": "Identifies a subdivision within a country sub-division.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"CtrySubDvsn": {
"type": "object",
"description": "Identifies a subdivision of a country such as state, region, county.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"Ctry": {
"$ref": "#/$defs/CountryCode"
},
"AdrLine": {
"maxItems": 7,
"type": "array",
"description": "Information that locates and identifies a specific address, as defined by postal services, presented in free format text.",
"items": {
"$ref": "#/$defs/Max70Text"
}
}
},
"description": "Information that locates and identifies a specific address, as defined by postal services."
},
"PreferredContactMethod1Code": {
"type": "string",
"description": "Preferred method used to reach the contact.
LETT: Preferred method used to reach the contact is per letter.
MAIL: Preferred method used to reach the contact is per email.
PHON: Preferred method used to reach the contact is per phone.
FAXX: Preferred method used to reach the contact is per fax.
CELL: Preferred method used to reach the contact is per mobile or cell phone.",
"enum": [
"LETT",
"MAIL",
"PHON",
"FAXX",
"CELL"
]
},
"Priority2Code": {
"type": "string",
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
HIGH: Priority level is high.
NORM: Priority level is normal.",
"enum": [
"HIGH",
"NORM"
]
},
"Priority3Code": {
"type": "string",
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
URGT: Priority level is urgent (highest priority possible).
HIGH: Priority level is high.
NORM: Priority level is normal.",
"enum": [
"URGT",
"HIGH",
"NORM"
]
},
"ProxyAccountIdentification1": {
"required": [
"Id"
],
"type": "object",
"properties": {
"Tp": {
"$ref": "#/$defs/ProxyAccountType1Choice"
},
"Id": {
"type": "object",
"description": "Identification used to indicate the account identification under another specified name.",
"allOf": [
{
"$ref": "#/$defs/Max2048Text"
}
]
}
},
"description": "Specifies an alternate assumed name for the identification of the account."
},
"ProxyAccountType1Choice": {
"type": "object",
"properties": {
"Cd": {
"maxLength": 4,
"minLength": 1,
"type": "string",
"description": "Specifies the external proxy account type code, as published in the proxy account type external code set. External code sets can be downloaded from www.iso20022.org."
},
"Prtry": {
"type": "object",
"description": "External proxy account type, in a free text form.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Type of the proxy identification. Either the `code` or the `proprietary` parameter should be passed in the request ."
},
"Purpose2Choice": {
"type": "object",
"properties": {
"Cd": {
"maxLength": 4,
"minLength": 1,
"type": "string",
"description": "Underlying reason for the payment transaction, as published in an external purpose code list."
},
"Prtry": {
"type": "object",
"description": "Purpose, in a proprietary form.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Specifies the underlying reason for the payment transaction. Either Code or Proprietary field value should be passed on request."
},
"ReferredDocumentInformation7": {
"type": "object",
"properties": {
"Nb": {
"type": "object",
"description": "Unique identification of the referred document.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"RltdDt": {
"type": "object",
"description": "Date associated with the referred document.",
"allOf": [
{
"$ref": "#/$defs/ISODate"
}
]
},
"Tp": {
"$ref": "#/$defs/ReferredDocumentType4"
},
"LineDtls": {
"type": "array",
"description": "Set of elements used to provide the content of the referred document line.",
"items": {
"$ref": "#/$defs/DocumentLineInformation1"
}
}
}
},
"ReferredDocumentType1Choice": {
"type": "object",
"properties": {
"Cd": {
"$ref": "#/$defs/DocumentType6Code"
},
"Prtry": {
"type": "object",
"description": "Proprietary identification of the type of the remittance document.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Provides the type details of the referred document. Either Code or Proprietary field value should be passed on request."
},
"ReferredDocumentType4": {
"required": [
"CdOrPrtry"
],
"type": "object",
"properties": {
"CdOrPrtry": {
"$ref": "#/$defs/ReferredDocumentType1Choice"
},
"Issr": {
"type": "object",
"description": "Identification of the issuer of the reference document type.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Specifies the type of referred document."
},
"RegulatoryReporting3": {
"type": "object",
"properties": {
"Authrty": {
"type": "object",
"properties": {
"Ctry": {
"type": "object",
"description": "Country of the entity that requires the regulatory reporting information.",
"allOf": [
{
"$ref": "#/$defs/CountryCode"
}
]
},
"Nm": {
"type": "object",
"description": "Name of the entity requiring the regulatory reporting information.",
"allOf": [
{
"$ref": "#/$defs/Max140Text"
}
]
}
},
"description": "Entity requiring the regulatory reporting information."
},
"DbtCdtRptgInd": {
"type": "string",
"description": "Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.
CRED: Regulatory information applies to the credit side.
DEBT: Regulatory information applies to the debit side.
BOTH: Regulatory information applies to both credit and debit sides.",
"enum": [
"CRED",
"DEBT",
"BOTH"
]
},
"Dtls": {
"type": "array",
"description": "Set of elements used to provide details on the regulatory reporting information.",
"items": {
"$ref": "#/$defs/StructuredRegulatoryReporting3"
}
}
}
},
"RemittanceAmount2": {
"type": "object",
"properties": {
"DuePyblAmt": {
"type": "object",
"description": "Amount specified is the exact amount due and payable to the creditor.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"DscntApldAmt": {
"type": "array",
"description": "Amount specified for the referred document is the amount of discount to be applied to the amount due and payable to the creditor.",
"items": {
"$ref": "#/$defs/DiscountAmountAndType1"
}
},
"CdtNoteAmt": {
"type": "object",
"description": "Amount specified for the referred document is the amount of a credit note.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"TaxAmt": {
"type": "array",
"description": "Quantity of cash resulting from the calculation of the tax.",
"items": {
"$ref": "#/$defs/TaxAmountAndType1"
}
},
"AdjstmntAmtAndRsn": {
"type": "array",
"description": "Specifies detailed information on the amount and reason of the document adjustment.",
"items": {
"$ref": "#/$defs/DocumentAdjustment1"
}
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted for the referred document.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
}
},
"description": "Provides details on the amounts of the referred document."
},
"RemittanceAmount3": {
"type": "object",
"properties": {
"DuePyblAmt": {
"type": "object",
"description": "Amount specified is the exact amount due and payable to the creditor.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"DscntApldAmt": {
"type": "array",
"description": "Amount of discount to be applied to the amount due and payable to the creditor.",
"items": {
"$ref": "#/$defs/DiscountAmountAndType1"
}
},
"CdtNoteAmt": {
"type": "object",
"description": "Amount of a credit note.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"TaxAmt": {
"type": "array",
"description": "Amount of the tax.",
"items": {
"$ref": "#/$defs/TaxAmountAndType1"
}
},
"AdjstmntAmtAndRsn": {
"type": "array",
"description": "Set of elements used to provide information on the amount and reason of the document adjustment.",
"items": {
"$ref": "#/$defs/DocumentAdjustment1"
}
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
}
},
"description": "Provides details on the amounts of the document line."
},
"RemittanceInformation16": {
"type": "object",
"properties": {
"Strd": {
"type": "array",
"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.",
"items": {
"$ref": "#/$defs/StructuredRemittanceInformation16"
}
},
"Ustrd": {
"type": "array",
"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 an unstructured form.",
"items": {
"$ref": "#/$defs/Max140Text"
}
}
}
},
"RemittanceLocation7": {
"type": "object",
"properties": {
"RmtId": {
"type": "object",
"description": "Unique identification, as assigned by the initiating party, to identify the remittance information sent separately from the payment instruction, such as a remittance advice.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"RmtLctnDtls": {
"type": "array",
"description": "Set of elements used to provide information on the location and/or delivery of the remittance information.",
"items": {
"$ref": "#/$defs/RemittanceLocationData1"
}
}
}
},
"RemittanceLocationData1": {
"required": [
"Mtd"
],
"type": "object",
"properties": {
"ElctrncAdr": {
"type": "object",
"description": "Electronic address to which an agent is to send the remittance information.",
"allOf": [
{
"$ref": "#/$defs/Max2048Text"
}
]
},
"Mtd": {
"type": "string",
"description": "Method used to deliver the remittance advice information.
FAXI: Remittance advice information must be faxed.
EDIC: Remittance advice information must be sent through Electronic Data Interchange (EDI).
URID: Remittance advice information needs to be sent to a Uniform Resource Identifier (URI). URI is a compact string of characters that uniquely identify an abstract or physical resource. URI's are the super-set of identifiers, such as URLs, email addresses, ftp sites, etc, and as such, provide the syntax for all of the identification schemes.
EMAL: Remittance advice information must be sent through e-mail.
POST: Remittance advice information must be sent through postal services.
SMSM: Remittance advice information must be sent through by phone as a short message service (SMS).",
"enum": [
"FAXI",
"EDIC",
"URID",
"EMAL",
"POST",
"SMSM"
]
},
"PstlAdr": {
"type": "object",
"description": "Postal address to which an agent is to send the remittance information.",
"allOf": [
{
"$ref": "#/$defs/NameAndAddress16"
}
]
}
}
},
"ServiceLevel8Choice": {
"type": "object",
"properties": {
"Cd": {
"type": "object",
"description": "Specifies a pre-agreed service or level of service between the parties, as published in an external service level code list.",
"allOf": [
{
"$ref": "#/$defs/Max4Text"
}
]
},
"Prtry": {
"type": "object",
"description": "Specifies a pre-agreed service or level of service between the parties, as a proprietary code.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Agreement under which or rules under which the transaction should be processed. Either code or proprietary field values should be sent in the request ."
},
"SettlementInstruction7": {
"required": [
"SttlmMtd"
],
"type": "object",
"properties": {
"SttlmMtd": {
"$ref": "#/$defs/SettlementMethod1Code"
},
"SttlmAcct": {
"type": "object",
"description": "A specific purpose account used to post debit and credit entries as a result of the transaction.",
"allOf": [
{
"$ref": "#/$defs/CashAccount38"
}
]
},
"ClrSys": {
"$ref": "#/$defs/ClearingSystemIdentification3Choice"
},
"InstgRmbrsmntAgt": {
"type": "object",
"description": "Agent through which the instructing agent will reimburse the instructed agent.",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
},
"InstgRmbrsmntAgtAcct": {
"type": "object",
"description": "Unambiguous identification of the account of the instructing reimbursement agent account at its servicing agent in the payment chain.",
"allOf": [
{
"$ref": "#/$defs/CashAccount38"
}
]
},
"InstdRmbrsmntAgt": {
"type": "object",
"description": "Agent at which the instructed agent will be reimbursed.",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
},
"InstdRmbrsmntAgtAcct": {
"type": "object",
"description": "Unambiguous identification of the account of the instructed reimbursement agent account at its servicing agent in the payment chain.",
"allOf": [
{
"$ref": "#/$defs/CashAccount38"
}
]
},
"ThrdRmbrsmntAgt": {
"type": "object",
"description": "Agent at which the instructed agent will be reimbursed.",
"allOf": [
{
"$ref": "#/$defs/BranchAndFinancialInstitutionIdentification6"
}
]
},
"ThrdRmbrsmntAgtAcct": {
"type": "object",
"description": "Unambiguous identification of the account of the third reimbursement agent account at its servicing agent in the payment chain.",
"allOf": [
{
"$ref": "#/$defs/CashAccount38"
}
]
}
},
"description": "Specifies the details on how the settlement of the original transaction(s) between the instructing agent and the instructed agent was completed."
},
"SettlementMethod1Code": {
"type": "string",
"description": "Method used to settle the (batch of) payment instructions.
INDA: Settlement is done by the agent instructed to execute a payment instruction.
INGA: Settlement is done by the agent instructing and forwarding the payment to the next party in the payment chain.
COVE: Settlement is done through a cover payment.
CLRG: Settlement is done through a payment clearing system.",
"enum": [
"INDA",
"INGA",
"COVE",
"CLRG"
]
},
"StructuredRegulatoryReporting3": {
"type": "object",
"properties": {
"Amt": {
"type": "object",
"description": "Amount of money to be reported for regulatory and statutory requirements.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"Cd": {
"type": "object",
"description": "Specifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.",
"allOf": [
{
"$ref": "#/$defs/Max10Text"
}
]
},
"Ctry": {
"type": "object",
"description": "Country related to the specified type of regulatory reporting details.",
"allOf": [
{
"$ref": "#/$defs/CountryCode"
}
]
},
"Dt": {
"type": "object",
"description": "Date related to the specified type of regulatory reporting details.",
"allOf": [
{
"$ref": "#/$defs/ISODate"
}
]
},
"Inf": {
"type": "array",
"description": "Additional details that cater for specific domestic regulatory requirements.",
"items": {
"$ref": "#/$defs/Max35Text"
}
},
"Tp": {
"type": "object",
"description": "Specifies the type of the information supplied in the regulatory reporting details.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
}
},
"StructuredRemittanceInformation16": {
"type": "object",
"properties": {
"AddtlRmtInf": {
"maxItems": 3,
"type": "array",
"description": "Additional information, in free text form, to complement the structured remittance information.",
"items": {
"$ref": "#/$defs/Max140Text"
}
},
"CdtrRefInf": {
"$ref": "#/$defs/CreditorReferenceInformation2"
},
"Invcee": {
"type": "object",
"description": "Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.",
"allOf": [
{
"$ref": "#/$defs/PartyIdentification135"
}
]
},
"Invcr": {
"type": "object",
"description": "Identification of the organization issuing the invoice, when it is different from the creditor or ultimate creditor.",
"allOf": [
{
"$ref": "#/$defs/PartyIdentification135"
}
]
},
"RfrdDocAmt": {
"$ref": "#/$defs/RemittanceAmount2"
},
"RfrdDocInf": {
"type": "array",
"description": "Provides the identification and the content of the referred document.",
"items": {
"$ref": "#/$defs/ReferredDocumentInformation7"
}
},
"TaxRmt": {
"$ref": "#/$defs/TaxInformation7"
},
"GrnshmtRmt": {
"$ref": "#/$defs/Garnishment3"
}
}
},
"SupplementaryData1": {
"required": [
"Envlp"
],
"type": "object",
"properties": {
"PlcAndNm": {
"maxLength": 350,
"minLength": 1,
"type": "string",
"description": "Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath."
},
"Envlp": {
"type": "string",
"description": "Technical element wrapping the supplementary data."
}
}
},
"TaxAmount2": {
"type": "object",
"properties": {
"Dtls": {
"type": "array",
"description": "Set of elements used to provide details on the tax period and amount.",
"items": {
"$ref": "#/$defs/TaxRecordDetails2"
}
},
"Rate": {
"maxLength": 11,
"type": "string",
"description": "Rate used to calculate the tax. The number of fractional digits in the rate should not be more than 10."
},
"TaxblBaseAmt": {
"type": "object",
"description": "Amount of money on which the tax is based.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"TtlAmt": {
"type": "object",
"description": "Total amount that is the result of the calculation of the tax for the record.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
}
},
"description": "Set of elements used to provide information on the amount of the tax record."
},
"TaxAmountAndType1": {
"required": [
"Amt"
],
"type": "object",
"properties": {
"Tp": {
"$ref": "#/$defs/TaxAmountType1Choice"
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
}
}
},
"TaxAmountType1Choice": {
"type": "object",
"properties": {
"Cd": {
"type": "object",
"description": "Specifies the nature, or use, of the amount in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.",
"allOf": [
{
"$ref": "#/$defs/Max4Text"
}
]
},
"Prtry": {
"type": "object",
"description": "Specifies type of amount, as a proprietary code.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Specifies the type of the amount. Either the `code` or the `proprietary` parameter should be passed in the request ."
},
"TaxAuthorisation1": {
"type": "object",
"properties": {
"Nm": {
"type": "object",
"description": "Name of the debtor or the debtor's authorized representative.",
"allOf": [
{
"$ref": "#/$defs/Max140Text"
}
]
},
"Titl": {
"type": "object",
"description": "Title or position of debtor or the debtor's authorized representative.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Details of the authorized tax paying party."
},
"TaxInformation7": {
"type": "object",
"properties": {
"Cdtr": {
"$ref": "#/$defs/TaxParty1"
},
"Dbtr": {
"$ref": "#/$defs/TaxParty2"
},
"UltmtDbtr": {
"type": "object",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.",
"allOf": [
{
"$ref": "#/$defs/TaxParty2"
}
]
},
"AdmstnZone": {
"type": "object",
"description": "Territorial part of a country to which the tax payment is related.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"RefNb": {
"type": "object",
"description": "Tax reference information that is specific to a taxing agency.",
"allOf": [
{
"$ref": "#/$defs/Max140Text"
}
]
},
"Mtd": {
"type": "object",
"description": "Method used to indicate the underlying business or how the tax is paid.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"TtlTaxblBaseAmt": {
"type": "object",
"description": "Total amount of money on which the tax is based.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"TtlTaxAmt": {
"type": "object",
"description": "Total amount of money as result of the calculation of the tax.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"Dt": {
"type": "object",
"description": "Date by which tax is due.",
"allOf": [
{
"$ref": "#/$defs/ISODate"
}
]
},
"SeqNb": {
"type": "object",
"description": "Sequential number of the tax report.",
"allOf": [
{
"$ref": "#/$defs/Number"
}
]
},
"Rcrd": {
"type": "array",
"description": "Record of tax details.",
"items": {
"$ref": "#/$defs/TaxRecord2"
}
}
},
"description": "Provides remittance information about a payment made for tax-related purposes."
},
"TaxInformation8": {
"type": "object",
"properties": {
"Cdtr": {
"$ref": "#/$defs/TaxParty1"
},
"Dbtr": {
"$ref": "#/$defs/TaxParty2"
},
"AdmstnZone": {
"type": "object",
"description": "Territorial part of a country to which the tax payment is related.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"RefNb": {
"type": "object",
"description": "Tax reference information that is specific to a taxing agency.",
"allOf": [
{
"$ref": "#/$defs/Max140Text"
}
]
},
"Mtd": {
"type": "object",
"description": "Method used to indicate the underlying business or how the tax is paid.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"TtlTaxblBaseAmt": {
"type": "object",
"description": "Total amount of money on which the tax is based.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"TtlTaxAmt": {
"type": "object",
"description": "Total amount of money as result of the calculation of the tax.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"Dt": {
"type": "object",
"description": "Date by which tax is due.",
"allOf": [
{
"$ref": "#/$defs/ISODate"
}
]
},
"SeqNb": {
"type": "object",
"description": "Sequential number of the tax report.",
"allOf": [
{
"$ref": "#/$defs/Number"
}
]
},
"Rcrd": {
"type": "array",
"description": "Record of tax details.",
"items": {
"$ref": "#/$defs/TaxRecord2"
}
}
},
"description": "Set of elements used to provide details on the tax."
},
"TaxParty1": {
"type": "object",
"properties": {
"RegnId": {
"type": "object",
"description": "Unique identification, as assigned by an organization, to identify a party.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"TaxId": {
"type": "object",
"description": "Tax identification number of the creditor.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"TaxTp": {
"type": "object",
"description": "Type of tax payer.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Party on the credit side of the transaction to which the tax applies."
},
"TaxParty2": {
"type": "object",
"properties": {
"Authstn": {
"$ref": "#/$defs/TaxAuthorisation1"
},
"RegnId": {
"type": "object",
"description": "Unique identification, as assigned by an organization, to identify a party.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"TaxId": {
"type": "object",
"description": "Tax identification number of the debtor.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"TaxTp": {
"type": "object",
"description": "Type of tax payer.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
}
},
"description": "Party on the debit side of the transaction to which the tax applies."
},
"TaxPeriod2": {
"type": "object",
"properties": {
"FrToDt": {
"$ref": "#/$defs/DatePeriodDetails"
},
"Tp": {
"$ref": "#/$defs/TaxRecordPeriod1Code"
},
"Yr": {
"type": "object",
"description": "Year related to the tax payment.",
"allOf": [
{
"$ref": "#/$defs/ISODate"
}
]
}
},
"description": "Set of elements used to provide details on the period of time related to the tax payment."
},
"TaxRecord2": {
"type": "object",
"properties": {
"Tp": {
"type": "object",
"description": "High level code to identify the type of tax details.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"Ctgy": {
"type": "object",
"description": "Specifies the tax code as published by the tax authority.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"CtgyDtls": {
"type": "object",
"description": "Provides further details of the category tax code.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"DbtrSts": {
"type": "object",
"description": "Code provided by local authority to identify the status of the party that has drawn up the settlement document.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"CertId": {
"type": "object",
"description": "Identification number of the tax report as assigned by the taxing authority.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"FrmsCd": {
"type": "object",
"description": "Identifies, in a coded form, on which template the tax report is to be provided.",
"allOf": [
{
"$ref": "#/$defs/Max35Text"
}
]
},
"Prd": {
"$ref": "#/$defs/TaxPeriod2"
},
"TaxAmt": {
"$ref": "#/$defs/TaxAmount2"
},
"AddtlInf": {
"type": "object",
"description": "Further details of the tax record.",
"allOf": [
{
"$ref": "#/$defs/Max140Text"
}
]
}
}
},
"TaxRecordDetails2": {
"required": [
"Amt"
],
"type": "object",
"properties": {
"Amt": {
"type": "object",
"description": "Underlying tax amount related to the specified period.",
"allOf": [
{
"$ref": "#/$defs/ActiveOrHistoricCurrencyAndAmount"
}
]
},
"Prd": {
"$ref": "#/$defs/TaxPeriod2"
}
}
},
"TaxRecordPeriod1Code": {
"type": "string",
"description": "Identification of the period related to the tax payment.
MM01: Tax is related to the first month of the period.
MM02: Tax is related to the second month of the period.
MM03: Tax is related to the third month of the period.
MM04: Tax is related to the fourth month of the period.
MM05: Tax is related to the fifth month of the period.
MM06: Tax is related to the sixth month of the period.
MM07: Tax is related to the seventh month of the period.
MM08: Tax is related to the eighth month of the period.
MM09: Tax is related to the ninth month of the period.
MM10: Tax is related to the tenth month of the period.
MM11: Tax is related to the eleventh month of the period.
MM12: Tax is related to the twelfth month of the period.
QTR1: Tax is related to the first quarter of the period.
QTR2: Tax is related to the second quarter of the period.
QTR3: Tax is related to the third quarter of the period.
QTR4: Tax is related to the fourth quarter of the period.
HLF1: Tax is related to the first half of the period.
HLF2: Tax is related to the second half of the period.",
"enum": [
"MM01",
"MM02",
"MM03",
"MM04",
"MM05",
"MM06",
"MM07",
"MM08",
"MM09",
"MM10",
"MM11",
"MM12",
"QTR1",
"QTR2",
"QTR3",
"QTR4",
"HLF1",
"HLF2"
]
}
}
}