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