Field Mapping for the TWIST Format

Note: We recommend you to refer the TWIST format in parallel while understanding the below mentioned tags. This will help you to understand how the tags are nested in the TWIST format.
The following table shows how each tag is mapped to a field for extracting data in the TWIST format:
Tag Name Table Field Comments
Twist - - -
header - - -
messageId
inReplyTo
sentBy
typedPartyId
partyId
partyIdType
partyName
creationTimestamp
expiryTimestamp
electronicStatement - - -
statementHeader - - -
stmtSender - - The sender person is derived from the SENDPER characteristic of the division to which the account belongs.
orgId
orgIdType
orgIdNum
industId
industIdType
industIdNum
name CI_​PER_​NAME ENTITY_​NAME The data is derived from the sender's record where NAME_​TYPE_​FLG='PRIM'.
legalName CI_​PER_​NAME ENTITY_​NAME The data is derived from the sender's record where NAME_​TYPE_​FLG='LGAL'.
contactInfo - - -
departmentName
email
fax
otherCommunication
channelCode
value
phoneNumber
postAddress - - -
addressIdentifier
Note: The field mapping is not done for these tags. The implementation team will have to map these tags to the appropriate fields.
postBox
floor
room
addressLine
streetName
Note: The field mapping is not done for these tags. The implementation team will have to map these tags to the appropriate fields.
buildingName
buildingNum
city CI_​PER CITY -
countrySubDivision - - -
code
name CI_​PER STATE -
country CI_​PER COUNTRY -
countryIdentification
code
name
postCode CI_​PER POSTAL -
prefMethod
individualContact - - -
name CI_​PER_​NAME ENTITY_​NAME The data is derived from the sender's contact person's record where NAME_​TYPE_​FLG='PRIM'.
stmtReceiver - - The receiver is derived from the account for which the bill is created. The system derives the person who is the main customer of the account.
orgId - - -
orgIdType
orgIdNum CI_​PER_​ID PER_​ID_​NBR The data is derived from the sender's record where ID_​TYPE_​CD='BIC'.
industId
industIdType
industIdNum
name CI_​PER_​NAME ENTITY_​NAME The data is derived from the receiver's record where NAME_​TYPE_​FLG='PRIM'.
legalName CI_​PER_​NAME ENTITY_​NAME The data is derived from the receiver's record where NAME_​TYPE_​FLG='LGAL'.
contactInfo - - -
departmentName
Note: The field mapping is not done for these tags. The implementation team will have to map these tags to the appropriate fields.
Email CI_​PER EMAILID -
fax CI_​PER_​PHONE COUNTRY_​CODE||PHONE The data is derived from the sender's contact person's record where PHONE_​TYPE_​CD='FAX'.
phone CI_​PER_​PHONE COUNTRY_​CODE||PHONE The data is derived from the sender's contact person's record where PHONE_​TYPE_​CD='BUS'.
otherCommunication
channelCode
value
phoneNumber
contactInfo - - -
postAddress - - -
addressIdentifier - - If the bill address source is set to PER, then the address type is set to Billing. However, if the bill address source is set to ACOV, then the address type is set to Override.
postBox
Note: The field mapping is not done for these tags. The implementation team will have to map these tags to the appropriate fields.
floor
room
addressLine CI_​PER ADDRESS 1 to ADDRESS 4 -
streetName
Note: The field mapping is not done for these tags. The implementation team will have to map these tags to the appropriate fields.
buildingName
buildingNum
city CI_​PER CITY -
countrySubDivision - - -
code
name CI_​PER STATE -
country CI_​PER COUNTRY -
countryIdentification
code
name
postCode CI_​PER POSTAL -
individualContact - - -
name CI_​PER_​NAME ENTITY_​NAME The data is derived from the receiver's contact person's record where NAME_​TYPE_​FLG='PRIM'.
orgId - - Depending on the value defined in the ORGORFI characteristic of the receiver, the data appears within the OrgId tag. If the value is set to ORG, the organization identification appears within the OrgId tag. However, if the value is set to FI, the financial institution identification appears within the OrgId tag.
orgIdNum CI_​PER_​ID PER_​ID_​NBR The data is derived from the receiver's record where ID_​TYPE_​CD='BIC'.
contactInfo - - -
phone CI_​PER_​PHONE COUNTRY_​CODE||PHONE The data is derived from the receiver's contact person's record where PHONE_​TYPE_​CD='BUS'.
fax CI_​PER_​PHONE COUNTRY_​CODE||PHONE The data is derived from the receiver's contact person's record where PHONE_​TYPE_​CD='FAX'.
Email CI_​PER EMAILID -
statement - - -
account - - -
accountLevel - - -
bban
iban CI_​ACCT_​NBR ACCT_​NBR The data is derived from the record where ACCT_​NBR_​TYPE_​CD='IBAN'.
statementStartDate - - Stores Bill Extraction From Date
statementEndDate - - Stores Bill Extraction To Date
statementProductionDate - - Stores Statement Creation Date and Time
statementStatus - - Stores Statement Status; Valid Values are - Original and Regenerated
accountName
domicileBankQualifier
domicileBankIdentifier CI_​PER_​ID PER_​ID_​NBR The data is derived from the account servicer person's record where ID_​TYPE_​CD='BIC'.
parentAccount
parentLevel
parentBankQualifier
parentBankIdentifier
parentAccountBBAN
compensationMethod - - The valid values are INVD, DEBTD, and DDBT.
debitAccount CI_​ACCT_​APAY EXT_​ACCT_​ID -
delayedDebitDate CI_​BILL APAY_​CRE_​DT -
settlementAdvice CI_​ACCT_​MSG - The data is derived from the record where BILL_​MSG_​TYPE_​FLG='S'.
accountBalanceCurrencyCode CI_​ACCT CURRENCY_​CD -
settlementCurrencyCode CI_​ACCT CURRENCY_​CD -
hostCurrencyCode CI_​CIS_​DIVISION BASE_​CURRENCY_​CD -
taxCalculationMethod - - -
taxRegionCode - - The data is derived from the TAXREG characteristic of the account.
taxRegionResident
bankContactName CI_​PER_​NAME ENTITY_​NAME The data is derived from the account servicer's contact person's record where NAME_​TYPE_​FLG='PRIM'.
bankContactPhone CI_​PER_​PHONE COUNTRY_​CODE||PHONE The data is derived from the account servicer's contact person's record where PHONE_​TYPE_​CD='BUS' or 'HOME'.
bankContactEmail CI_​PER EMAILID -
bankContactFax CI_​PER_​PHONE COUNTRY_​CODE||PHONE The data is derived from the account servicer's contact person's record where PHONE_​TYPE_​CD='BUS' or 'HOME'.
taxExplanation
taxReason
taxReasonCode
taxReasonExplanation
currencyTranslation - - -
originalCurrency CI_​BSEG_​CALC_​LN, CI_​BSEG_​CALC NVL(CI_​BSEG_​CALC_​LN.PRIC_​CCY_​CD, CI_​BSEG_​CALC.CURRENCY_​CD) -
targetCurrency CI_​BSEG_​CALC CURRENCY_​CD -
translationValue CI_​BSEG_​CALC_​LN EXCHRATE -
basis CI_​BSEG_​CALC CURRENCY_​CD -
compensation
compensationIdentifier
compensationValue
amount
currency
service - - -
bankServiceID CI_​BILL_​CHG PRICEITEM_​CD -
serviceDescription CI_​PRICEITEM_​L DESCR -
serviceType CI_​PRICEITEM_​REL MAX(PRICEITEM_​PAR_​CD) The data is derived from the record where the price item is associated with the parent price item using the PRICEITEM_​REL_​TYPE_​FLG='PROD'.
volume CI_​BSEG_​CALC_​LN BILL_​SQ -
pricingCurrencyCode CI_​BSEG_​CALC_​LN, CI_​BSEG_​CALC NVL(CI_​BSEG_​CALC_​LN.PRIC_​CCY_​CD, CI_​BSEG_​CALC.CURRENCY_​CD) -
unitPrice - - -
amount CI_​BSEG_​CALC_​LN VALUE_​AMT, PRICE_​AMT -
currency
currencyCode - - The data is derived from VALUE_​AMT or PRICE_​AMT.
priceMethod - - The method is derived. The valid values are - UPRC, FCHG, MCHG, MXRD, TIER and TPRC.
paymentMethod - - The payment method is derived. The valid values are FLAT, PVCH, INVS, and FREE.
originalChargePrice
amount
currency
originalChargeSettlement - - -
amount CI_​TXN_​CALC_​LN CALC_​AMT -
currency
currencyCode - - The data is derived from CALC_​AMT.
taxDetails - - -
taxRegion - - -
taxRegionNumber - - The data is derived from the TAXREG characteristic of the account.
taxRegionName - - The data is derived from the TAXREG characteristic of the account.
customerTaxId - - The data is derived from the TAXID characteristic of the account.
taxInvoiceNumber CI_​BILL BILL_​ID -
serviceDetail - - -
bankServiceId CI_​BILL_​CHG PRICEITEM_​CD -
serviceDescription CI_​PRICEITEM_​L DESCR -
originalCharge - - -
amount CI_​BSEG_​CALC_​LN CALC_​AMT Here, the amount is equal to the sum of service charge lines in the bill excluding the service charge lines with a tax distribution code (i.e. a distribution code where the TAXRATE characteristic is defined). The amount is expressed in the invoice currency of the account.
currency
currencyCode - - The data is derived based on the calculated amount.
taxCalculation - - -
hostCurCode CI_​CIS_​DIVISION BASE_​CURRENCY_​CD -
taxHostConversion - - This section is added multiple times in the statement when different tax distribution codes are used for the service.
taxableSvcChargeAmount
amount
currency
taxableServiceCharge - - -
amount CI_​BSEG_​CALC_​LN BASE_​AMT Here, the amount is equal to the sum of service charge lines with the same tax distribution code (i.e. a distribution code where the TAXRATE characteristic is defined). The amount is expressed in the invoice currency of the account. This calculated amount is used as a source for calculating the tax.
currencyCode - - The data is derived based on the calculated amount.
taxableSvcChargeHostAmount
amount
currency
taxableServiceChargeHost - - -
amount CI_​BSEG_​CALC_​LN BASE_​AMT Here, the amount is equal to the sum of service charge lines with the same tax distribution code (i.e. a distribution code where the TAXRATE characteristic is defined). The amount is expressed in the division's base currency.
currencyCode - - The data is derived based on the calculated amount.
totalTaxableSvcChargeHostAmount - - -
amount - - Here, the amount is equal to the sum of all taxable service charge lines. The amount is expressed in the division's base currency.
currency
currencyCode - - The data is derived based on the calculated amount.
taxCalculationList - - This section is added multiple times in the statement when different tax distribution codes are used for the service.
taxIdentificationNumber CI_​BSEG_​CALC_​LN DST_​ID -
taxIdentifierDescription CI_​DST_​CODE_​L DESCR -
taxIdentifierRate - - The data is derived from the TAXRATE characteristic of the distribution code.
taxIdentifierTotalTaxAmount - - -
amount CI_​BSEG_​CALC_​LN CALC_​AMT Here, the amount is equal to the sum of taxes charged due to the same tax distribution code. The amount is expressed in the division's base currency.
currency
currencyCode - - The data is derived based on the calculated amount.
totalTaxAmount - - -
amount CI_​BSEG_​CALC_​LN CALC_​AMT Here, the amount is equal to the sum total of all taxes charged to the receiver (i.e. customer). The amount is expressed in the division's base currency.
currency
currencyCode - - The data is derived based on the calculated amount.
settlementAmount - - -
amount CI_​BSEG_​CALC_​LN CALC_​AMT Here, the amount is equal to the sum total of all service charges and taxes billed to the receiver (i.e. customer). The amount is expressed in the invoice currency of the account.
currency
currencyCode - - The data is derived based on the calculated amount.
taxDueToRegion - - -
amount CI_​BSEG_​CALC_​LN CALC_​AMT Here, the amount is equal to the sum total of all taxes charged to the receiver (i.e. customer). The amount is expressed in the invoice currency of the account.
currency
currencyCode - - The data is derived based on the calculated amount.
serviceAdjustment - - -
serviceAdjustmentType
serviceAdjustmentDesc
Type CI_​ADJ_​TYPE ADJ_​TYPE_​CD -
description CI_​ADJ_​TYPE_​L DESCR -
serviceAdjustmentAmt - - -
amount CI_​FT CUR_​AMT -
currency
currencyCode - - The data is derived based on the calculated amount.
adjustmentErrorDate CI_​ADJ CRE_​DT -
serviceAdjustmentID CI_​ADJ ADJ_​ID -
newCharge - - -
amount CI_​FT CUR_​AMT -
currency
currencyCode - - The data is derived based on the calculated amount.