Type = Technical Guides, Technical Tools, What's New,; Topic = Multienterprise Information Network Tower (MINT), Technical Documentation,;Persona = Solution Designer, TraceLink Administrator, User, Orchestration Architect, Solution Partner, Technology Partner,; Orchestration = Manufacturing, Logistics, Commerce, Transportation, Clinical Supply,; Function = IT, Quality, Procurement,
Product transfer account adjustment response canonical guidelines
A Product Transfer Account Adjustment Response is the formal reply issued by a manufacturer or supplier to a previously submitted adjustment request, typically related to a chargeback claim from a wholesaler or distributor. This response confirms whether the requested financial adjustment—often submitted via a product transfer account adjustment transaction—has been approved, partially approved, or rejected, and provides explanations for any changes made.
| Canonical Element | Type Definition | Description | IDoc mapping | X12 mapping | EDIFACT mapping | |||||
|---|---|---|---|---|---|---|---|---|---|---|
| Canonical Element | – | JSon object type/root element. | – | – | – | |||||
| controlFileHeader | – | Canonical control file header to store data for control segments and envelopes of IDocs, and X12 and EDIFACT EDI messages. | – | – | – | |||||
| canonicalProductTransferAccountAdjustmentResponseHeader | – | Payload for canonical Product Transfer Account Adjustment Response message. | – | segment BRC | – | |||||
| processingFunctionTypeCode | string |
Processing function, transaction set purpose code. Valid values include:
|
– |
BRC01 =
Use Java call-out to enumeration lookup table CL_ProcessingFunctionTypeCode.txt |
– | |||||
| dateReported | string | Date of Response(Processing) to Product Transfer Account Adjustment date in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | BRC02 (Date) & BRC05 (Time) | – | |||||
| epochDateReported | integer | Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. | – | – | – | |||||
| ediMailBoxId | string | Edi mail box id | – | – | – | |||||
| isRegularVersion | boolean |
Denotes line items will be generated for all submitted chargeback lines, including accepted.
|
– | – | – | |||||
| transactionReferenceIdentifierList | array | Transaction references for Product Transfer Account Adjustment Response at header level that affects the entire message | – | segment BRC | – | |||||
| b2bTransactionIdentifierType | string |
Referenced document type. Valid values:
|
– |
BRC03 =
REF01 =
|
– | |||||
| b2bTransactionIdentifierValue | string | Document identifier for transaction referenced by b2bTransactionIdentifierType. | – |
BRC04 whenb2bTransactionIdentifierType = PRODUCTTRANSFERACCOUNTADJUSTMENTRESPONSE (Required) and ("CREDITMEMO" or "TRANSACTIONREFERENCE") REF02 whereb2bTransactionIdentifierType =
|
– | |||||
| transactionDate | string | Date of Response(Processing) to Product Transfer Account Adjustment date in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | – | – | |||||
| epochTransactionDate | integer | Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. | – | – | – | |||||
| lineItemNumber | string | Line item number in customer purchase order. Line item level only. | – | – | – | |||||
| transactionReferenceInformation | array | Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. | – | segment REF | – | |||||
| transactionReferenceType | string |
Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. HDA mapping. Valid values include:
|
– |
REF01 =
|
– | |||||
| transactionReferenceIdentifier | string | Transaction reference identifier value as defined by enumeration in transactionReferenceType. | – | REF02 | – | |||||
| description | string | Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). | – | – | – | |||||
| transactionReferenceDate | string | Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.. | – | – | – | |||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | |||||
| mpcDates | array | Dates relevant for Product Transfer Account Adjustment Response header. | – | – | – | |||||
| dateType | string | Date type at header level for price authorization in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. | – | – | – | |||||
| dateValue | string | Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields.. | – | – | – | |||||
| epochDateValue | integer | Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. | – | – | – | |||||
| timeZone | string | Time zone for referenced dates | – | – | – | |||||
| mpCurrency | array | Currency | – | segment CUR | – | |||||
| currencyCode | string | Currency Code. | – | CUR02 | – | |||||
| exchangeRateCurrencyCode | string | Exchange Rate Currency Code | – | – | – | |||||
| exchangeRate | string | Exchange Rate | – | – | – | |||||
| validityRate | string | Validity Date | – | – | – | |||||
| currencyEntityCode | string | Currency Entity Code | – | CUR01 | – | |||||
| chargeBackClaimResponse | array | Validation response to product transfer request at header level. | – |
Segment AAA Notes: Rejection codes listed as per HDA guideline, any missing of these in schema to be added manually. |
– | |||||
| responseCode | string |
Code indicating response. valid values:
|
– |
AAA01 =
|
– | |||||
| agencyCode | string |
Code identifying the agency assigning the code values, X12 pass through. The valid value is |
– | AAA02 | – | |||||
| rejectReasonCode | string |
Rejection reason code identifier, Valid values list include: as per HDA guideline and other healthcare partners.
|
– | AAA03 Use Java call-out to enumeration lookup table CL_RejectionReasonCode.txt | – | |||||
| followupActionCode | string |
Action code identifies consequent action has to be taken by receiver of this message. Valid values include: as per HDA guidelines
|
– | AAA04 Use Java call-out to enumeration lookup table CL_FollowupActionCode | – | |||||
| customerBusinessInformation | – | Customer or buyer party company identifiers and address information. | – | N101 = "BY" | – | |||||
| businessName | string | Business name for partner or location | – | N102 | – | |||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | |||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean | – | – | – | |||||
| companyIdentifierType | string |
Company identifier type for business partner, Valid values:
|
– | N103 Use Java call-out to enumeration lookup table CL_CompanyIdentifierType | – | |||||
| companyIdentifierValue | string | Company identifier value for business partner | – | N104 | – | |||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value | – | – | – | |||||
| address | – | Party address information | – | – | – | |||||
| address1 | string | Main street address | – | N301 | – | |||||
| address2 | string | Supplemental street address | – | N302 | – | |||||
| city | string | City | – | N401 | – | |||||
| district | string | District | – | – | – | |||||
| state | string | State or region code | – | N402 | – | |||||
| postalCode | string | Postal code | – | N403 | – | |||||
| country | string | Country code | – | N404 | – | |||||
| telephone | string | Telephone number | – | – | – | |||||
| fax | string | Fax number | – | – | – | |||||
| url | string | Website URL | – | – | – | |||||
| buildingNumber | string | Building number | – | – | – | |||||
| plantNumber | string | Plant number | – | – | – | |||||
| floorNumber | string | Floor number in building | – | – | – | |||||
| lscAddressIdentifier | string | LSC address identifier | – | – | – | |||||
| village | string | Village name | – | – | – | |||||
| houseNumber | string | House number | – | – | – | |||||
| township | string | Township | – | – | – | |||||
| premisesCode | string | Premises code | – | – | – | |||||
| companyLocationContactInformation | – | – | – | Hard code PER01 to "AJ" primary contact | – | |||||
| contactName | string | Contact name | – | PER02 | – | |||||
| contactTitle | string | Title of contact | – | – | – | |||||
| contactPhone | string | Contact phone number | – | PER04 where PER03 = "TE" | – | |||||
| contactEmail | string | Contact email address | – | PER06 where PER05 = "EM" | – | |||||
| shipToBusinessInformation | – | Ship to party company identifiers and address information. | – | N101 = "ST" | – | |||||
| businessPartyInformation | – | Contract party information. | – | N101 = "ST" | – | |||||
| businessName | string | Business name for partner or location | – | N102 | – | |||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | |||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean | – | – | – | |||||
| companyIdentifierType | string |
Company identifier type for business partner, Valid values:
|
– | N103 Use Java call-out to enumeration lookup table CL_CompanyIdentifierType | – | |||||
| companyIdentifierValue | string | Company identifier value for business partner | – | N104 | – | |||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value | – | – | – | |||||
| address | – | Party address information | – | – | – | |||||
| address1 | string | Main street address | – | N301 | – | |||||
| address2 | string | Supplemental street address | – | N302 | – | |||||
| city | string | City | – | N401 | – | |||||
| district | string | District | – | – | – | |||||
| state | string | State or region code | – | N402 | – | |||||
| postalCode | string | Postal code | – | N403 | – | |||||
| country | string | Country code | – | N404 | – | |||||
| telephone | string | Telephone number | – | – | – | |||||
| fax | string | Fax number | – | – | – | |||||
| url | string | Website URL | – | – | – | |||||
| buildingNumber | string | Building number | – | – | – | |||||
| plantNumber | string | Plant number | – | – | – | |||||
| floorNumber | string | Floor number in building | – | – | – | |||||
| lscAddressIdentifier | string | LSC address identifier | – | – | – | |||||
| village | string | Village name | – | – | – | |||||
| houseNumber | string | House number | – | – | – | |||||
| township | string | Township | – | – | – | |||||
| premisesCode | string | Premises code | – | – | – | |||||
| companyLocationContactInformation | – | – | – | Hard code PER01 to "AJ" primary contact | – | |||||
| contactName | string | Contact name | – | PER02 | – | |||||
| contactTitle | string | Title of contact | – | – | – | |||||
| contactPhone | string | Contact phone number | – | PER04 where PER03 = "TE" | – | |||||
| contactEmail | string | Contact email address | – | PER06 where PER05 = "EM" | – | |||||
| transactionReferenceInformation | array | Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. | – | loop N1-N3-N4-REF | – | |||||
| transactionReferenceType | string | Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. | – | – | – | |||||
| transactionReferenceIdentifier | string |
Transaction reference identifier value as defined by enum in transactionReferenceType. HDA: Contract header type code defining identifier/description in description attribute (REF03). |
– | – | – | |||||
| description | string | Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02) | – | – | – | |||||
| transactionReferenceDate | string | Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | – | – | |||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | |||||
| mpcDates | array | Dates relevant for inventory adjustment header | – | – | – | |||||
| dateType | string | Date type at header level for inventory balance in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. | – | – | – | |||||
| dateValue | string | Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. | – | – | – | |||||
| epochDateValue | integer |
Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. |
– | – | – | |||||
| timeZone | string | Time zone for referenced dates | – | – | – | |||||
| supplierBusinessInformation | Supplier party company identifiers and address information. | – | N101 = "SU" | – | ||||||
| businessName | string | Business name for partner or location | – | N102 | – | |||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | |||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean | – | – | – | |||||
| companyIdentifierType | string |
Company identifier type for business partner. Valid values:
|
– |
N103 Use Java call-out to enumeration lookup table CL_CompanyIdentifierType |
– | |||||
| companyIdentifierValue | string | Company identifier value for business partner | – | N104 | – | |||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value | – | – | – | |||||
| address | – | Party address information | – | – | – | |||||
| address1 | string | Main street address | – | N301 | – | |||||
| address2 | string | Supplemental street address | – | N302 | – | |||||
| city | string | City | – | N401 | – | |||||
| district | string | District | – | – | – | |||||
| state | string | State or region code | – | N402 | – | |||||
| postalCode | string | Postal code | – | N403 | – | |||||
| country | string | Country code | – | N404 | – | |||||
| telephone | string | Telephone number | – | – | – | |||||
| fax | string | Fax number | – | – | – | |||||
| url | string | Website URL | – | – | – | |||||
| buildingNumber | string | Building number | – | – | – | |||||
| plantNumber | string | Plant number | – | – | – | |||||
| floorNumber | string | Floor number in building | – | – | – | |||||
| lscAddressIdentifier | string | LSC address identifier | – | – | – | |||||
| village | string | Village name | – | – | – | |||||
| houseNumber | string | House number | – | – | – | |||||
| township | string | Township | – | – | – | |||||
| premisesCode | string | Premises code | – | – | – | |||||
| companyLocationContactInformation | – | – | – | Hard code PER01 to "AJ" primary contact | – | |||||
| contactName | string | Contact name | – | PER02 | – | |||||
| contactTitle | string | Title of contact | – | – | – | |||||
| contactPhone | string | Contact phone number | – | PER04 where PER03 = "TE" | – | |||||
| contactEmail | string | Contact email address | – | PER06 where PER05 = "EM" | – | |||||
| manufacturerBusinessInformation | – | Manufacturer company identifiers and address information. | – | N101 = "MF" | – | |||||
| businessName | string | Business name for partner or location | – | N102 | – | |||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | |||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean | – | – | – | |||||
| companyIdentifierType | string |
Company identifier type for business partner, Valid values:
|
– | N103 Use Java call-out to enumeration lookup table CL_CompanyIdentifierType | – | |||||
| companyIdentifierValue | string | Company identifier value for business partner | – | N104 | – | |||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value | – | – | – | |||||
| address | – | Party address information | – | – | – | |||||
| address1 | string | Main street address | – | N301 | – | |||||
| address2 | string | Supplemental street address | – | N302 | – | |||||
| city | string | City | – | N401 | – | |||||
| district | string | District | – | – | – | |||||
| state | string | State or region code | – | N402 | – | |||||
| postalCode | string | Postal code | – | N403 | – | |||||
| country | string | Country code | – | N404 | – | |||||
| telephone | string | Telephone number | – | – | – | |||||
| fax | string | Fax number | – | – | – | |||||
| url | string | Website URL | – | – | – | |||||
| buildingNumber | string | Building number | – | – | – | |||||
| plantNumber | string | Plant number | – | – | – | |||||
| floorNumber | string | Floor number in building | – | – | – | |||||
| lscAddressIdentifier | string | LSC address identifier | – | – | – | |||||
| village | string | Village name | – | – | – | |||||
| houseNumber | string | House number | – | – | – | |||||
| township | string | Township | – | – | – | |||||
| premisesCode | string | Premises code | – | – | – | |||||
| companyLocationContactInformation | – | – | – | Hard code PER01 to "AJ" primary contact | – | |||||
| contactName | string | Contact name | – | PER02 | – | |||||
| contactTitle | string | Title of contact | – | N/A | – | |||||
| contactPhone | string | Contact phone number | – | PER04 where PER03 = "TE" | – | |||||
| contactEmail | string | Contact email address | – | PER06 where PER05 = "EM" | – | |||||
| distributorBusinessInformation | – | Distributor party company identifiers and address information. | – | N101 = "DS" | – | |||||
| businessName | string | Business name for partner or location | – | N102 | – | |||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | |||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean | – | – | – | |||||
| companyIdentifierType | string |
Company identifier type for business partner. Valid values:
|
– | N103 Use Java call-out to enumeration lookup table CL_CompanyIdentifierType | – | |||||
| companyIdentifierValue | string | Company identifier value for business partner | – | N104 | – | |||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value | – | – | – | |||||
| address | – | Party address information | – | – | – | |||||
| address1 | string | Main street address | – | N301 | – | |||||
| address2 | string | Supplemental street address | – | N302 | – | |||||
| city | string | City | – | N401 | – | |||||
| district | string | District | – | – | – | |||||
| state | string | State or region code | – | N402 | – | |||||
| postalCode | string | Postal code | – | N403 | – | |||||
| country | string | Country code | – | N404 | – | |||||
| telephone | string | Telephone number | – | – | – | |||||
| fax | string | Fax number | – | – | – | |||||
| url | string | Website URL | – | – | – | |||||
| buildingNumber | string | Building number | – | – | – | |||||
| plantNumber | string | Plant number | – | – | – | |||||
| floorNumber | string | Floor number in building | – | – | – | |||||
| lscAddressIdentifier | string | LSC address identifier | – | – | – | |||||
| village | string | Village name | – | – | – | |||||
| houseNumber | string | House number | – | – | – | |||||
| township | string | Township | – | – | – | |||||
| premisesCode | string | Premises code | – | – | – | |||||
| companyLocationContactInformation | – | – | – | Hard code PER01 to "AJ" primary contact | – | |||||
| contactName | string | Contact name | – | PER02 | – | |||||
| contactTitle | string | Title of contact | – | – | ||||||
| contactPhone | string | Contact phone number | – | PER04 where PER03 = "TE" | – | |||||
| contactEmail | string | Contact email address | – | PER06 where PER05 = "EM" | – | |||||
| distributorBranchformation | – | Distributor branch location identifiers and address information. | – | N101 = "DB" | – | |||||
| businessName | string | Business name for partner or location | – | N102 | – | |||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | |||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean | – | – | – | |||||
| companyIdentifierType | string |
Company identifier type for business partner. Valid values:
|
– | N103 Use Java call-out to enumeration lookup table CL_CompanyIdentifierType | – | |||||
| companyIdentifierValue | string | Company identifier value for business partner | – | N104 | – | |||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value | – | – | – | |||||
| address | – | Party address information | – | – | – | |||||
| address1 | string | Main street address | – | N301 | – | |||||
| address2 | string | Supplemental street address | – | N302 | – | |||||
| city | string | City | – | N401 | – | |||||
| district | string | District | – | – | – | |||||
| state | string | State or region code | – | N402 | – | |||||
| postalCode | string | Postal code | – | N403 | – | |||||
| country | string | Country code | – | N404 | – | |||||
| telephone | string | Telephone number | – | – | – | |||||
| fax | string | Fax number | – | – | – | |||||
| url | string | Website URL | – | – | – | |||||
| buildingNumber | string | Building number | – | – | – | |||||
| plantNumber | string | Plant number | – | – | – | |||||
| floorNumber | string | Floor number in building | – | – | – | |||||
| lscAddressIdentifier | string | LSC address identifier | – | – | – | |||||
| village | string | Village name | – | – | – | |||||
| houseNumber | string | House number | – | – | – | |||||
| township | string | Township | – | – | – | |||||
| premisesCode | string | Premises code | – | – | – | |||||
| companyLocationContactInformation | – | – | – | Hard code PER01 to "AJ" primary contact | – | |||||
| contactName | string | Contact name | – | PER02 | – | |||||
| contactTitle | string | Title of contact | – | – | – | |||||
| contactPhone | string | Contact phone number | – | PER04 where PER03 = "TE" | – | |||||
| contactEmail | string | Contact email address | – | PER06 where PER05 = "EM" | – | |||||
| freeTextNote | array | Free text, instructions, notes, descriptions and other free text elements | – | – | – | |||||
| textReferenceCode | string | Text reference or subject code. Will map whatever is found. | – | – | – | |||||
| textFunctionCode | string | Text function code. Will map whatever is found. | – | – | – | |||||
| language | string | Language of free text | – | – | – | |||||
| textFormatCode | string | Format code for free text | – | – | – | |||||
| freeFormText | string | Free test string | – | – | – | |||||
| customFields | array | Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Header level. | – | – | – | |||||
| name | string | Name of mapped field. | – | – | – | |||||
| value | string | Value in named field. | – | – | – | |||||
| canonicalProductTransferAccountAdjustmentResponseItemDetails | array | Product transfer account adjustment response Item details. | – | segment CON in CON loop | – | |||||
| b2bTransactionIdentifierType | string |
Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. HDA mapping. Valid value is |
– | CON01 = VC (SUPPLIERCONTRACT) (Mandatory) | – | |||||
| b2bTransactionIdentifierValue | string |
Transaction reference identifier value as defined by enum in b2bTransactionIdentifierValue. HDA: Contract header type code defining identifier/description in description attribute (REF03). |
– | CON02 (Mandatory) | – | |||||
| contractStatusCode | string | Contract status code. Pass thru mapping. | – | CON03 (Mandatory) | – | |||||
| chargeBackClaimResponse | array | Validation response to product transfer request at contract level, and authorized followup action. | – |
segment CON- AAA Notes: Rejection codes listed as per HDA guideline, any missing of these in schema to be added manually. |
– | |||||
| responseCode | string |
Code indicating response. Valid values:
|
– |
AAA01 =
|
– | |||||
| agencyCode | string |
Code identifying the agency assigning the code values, X12 pass through. The valid value is |
– | AAA02 | – | |||||
| rejectReasonCode | string |
Rejection reason code identifier. Valid values list include: as per HDA guideline and other healthcare partners.
|
– | AAA03 Use Java call-out to enumeration lookup table CL_RejectionReasonCode.txt | – | |||||
| followupActionCode | string |
Action code identifies consequent action has to be taken by receiver of this message, valid values include: as per HDA guidelines
|
– | AAA04 Use Java call-out to enumeration lookup table CL_FollowupActionCode | – | |||||
| transactionReferenceInformation | array |
Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. |
– | segment CON-REF | – | |||||
| transactionReferenceType | string |
Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. HDA mapping. The valid value is |
– |
REF01 = C8 (CORRECTEDCONTRACT) Use Java call-out to enumeration lookup table CL_TransactionReferenceType |
– | |||||
| transactionReferenceIdentifier | string | Transaction reference identifier value as defined by enumeration in transactionReferenceType. | – | REF02 | – | |||||
| description | string | Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). | – | REF03 | – | |||||
| transactionReferenceDate | string | Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | – | – | |||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | |||||
| mpcDates | array | Dates relevant for contract. | – | segment CON-DTM | – | |||||
| dateType | string | Date type at item level for Product Transfer Account Adjustment Response in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. | – | – | – | |||||
| dateValue | string | Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. | – | – | – | |||||
| epochDateValue | integer |
Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. |
– | – | – | |||||
| timeZone | string | Time zone for referenced dates. | – | – | – | |||||
| billToBusinessInformation | – |
Bill to company identifiers and address information extended with reference and date type identifiers. HDA usage note: This N1 loop at the Detail Level in the CON loop is required to identify customers belonging to the buying group or individual parties involved in chargeback contract. |
– | segment CON-N1 | – | |||||
| businessPartyInformation | – | Bill to party company identifiers and address information. | – | N101 = "BT" | – | |||||
| businessName | string | Business name for partner or location | – | N102 | – | |||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | |||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | |||||
| companyIdentifierType | string |
Company identifier type for business partner. Valid values:
|
– | N103 Use Java call-out to enumeration lookup table CL_CompanyIdentifierType | – | |||||
| companyIdentifierValue | string | Company identifier value for business partner. | – | N104 | – | |||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value. | – | – | – | |||||
| address | – | Party address information. | – | – | – | |||||
| address1 | string | Main street address. | – | N301 | – | |||||
| address2 | string | Supplemental street address. | – | N302 | – | |||||
| city | string | City | – | N401 | – | |||||
| district | string | District | – | N/A | – | |||||
| state | string | State or region code | – | N402 | – | |||||
| postalCode | string | Postal code | – | N403 | – | |||||
| country | string | Country code | – | N404 | – | |||||
| telephone | string | Telephone number | – | – | – | |||||
| fax | string | Fax number | – | – | – | |||||
| url | string | Website URL | – | – | – | |||||
| buildingNumber | string | Building number | – | – | – | |||||
| plantNumber | string | Plant number | – | – | – | |||||
| floorNumber | string | Floor number in building | – | – | – | |||||
| lscAddressIdentifier | string | LSC address identifier | – | – | – | |||||
| village | string | Village name | – | – | – | |||||
| houseNumber | string | House number | – | – | – | |||||
| township | string | Township | – | – | – | |||||
| premisesCode | string | Premises code | – | – | – | |||||
| companyLocationContactInformation | – | – | – | – | – | |||||
| contactName | string | Contact name | – | – | – | |||||
| contactTitle | string | Title of contact | – | – | – | |||||
| contactPhone | string | Contact phone number | – | – | – | |||||
| contactEmail | string | Contact email address | – | – | – | |||||
| transactionReferenceInformation | array |
Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. HDA Description: This REF segment at the Detail Level in the CON/N1 loop is used in response to chargeback request to provide other information regarding the customers involved in reconciliation process including: Payer identification number (340 programs), DEA, Health industry number, GLN and Product line numbers. REF01 and REF02 must be present and in some instances, REF03 may be appropriate for description clarification. |
– | loop CON-N1-N3-N4-REF | – | |||||
| transactionReferenceType | string |
Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. HDA mapping. Valid values:
|
– |
REF01 =
Use Java call-out to enumeration lookup table CL_TransactionReferenceType |
– | |||||
| transactionReferenceIdentifier | string | Transaction reference identifier value as defined by enum in transactionReferenceType. | – | REF02 | – | |||||
| description | string |
Identifier or description defined by qualifier code in transactionReferenceIdentifier. HAD usage description: This element can contain any optional notes or comments pertaining to an original or resubmitted line on a chargeback. |
– | REF03 | – | |||||
| transactionReferenceDate | string | Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | – | ||||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | ||||||
| mpcDates | array | Dates relevant for contract party. | – | loop CON-N1-N3-N4-DTM | – | |||||
| dateType | string | Date type in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. | – | – | ||||||
| dateValue | string | Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. | – | – | ||||||
| epochDateValue | integer | Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. | – | – | ||||||
| timeZone | string | Time zone for referenced dates | – | – | ||||||
| shipToBusinessInformation | – |
Ship to location identifiers and address information extended with reference and date type identifiers. HDA usage note: This N1 loop at the Detail Level in the CON loop is required to identify customers belonging to the buying group or individual parties involved in chargeback contract |
– | segment CON-N1 | – | |||||
| businessPartyInformation | – | Ship to party company identifiers and address information. | – | N101 = "ST" | – | |||||
| businessName | string | Business name for partner or location | – | N102 | – | |||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | |||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean | – | – | – | |||||
| companyIdentifierType | string |
Company identifier type for business partner. Valid values:
|
– | N103Use Java call-out to enumeration lookup table CL_CompanyIdentifierType | – | |||||
| companyIdentifierValue | string | Company identifier value for business partner | – | N104 | – | |||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value | – | – | – | |||||
| address – | – | Party address information | – | – | – | |||||
| address1 | string | Main street address | – | N301 | – | |||||
| address2 | string | Supplemental street address | – | N302 | – | |||||
| city | string | City | – | N401 | – | |||||
| district | string | District | – | – | – | |||||
| state | string | State or region code | – | N402 | – | |||||
| postalCode | string | Postal code | – | N403 | – | |||||
| country | string | Country code | – | N404 | – | |||||
| telephone | string | Telephone number | – | – | – | |||||
| fax | string | Fax number | – | – | – | |||||
| url | string | Website URL | – | – | – | |||||
| buildingNumber | string | Building number | – | – | – | |||||
| plantNumber | string | Plant number | – | – | – | |||||
| floorNumber | string | Floor number in building | – | – | – | |||||
| lscAddressIdentifier | string | LSC address identifier | – | – | – | |||||
| village | string | Village name | – | – | – | |||||
| houseNumber | string | House number | – | – | – | |||||
| township | string | Township | – | – | – | |||||
| premisesCode | string | Premises code | – | – | – | |||||
| companyLocationContactInformation | – | – | – | – | – | |||||
| contactName | string | Contact name | – | – | – | |||||
| contactTitle | string | Title of contact | – | – | – | |||||
| contactPhone | string | Contact phone number | – | – | – | |||||
| contactEmail | string | Contact email address | – | – | – | |||||
| transactionReferenceInformation | array |
Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. HDA Description: This REF segment at the Detail Level in the CON/N1 loop is used in response to chargeback request to provide other information regarding the customers involved in reconciliation process including: Payer identification number (340 programs), DEA, Health industry number, GLN and Product line numbers. REF01 and REF02 must be present and in some instances, REF03 may be appropriate for description clarification. |
– | loop CON-N1-N3-N4-REF | – | |||||
| transactionReferenceType | string |
Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. HDA mapping. Valid values:
|
– |
REF01 =
Use Java call-out to enumeration lookup table CL_TransactionReferencType |
– | |||||
| transactionReferenceIdentifier | string | Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping. | – | REF02 | – | |||||
| description | string |
Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). HAD usage description: This element can contain any optional notes or comments pertaining to an original or resubmitted line on a chargeback. |
– | REF03 | – | |||||
| transactionReferenceDate | string | Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | – | – | |||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | |||||
| mpcDates | array | Dates relevant for contract party. | – | loop CON-N1-N3-N4-DTM | – | |||||
| dateType | string | Date type in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. | – | – | – | |||||
| dateValue | string | Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. | – | – | – | |||||
| epochDateValue | integer |
Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. |
– | – | – | |||||
| timeZone | string | Time zone for referenced dates. | – | – | – | |||||
| partnerBusinessInformation | Loop |
Partner business identifiers and address information extended with reference and date type identifiers. HDA usage note: This N1 loop at the Detail Level in the CON loop is required to identify customers belonging to the buying group or individual parties involved in chargeback contract. |
– | segment CON-N1 Loop | – | |||||
| businessPartyInformation | – | Ship to party company identifiers and address information. | – | N1 | – | |||||
| partnerEntityType | string |
Denotes type of the entity involved in this business transaction. The valid value is |
– | N101 Use java call-out table CL_PartnerEntityType.txt | – | |||||
| businessName | string | Business name for partner or location. | – | N102 | – | |||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | |||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | |||||
| companyIdentifierType | string |
Company identifier type for business partner. Valid values:
|
– | N103Use Java call-out to enumeration lookup table CL_CompanyIdentifierType | – | |||||
| companyIdentifierValue | string | Company identifier value for business partner | – | N104 | – | |||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value | – | – | – | |||||
| address | – | Party address information | – | – | – | |||||
| address1 | string | Main street address | – | N301 | – | |||||
| address2 | string | Supplemental street address | – | N302 | – | |||||
| city | string | City | – | N401 | – | |||||
| district | string | District | – | – | – | |||||
| state | string | State or region code | – | N402 | – | |||||
| postalCode | string | Postal code | – | N403 | – | |||||
| country | string | Country code | – | N404 | – | |||||
| telephone | string | Telephone number | – | – | – | |||||
| fax | string | Fax number | – | – | – | |||||
| url | string | Website URL | – | – | – | |||||
| buildingNumber | string | Building number | – | – | – | |||||
| plantNumber | string | Plant number | – | – | – | |||||
| floorNumber | string | Floor number in building | – | – | – | |||||
| lscAddressIdentifier | string | LSC address identifier | – | – | – | |||||
| village | string | Village name | – | – | – | |||||
| houseNumber | string | House number | – | – | – | |||||
| township | string | Township | – | – | – | |||||
| premisesCode | string | Premises code | – | – | – | |||||
| companyLocationContactInformation | – | – | – | – | – | |||||
| contactName | string | Contact name | – | – | – | |||||
| contactTitle | string | Title of contact | – | – | – | |||||
| contactPhone | string | Contact phone number | – | – | – | |||||
| contactEmail | string | Contact email address | – | – | – | |||||
| transactionReferenceInformation | array |
Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. HDA Description: This REF segment at the Detail Level in the CON/N1 loop is used in response to chargeback request to provide other information regarding the customers involved in reconciliation process including: Payer identification number (340 programs), DEA, Health industry number, GLN and Produc line numbers. REF01 and REF02 must be present and in some instances, REF03 may be appropriate for description clarification. |
– | loop CON-N1-N3-N4-REF | – | |||||
| transactionReferenceType | string |
Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. HDA mapping. Valid values:
|
– |
REF01 =
Use Java call-out to enumeration lookup table CL_TransactionReferencType |
– | |||||
| transactionReferenceIdentifier | string | Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping. | – | REF02 | – | |||||
| description | string |
Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). HAD usage description: This element can contain any optional notes or comments pertaining to an original or resubmitted line on a chargeback |
– | REF03 | – | |||||
| transactionReferenceDate | string | Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | – | – | |||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | |||||
| mpcDates | array | Dates relevant for contract party. | – | loop CON-N1-N3-N4-DTM | – | |||||
| dateType | string | Date type in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. | – | – | – | |||||
| dateValue | string | Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. | – | – | – | |||||
| epochDateValue | integer |
Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. |
– | – | – | |||||
| timeZone | string | Time zone for referenced dates | – | – | – | |||||
| distributorBusinessInformation | – |
Distributor party company identifiers and address information extended with dates and reference identifiers. HDA usage note: This N1 loop at the Detail Level in the CON loop is required to identify customers belonging to the buying group or individual parties involved in chargeback contract |
– | segment CON-N1 | – | |||||
| businessPartyInformation | – | Distributor group party information. | – | N101 = "DS" | – | |||||
| businessName | string | Business name for partner or location. | – | N102 | – | |||||
| mpcCompanyLocationIdentifierList | array | Identifier list for business party. | – | – | – | |||||
| isIdentifierPresentInEvent | boolean | Is identifier present in event boolean. | – | – | – | |||||
| companyIdentifierType | string |
Company identifier type for business partner, Valid values:
|
– | N103 Use Java call-out to enumeration lookup table CL_CompanyIdentifierType | – | |||||
| companyIdentifierValue | string | Company identifier value for business partner | – | N104 | – | |||||
| alternateCompanyLocationIdentifierValue | string | Alternate company location identifier value | – | – | – | |||||
| address | – | Party address information | – | – | – | |||||
| address1 | string | Main street address | – | N301 | – | |||||
| address2 | string | Supplemental street address | – | N302 | – | |||||
| city | string | City | – | N401 | – | |||||
| district | string | District | – | – | – | |||||
| state | string | State or region code | – | N402 | – | |||||
| postalCode | string | Postal code | – | N403 | – | |||||
| country | string | Country code | – | N404 | – | |||||
| telephone | string | Telephone number | – | – | – | |||||
| fax | string | Fax number | – | – | – | |||||
| url | string | Website URL | – | – | – | |||||
| buildingNumber | string | Building number | – | – | – | |||||
| plantNumber | string | Plant number | – | – | – | |||||
| floorNumber | string | Floor number in building | – | – | – | |||||
| lscAddressIdentifier | string | LSC address identifier | – | – | – | |||||
| village | string | Village name | – | – | – | |||||
| houseNumber | string | House number | – | – | – | |||||
| township | string | Township | – | – | – | |||||
| premisesCode | string | Premises code | – | – | – | |||||
| companyLocationContactInformation | – | – | – | – | – | |||||
| contactName | string | Contact name | – | – | – | |||||
| contactTitle | string | Title of contact | – | – | – | |||||
| contactPhone | string | Contact phone number | – | – | – | |||||
| contactEmail | string | Contact email address | – | – | – | |||||
| transactionReferenceInformation | array |
Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. HDA Description: This REF segment at the Detail Level in the CON/N1 loop is used in response to chargeback request to provide other information regarding the customers involved in reconciliation process including: Payer identification number (340 programs), DEA, Health industry number, GLN and Product line numbers. REF01 and REF02 must be present and in some instances, REF03 may be appropriate for description clarification. |
– | loop CON-N1-N3-N4-REF | – | |||||
| transactionReferenceType | string |
Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. HDA mapping. Valid values:
|
– |
REF01 =
Use Java call-out to enumeration lookup table CL_TransactionReferencType |
– | |||||
| transactionReferenceIdentifier | string | Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping. | – | REF02 | – | |||||
| description | string |
Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). HAD usage description: This element can contain any optional notes or comments pertaining to an original or resubmitted line on a chargeback |
– | REF03 | – | |||||
| transactionReferenceDate | string | Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | – | – | |||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | |||||
| mpcDates | array | Dates relevant for contract party. | – | loop CON-N1-N3-N4-DTM | – | |||||
| dateType | string | Date type in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. | – | – | – | |||||
| dateValue | string | Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. | – | – | – | |||||
| epochDateValue | integer |
Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. |
– | – | – | |||||
| timeZone | string | Time zone for referenced dates. | – | – | – | |||||
| productAdjustmentDetails | array | Product adjustment details. | – | segment loop CON-PAD | – | |||||
| lineItemNumber | string |
Line item number for canonicalProductTransferAccountAdjustmentResponseItemDetails. Sequential number that begins with 1 and is incremented with each loop of the product adjustment details array. The line item number restarts and resets to 1 for each new loop of the canonicalProductTransferAccountAdjustmentResponseItemDetails array. |
– | PAD01 | – | |||||
| productTransferTypeCode | string | Product transfer type code. X12 pass thru mapping. | – | PAD02 | – | |||||
| adjustmentTypeCode | string | Change or reponse type code specifying the type of change recorded in the product adjustment details loop. | – | – | ||||||
| productCodesIdentifiers | array | Product code identifier types and values. Only one instance of productCodesIdentifiers per productAdjustmentDetails loop. | – | – | ||||||
| productCodeType | string |
Code to qualify product identifier type. Valid values include:
|
– | LIN02 Use Java call-out to enumeration lookup table CL_ProductCodeType.txt | – | |||||
| productCodeValue | string | Product code identifier value. | – | LIN03 | – | |||||
| chargeBackClaimResponse | array | Validation response to product transfer request at product adjustment level. | – | segment loop CON-PAD-AAA | – | |||||
| responseCode | string |
Code indicating response, The valid values:
|
– |
AAA01 =
|
– | |||||
| agencyCode | string |
Code identifying the agency assigning the code values, X12 pass through. The valid value is |
– | AAA02 | – | |||||
| rejectReasonCode | string |
Rejection reason code identifier. Valid values list include: as per HDA guideline and other healthcare partners.
|
– | AAA03 Use Java call-out to enumeration lookup table CL_RejectionReasonCode.txt | – | |||||
| followupActionCode | string |
Action code identifies consequent action has to be taken by receiver of this message, Valid values include as per HDA guidelines:
|
– | AAA04 Use Java call-out to enumeration lookup table CL_FollowupActionCode | – | |||||
| unitDetailInformation | array |
Specifies item unit details of a contract that is being requested / corrected in response. HDA usage note: Four occurrences of this segment at the detail level in the productAdjustmentDetails loop are required to add an item in a response to chargeback request:to specify the contract price, submitted contract price, whole sale price and submittted wholesale price. |
– | segment loop CON-PAD-UIT | – | |||||
| unitOfMeasure | string |
Unit of measure for recorded product in adjustment. Valid values include:
|
– |
UIT01 =
Use Java call-out to enumeration lookup table UOM_TableLookup2.txt |
– | |||||
| itemUnitPrice | number | Unit price for product | – | UIT02 | – | |||||
| unitPriceTypeCode | string |
Code identifying the type of unit price. Valid values include:
|
– |
UIT03 =
|
– | |||||
| adjustmentQuantity | array |
Quantity of item in response to chargeback claim. Notes: Rebate returns are indicated by negative values in the QTY and AMT segments. |
– | segment loop CON-PAD-QTY | – | |||||
| quantityType | string |
Type of quantity recorded. Valid value:
|
– |
QTY01 =
Use Java call-out to enumeration lookup table CL_QuantityType.txt |
– | |||||
| quantityValue | number | Quantity of product required for planning. | – | QTY02 | – | |||||
| unitOfMeasure | string |
Unit or Basis for Measurement Code. Unit of entry UOM's include:
|
– | QTY03 Use Java call-out to enumeration lookup table UOM_TableLookup2.txt | – | |||||
| productAdjustmentClaimAmount | array |
Amount claimed for chargeback request or response. HDA Notes: The AMT segment is to be used only in cases where the amount cannot be computed from other detail. Submitted chargeback claim amount is equal to the value of the chargeback claim amount at the summary level in the canonical productTransferAccountRequest — which was submitted by the distributor to the manufacturer. Adjusted chargeback claim amount is equal to the value of the credit memo issued by the manufacturer. |
– | segment loop CON-PAD-AMT | – | |||||
| pricingType | string |
Pricing type for invoice item. Valid value:
|
– |
AMT01 =
|
– | |||||
| pricingAmount | string | Net or extended price claimed for return including total disbursements, plus interest and minus deductions from claim. | – | AMT02 | – | |||||
| isCreditOrDebit | boolean |
Credit or debit boolean. Only populated if identified. HDA optional value. Valid values:
|
– | AMT03 = C (true) D (false) | – | |||||
| mpcDates | array |
Dates relevant for product adjustment item. Optional segment. HDA usage description: This date segment at the detail level in the canonical productAdjustmentDetails array (X12CON/PAD loop) is only used to provide the item Invoiced and PO Received date. |
– | loop CON-PAD-DTM | – | |||||
| dateType | string |
Date type at item level for responsed to chargeback request in date format YYYYMMDD and time format (IDoc, X12) HHMMSS. Valid values:
|
– |
DTM01 =
|
– | |||||
| dateValue | string |
Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. HAD Note: Since product transfer account adjustment request can be sent to a manufacturer again when a distributor customer is re-billed due to a contract price discrepancy, it is strongly recommended that this date be based on the original sale date, not the invoice date. |
– | DTM02 | – | |||||
| epochDateValue | integer | Date defined by referenced date type generated in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. | – | – | – | |||||
| timeZone | string | Time zone for referenced dates. | – | – | – | |||||
| transactionReferenceInformation | array |
Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents. HDA Description: This REF segment at the Detail Level in the CON/PAD loop is used to provide other references information regarding to chargeback related transactions involved in reconciliation process including: Transaction type, Distributor invoice number Produce line number..etc. REF01 and REF02 must be present and in some instances, REF03 may be appropriate for description clarification. |
– |
loop CON-PAD-REFNotes: if REF01 =8X then transaction type REF02 will replace BRC01 REF02 =
|
– | |||||
| transactionReferenceType | string |
Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. HDA mapping. Valid values include:
|
– |
REF01 =
LIN01 when transactionReferenceType = LINEITEMNUMBER Use Java call-out to enumeration lookup table CL_TransactionReferenceType |
– | |||||
| transactionReferenceIdentifier | string | Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping. | – | REF02 | – | |||||
| description | string | Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). HAD usage description: This element can contain any optional notes or comments pertaining to an original or resubmitted line on a chargeback. | – | REF03 | – | |||||
| transactionReferenceDate | string | Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. | – | – | – | |||||
| epochTransactionReferenceDate | integer | Transaction reference date and time in EPOCH date time format. | – | – | – | |||||
| freeTextNote | array | Free text, instructions, notes, descriptions and other free text elements. | – | – | – | |||||
| textReferenceCode | string | Text reference or subject code. Will map whatever is found. | – | – | – | |||||
| textFunctionCode | string | Text function code. Will map whatever is found. | – | – | – | |||||
| language | string | Language of free text | – | – | – | |||||
| textFormatCode | string | Format code for free text | – | – | – | |||||
| freeFormText | string | Free test string | – | – | – | |||||
| customFields | array | Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. | – | – | – | |||||
| name | string | Name of mapped field. | – | – | – | |||||
| value | string | Value in named field. | – | – | – | |||||
| canonicalProductTransferAccountAdjustmentClaimAmounts | array |
Amount claimed for chargeback request or response summary level. HDA Notes: The AMT segment is to be used only in cases where the amount cannot be computed from other detail. Submitted chargeback claim Amount is equal to the value of the chargeback claim amount at the Summary level in the Product Transfer Account Adjustment Response — which was submitted by the distributor to the manufacturer. Adjusted chargeback claim Amount is equal to the value of the credit memo issued by the manufacturer. |
– | segment loop AMT | – | |||||
| pricingType | string |
Pricing type for invoice item. Valid value:
|
– |
AMT01 =
|
– | |||||
| pricingAmount | string | Net or extended price claimed for return including total disbursements, plus interest and minus deductions from claim.. | – | AMT02 | – | |||||
| isCreditOrDebit | boolean |
Credit or debit boolean. Only populated if identified. HDA optional value. Valid values:
|
– |
AMT03 =
|
– | |||||
| canonicalProductTransferAccountAdjustmentResponseSummary | array | Summary totals for Product Transfer Account Adjustment Response. | – | CTT | – | |||||
| summaryType | string |
Summary type for Product Transfer Account Adjustment Response. Number of line items. The valid
value is |
– | CTT01 | – | |||||
| summaryValue | string | Summary value. | – | CTT02 | – | |||||
| summaryValueUnit | string | Summary value unit of measure. | – | CTT04 | – | |||||
| customFields | array | Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. | – | – | – | |||||
| name | string | Name of mapped field. | – | – | – | |||||
| value | string | Value in named field. | – | – | – | |||||
Tag end


