Product transfer account adjustment request canonical guidelines

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.

–

canonicalProductTransferAccountAdjustmentRequestHeader

Payload for canonical product transfer account adjustment request message.

–

segment BAA

processingFunctionTypeCode

string

Processing function, transaction set purpose code. Valid values include: - ORIGINAL = Original - REPLACE = Replace existing account request from distributor to manufacturer - RESEND = Resend previous account request from distributor to manufacturer - REISSUE = Resend previous account request from distributor to manufacturer - CORRECTEDVERIFIED = Distributor request to manufacturer to verify and correct chargeback request - FOLLOWUP = Followup transaction, A second or subsequent transmission of the transaction set when an expected response has not yet been received

–

BAA01 00 = ORIGINAL 05 = REPLACE 15 = RESEND 18 = REISSUE 41 = CORRECTEDVERIFIED 45 = FOLLOWUP

adjustmentReferenceType

string

Adjustment transaction type code. Valid values include: - CREDITMEMO = Credit Memo - DEBITMEMO = Debit Memo - CREDITREQUEST = Credit request - DUPLICATE = Duplicate adjustment reference - QUOTEREQUEST = Price quote adjustment request

–

BAA02 CR = CREDITMEMO DR = DEBITMEMO RA = CREDITREQUEST DU = DUPLICATE RC = QUOTEREQUEST

dateOfAdjustment

string

Account Adjustment Date

–

BAA03

epochDateOfAdjustment

integer

Product Transfer Account request date of adjustment request. SAP pass thru mapping.

–

ediMailBoxId

string

Edi mail box id

–

transactionReferenceIdentifierList

array

Transaction references for Product Transfer request Adjustment at header level that affects the entire message

–

segment BAA

b2bTransactionIdentifierType

string

Referenced document type. Valid values: - ADJUSTMENTMEMO = Chargeback adjustment memo - REBATENUMBER = Chargeback rebate - CREDITDEBITADJUSTMENT = Chargeback credit debit adjustment - PREVIOUSCREDITDEBITADJUSTMENT = Previous credit and debit adjustment - BUYERDEBITMEMO = Buysers Debit Memo - DEBITMEMO = Debit Memo - PRODUCTTRANSFERACCOUNTADJUSTMENTREQUEST

–

BAA04 = AM (ADJUSTMENTMEMO)or RY (REBATENUMBER) or 1X (CREDITDEBITADJUSTMENT) or C9 (PREVIOUSCREDITDEBITADJUSTMENT) or DB (BUYERDEBITMEMO) or DL (DEBITMEMO) or PRODUCTTRANSFERACCOUNTADJUSTMENTREQUEST

b2bTransactionIdentifierValue

string

Document identifier for transaction referenced by b2bTransactionIdentifierType.

–

BAA05

transactionDate

string

Date transaction created

–

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.

–

transactionReferenceInformation

array

Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF for information other than transaction documents.

–

segment REF

transactionReferenceType

string

Transaction reference type for X12 segments REF for general reference data that is not a transaction document identifier. HDA mapping. Valid values include: - RESUBMITNUMBER - Identifier for resubmission request

–

REF01 = RX (RESUBMITNUMBER)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType.

–

REF02

description

string

Identifier or description defined by qualifier code in transactionReferenceIdentifier

–

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 request at header

–

dateType

string

Date type at header level for product transfer account adjustment request 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

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

–

N103 Usa Java call out

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

–

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"

purchasingGroupInformation

Purchasing Group party company identifiers and address information.

–

N101 = "BG"

businessPartyInformation

Purchasing group party information.

–

N101 = "BG"

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

–

N103 Usa Java call out

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 REF segments.

–

transactionReferenceType

string

Transaction reference type for N9 X12 segments for general reference data that is not a transaction document identifier. HDA mapping.

–

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

description

string

Identifier or description defined by qualifier code in transactionReferenceIdentifier.

–

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.

–

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

–

N103 Use java call out

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

–

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

–

N103 use java call out

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"

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

–

N103 use java call out

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"

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

–

N103 Use java call out

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

–

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"

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.

–

canonicalProductTransferAccountAdjustmentRequestItemDetails

array

Product Transfer account adjustment request Item details.

–

segment CON in CON loop

lineItemNumber

string

Line item number.

–

N/A

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 values include: - SUPPLIERCONTRACT - Supplier / Vendor contract Number

–

CON01 = VC (SUPPLIERCONTRACT) (Mandatory)

b2bTransactionIdentifierValue

string

Transaction reference identifier value as defined by enum in transactionReferenceType.

–

CON02 (Mandatory)

adjustmentContractStatusCode

string

Contract status code. Valid values include: - VALIDOPEN - Valid Open Contract - MODIFIED - Contract modified - RENEWED - Contract Renewed - EXPIRED - Contract Expired - INACTIVE - Inactive contract - INVALID - Contract Invalid - ORIGINAL - Original Contract - PROPOSED - Proposed contract - REISSUE - Contract reissued - RESTRICTED - Restrcited contract - REOPENED - Reopened contract - TERMINATED - Contract terminated

–

CON03 = VA (VALIDOPEN) or CM (MODIFIED) or CR (RENEWED) or EX (EXPIRED) or IA (INACTIVE) or IN (INVALID) or OC (ORIGINAL) or PR (PROPOSED) or RA (REISSUE) or RC (RESTRICTED) or RO (REOPENED) or TA (TERMINATED)

contractStatusCode

string

Contract status code. X12 Pass through Mapping

–

CON03

previousTransactionIdentifier

string

Previous transaction identiifier, typically the previous contract number.

–

transactionReferenceInformation

array

Reference information for identifiers that are not related to transaction documents. This group would map to X12 REF segments.

–

loop CON-N1-N3-N4-REF

transactionReferenceType

string

Transaction reference type for N9 X12 segments for general reference data that is not a transaction document identifier. HDA mapping. Valid values include: - LETTERS - Letters or Notes

–

REF01 = L1 (LETTERS)

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)

–

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 product transfer account adjustment request at item level

–

dateType

string

Date type at item level for product transfer account adjustment request 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

–

customerPartyInformation

Customer or buyer party company identifiers and address information extended with reference identifiers and dates. HDA usage note: This N1 loop at the Detail Level in the CON loop is required to identify eligible customers belonging to the buying group or individual parties eligible for the contract.

–

N101 = "BY"

businessPartyInformation

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

–

N103 Use java call out

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

–

transactionReferenceIdentifierList

array

Transaction references for Product Transfer request Adjustment at header level that affects the entire message

–

segment REF (loop CON-N1-N3-N4-REF)

b2bTransactionIdentifierType

string

Transaction reference type for N9 X12 segments for general reference data that is not a transaction document identifier. HDA mapping. Valid values include: - PURCHASEORDER - Purchase Order Number

–

REF01 = PO (PURCHASEORDER)

b2bTransactionIdentifierValue

string

Document identifier for transaction referenced by b2bTransactionIdentifierType.

–

REF02

transactionDate

string

Date transaction created

–

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.

–

transactionReferenceInformation

array

Reference information for identifiers that are not related to transaction documents. This group would map to X12 REF segments. HDA Description: This REF segment at the Detail Level in the CON/N1 loop is used in the bid award/change to provide other information regarding the customers eligible for the contract including: previous identifiers, trade classification(s), GPO membership IDs, and account class codes. REF01 and REF02 must be present and in some instances, REF03 may be appropriate for description clarification.

–

segment REF (loop CON-N1-N3-N4-REF)

transactionReferenceType

string

Transaction reference type for N9 X12 segments for general reference data that is not a transaction document identifier. HDA mapping. Valid values include: - PAYERIDENTIFIER - Payer Identification Number used for covered entity - DEA - Drug Enforcement Administration Number - HIN - Health Industry Number (HIN) - LETTERS - Letters or Notes - LOCATIONIDENTIFIER - GS1-US Global Location Number (GLN) - PRODUCTLINENUMBER - Product Line Number - SECONDARYTRADECLASS - PRIMARYCLASS

–

REF01 = 2U (PAYERIDENTIFIER) or DH (DEA) or HI (HIN) or L1 (LETTERS) or LU (LOCATIONIDENTIFIER) or X8 (SECONDARYTRADECLASS) or ACD (PRIMARYCLASS) or P7 (PRODUCTLINENUMBER) use java call out.

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping. HDA usage description: Class of Trade List: When REF01 = ACD, primary class of trade codes and descriptions will be mapped in REF02 and REF03. Also, note that since a REF segment is being used, trading partners are not restricted to using only the codes and descriptions listed below. Trading partners may elect to add/replace primary class of trade codes and descriptions agreed to by both partners to further meet requirements.

–

REF02

description

string

Identifier or description defined by qualifier code in transactionReferenceIdentifier. HDA Notes: 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.

–

salesItemInformation

array

To specify line item information related to a sale of an item.

–

segment loop CON-N1-SII

productCodesIdentifiers

Product code identifier types and values. Only one instance of productCodesIdentifiers per productAdjustmentDetails loop.

–

segment loop CON-N1-SII

productCodeType

string

Code to qualify product identifier type.

Valid values include:

CUSTOMER
GTIN12
GTIN13
GTIN14
CASEUPC
PACKAGEUPC
VENDORCATALOG
PC -US_NDC442
US_NDC532
US_NDC541
US_NDC542
US_NHRIC55
US_NHRIC64
US_NHRIC
US_NDC

–

SII01 = VC (VENDORCATALOG) or UI (PACKAGEUPC) or UP (UPC) or EN (GTIN13) UK (GTIN14) or UA (CASEUPC) or N1 (US_NDC442) or N2 (US_NDC532) or N3 (US_NDC541) or N4 (US_NDC542) or N5 (US_NHRIC55) or N6 (US_NHRIC64) or NH (US_NHRIC) or BP (CUSTOMER) or ND (US_NDC) Use Java call out.

productCodeValue

string

Product code identifier value

–

SII02

itemQuantity

Quantity of item in sales item information

–

segment loop CON-N1-SII

quantityType

string

Type of quantity recorded.

–

quantityValue

number

Quantity of product required for planning

–

SII03

unitOfMeasure

string

Composite Unit or Basis for Measurement Code. Unit of entry UOM's include: CA = Case CP = Crate EA = Each PC = Piece UN = Unit

–

SII04-01 = UN (UN) or EA (EA) or CA (CA) Use java lookup

salesUnitDetailInformation

array

Specifies item unit details for an initial bid award or a subsequent bid award/change.

–

segment loop CON-N1-SII

unitOfMeasure

string

Unit of measure for recorded product in adjustment. Valid values include: - UN (HDA) - EA - CA

–

unitPriceTypeCode

string

Code identifying the type of unit price. Valid values include: - CONTRACT - WHOLESALE

–

itemUnitPrice

number

Unit price for product

–

SII05 (where unitPriceTypeCode = WHOLESALE) SII06 (where unitPriceTypeCode = CONTRACT)

adjustmentAmount

number

Chargeback claim amount deals with extended rebate amount

–

SII07

extendedTransactionReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents. HDA Description: If 8X is used, it will override BAA01. Designates transaction type in N907-04. It can house either letters/notes or the chargeback line number but not both. If ZZ is used in N907-03, include Invoice Date at header. Transaction types will be look like as follows: If 8X is used in N907-03, use below for BAA01 at header: '00' for original '15' for resubmission '18' for credit/rebill with original '41' for credit/rebill with no original

–

loop CON-N1-SII-N9

salesItemReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping. Valid values include: - DISTRIBUTORINVOICE - Distributor Invoice Number

–

N901 = DI (DISTRIBUTORINVOICE)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N902

description

string

Identifier or description defined by qualifier code in transactionReferenceIdentifier, widely used for Order date references as per HAD usage guideline.

–

N903

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. HAD Usage: This date must be the original date of sale rather than the invoice date because an 844 can be sent to a manufacturer more than once.

–

N904

epochTransactionReferenceDate

integer

Transaction reference date and time in EPOCH date time format.

–

salesItemLotNumberReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping. Valid values include: - LOTNUMBER - Manufacturer's batch / Lot Number

–

N907.01 or N907.03 or N907.05 = LT (LOTNUMBER)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01. N907.04, when transactionReferenceType maps to N907.03. N907.06, when transactionReferenceType maps to N907.05.

salesItemProductLineReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping. Valid values include: - PRODUCTLINENUMBER - Product Line Number

–

N907.01, N907.03, N907.05 = P7 (PRODUCTLINENUMBER)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01. N907.04, when transactionReferenceType maps to N907.03. N907.06, when transactionReferenceType maps to N907.05.

salesItemLettersReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping. Valid values include: - LETTERS - Letters and Notes

–

N907.01, N907.03, N907.05 = L1 (LETTERS)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01. N907.04, when transactionReferenceType maps to N907.03. N907.06, when transactionReferenceType maps to N907.05.

salesItemSerialNumberReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping. Valid values include: - SERIALNUMBER - Manufacturer's serialized GTIN

–

N907.01, N907.03, N907.05 = SE (SERIALNUMBER)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01. N907.04, when transactionReferenceType maps to N907.03. N907.06, when transactionReferenceType maps to N907.05.

salesItemTransactionReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping. Valid values include: - TRANSACTIONTYPE - Transaction Category

–

N907.01, N907.03, N907.05 = 8X (TRANSACTIONTYPE)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01. N907.04, when transactionReferenceType maps to N907.03. N907.06, when transactionReferenceType maps to N907.05.

salesItemMutuallyDefinedReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping. Valid values include: - CUSTOM - Mutually Defined

–

N907.01, N907.03, N907.05 = ZZ (CUSTOM)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01. N907.04, when transactionReferenceType maps to N907.03. N907.06, when transactionReferenceType maps to N907.05.

purchasingGroupInformation

Purchasing Group Party company identifiers and address information extended with reference identifiers and dates. HDA usage note: This N1 loop at the Detail Level in the CON loop is required to identify eligible customers belonging to the buying group or individual parties eligible for the contract.

–

N101 = "BG"

businessPartyInformation

Purchasing Group Party company identifiers and address information.

–

N101 = "BG"

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

–

N103 Use java call out

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

–

transactionReferenceIdentifierList

array

Transaction references for Product Transfer request Adjustment at header level that affects the entire message

–

segment REF (loop CON-N1-N3-N4-REF)

b2bTransactionIdentifierType

string

Transaction reference type for N9 X12 segments for general reference data that is not a transaction document identifier. HDA mapping.

The valid value is PURCHASEORDER - Purchase Order Number

–

REF01 = PO (PURCHASEORDER)

b2bTransactionIdentifierValue

string

Document identifier for transaction referenced by b2bTransactionIdentifierType.

–

REF02

transactionDate

string

Date transaction created

–

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.

–

transactionReferenceInformation

array

Reference information for identifiers that are not related to transaction documents.

This group would map to X12 REF segments. HDA Description: This REF segment at the Detail Level in the CON/N1 loop is used in the bid award/change to provide other information regarding the customers eligible for the contract including: previous identifiers, trade classification(s), GPO membership IDs, and account class codes. REF01 and REF02 must be present and in some instances, REF03 may be appropriate for description clarification.

–

segment REF (loop CON-N1-N3-N4-REF)

transactionReferenceType

string

Transaction reference type for N9 X12 segments for general reference data that is not a transaction document identifier. HDA mapping.

Valid values include:

PAYERIDENTIFIER - Payer Identification Number used for covered entity
DEA - Drug Enforcement Administration Number
HIN - Health Industry Number (HIN)
LETTERS - Letters or Notes
LOCATIONIDENTIFIER - GS1-US Global Location Number (GLN)
PRODUCTLINENUMBER - Product Line Number
SECONDARYTRADECLASS
PRIMARYCLASS

–

REF01 =

2U (PAYERIDENTIFIER) or
DH (DEA) or
HI (HIN) or
L1 (LETTERS) or
LU (LOCATIONIDENTIFIER) or
X8 (SECONDARYTRADECLASS) or
ACD (PRIMARYCLASS) or
P7 (PRODUCTLINENUMBER)

Use java call out.

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping. HDA usage description: Class of Trade List: When REF01 = ACD, primary class of trade codes and descriptions will be mapped in REF02 and REF03. Also, note that since a REF segment is being used, trading partners are not restricted to using only the codes and descriptions listed below. Trading partners may elect to add/replace primary class of trade codes and descriptions agreed to by both partners to further meet requirements.

–

REF02

description

string

Identifier or description defined by qualifier code in transactionReferenceIdentifier. HDA Notes: 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.

–

salesItemInformation

array

To specify line item information related to a sale of an item.

–

segment loop CON-N1-SII

productCodesIdentifiers

Product code identifier types and values. Only one instance of productCodesIdentifiers per productAdjustmentDetails loop.

–

segment loop CON-N1-SII

productCodeType

string

Code to qualify product identifier type.

Valid values include:

CUSTOMER
GTIN12
GTIN13
GTIN14
CASEUPC
PACKAGEUPC
VENDORCATALOG
PC -US_NDC442
US_NDC532
US_NDC541
US_NDC542
US_NHRIC55
US_NHRIC64
US_NHRIC
US_NDC

–

SII01 = VC (VENDORCATALOG) or UI (PACKAGEUPC) or UP (UPC) or EN (GTIN13) UK (GTIN14) or UA (CASEUPC) or N1 (US_NDC442) or N2 (US_NDC532) or N3 (US_NDC541) or N4 (US_NDC542) or N5 (US_NHRIC55) or N6 (US_NHRIC64) or NH (US_NHRIC) or BP (CUSTOMER) or ND (US_NDC) Use Java call out.

productCodeValue

string

Product code identifier value

–

SII02

itemQuantity

Quantity of item in sales item information

–

segment loop CON-N1-SII

quantityType

string

Type of quantity recorded.

–

quantityValue

number

Quantity of product required for planning

–

SII03

unitOfMeasure

string

Composite Unit or Basis for Measurement Code.

Unit of entry UOM's include: CA = Case CP = Crate EA = Each PC = Piece UN = Unit

–

SII04-01 = UN (UN) or EA (EA) or CA (CA) Use java lookup

salesUnitDetailInformation

array

Specifies item unit details for an initial bid award or a subsequent bid award/change.

–

segment loop CON-N1-SII

unitOfMeasure

string

Unit of measure for recorded product in adjustment.

Valid values include: - UN (HDA) - EA - CA

–

unitPriceTypeCode

string

Code identifying the type of unit price.

Valid values include: - CONTRACT - WHOLESALE

–

itemUnitPrice

number

Unit price for product

–

SII05 (where unitPriceTypeCode = WHOLESALE) SII06 (where unitPriceTypeCode = CONTRACT)

adjustmentAmount

number

Chargeback claim amount deals with extended rebate amount

–

SII07

extendedTransactionReferenceInformation

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments N9 for information may be related to transaction documents. HDA Description: If 8X is used, it will override BAA01. Designates transaction type in N907-04. It can house either letters/notes or the chargeback line number but not both. If ZZ is used in N907-03, include Invoice Date at header. Transaction types will be look like as follows: If 8X is used in N907-03, use below for BAA01 at header: '00' for original '15' for resubmission '18' for credit/rebill with original '41' for credit/rebill with no original

–

loop CON-N1-SII-N9

salesItemReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

Valid values include: - DISTRIBUTORINVOICE - Distributor Invoice Number

–

N901 = DI (DISTRIBUTORINVOICE)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping.

–

N902

description

string

Identifier or description defined by qualifier code in transactionReferenceIdentifier, widely used for Order date references as per HAD usage guideline.

–

N903

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. HAD Usage: This date must be the original date of sale rather than the invoice date because an 844 can be sent to a manufacturer more than once.

–

N904

epochTransactionReferenceDate

integer

Transaction reference date and time in EPOCH date time format.

–

salesItemLotNumberReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

Valid values include: - LOTNUMBER - Manufacturer's batch / Lot Number

–

N907.01 or N907.03 or N907.05 = LT (LOTNUMBER)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01. N907.04, when transactionReferenceType maps to N907.03. N907.06, when transactionReferenceType maps to N907.05.

salesItemProductLineReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

Valid values include: - PRODUCTLINENUMBER - Product Line Number

–

N907.01, N907.03, N907.05 = P7 (PRODUCTLINENUMBER)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01. N907.04, when transactionReferenceType maps to N907.03. N907.06, when transactionReferenceType maps to N907.05.

salesItemLettersReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

Valid values include: - LETTERS - Letters and Notes

–

N907.01, N907.03, N907.05 = L1 (LETTERS)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01. N907.04, when transactionReferenceType maps to N907.03. N907.06, when transactionReferenceType maps to N907.05.

salesItemSerialNumberReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

Valid values include: - SERIALNUMBER - Manufacturer's serialized GTIN

–

N907.01, N907.03, N907.05 = SE (SERIALNUMBER)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01. N907.04, when transactionReferenceType maps to N907.03. N907.06, when transactionReferenceType maps to N907.05.

salesItemTransactionReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

The valid value is TRANSACTIONTYPE - Transaction Category

–

N907.01, N907.03, N907.05 = 8X (TRANSACTIONTYPE)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01. N907.04, when transactionReferenceType maps to N907.03. N907.06, when transactionReferenceType maps to N907.05.

salesItemMutuallyDefinedReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

The valid value is CUSTOM - Mutually Defined.

–

N907.01, N907.03, N907.05 = ZZ (CUSTOM)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01. N907.04, when transactionReferenceType maps to N907.03. N907.06, when transactionReferenceType maps to N907.05.

intermediateContractPartyInformation

Intermediate contract party identifiers and address information extended with reference identifiers and dates. HDA usage note: This N1 loop at the Detail Level in the CON loop is required to identify eligible customers belonging to the buying group or individual parties eligible for the contract.

–

N101 = "EC"

businessPartyInformation

Eligible contract party identifiers and address information.

–

N101 = "EC"

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

–

N103 use java call out.

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

–

transactionReferenceIdentifierList

array

Transaction references for Product Transfer request Adjustment at header level that affects the entire message

–

segment REF (loop CON-N1-N3-N4-REF)

b2bTransactionIdentifierType

string

Transaction reference type for N9 X12 segments for general reference data that is not a transaction document identifier. HDA mapping.

The valid value is PURCHASEORDER - Purchase Order Number

–

REF01 = PO (PURCHASEORDER)

b2bTransactionIdentifierValue

string

Document identifier for transaction referenced by b2bTransactionIdentifierType.

–

REF02

transactionDate

string

Date transaction created

–

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.

–

transactionReferenceInformation

array

Reference information for identifiers that are not related to transaction documents.

This group would map to X12 REF segments. HDA Description: This REF segment at the Detail Level in the CON/N1 loop is used in the bid award/change to provide other information regarding the customers eligible for the contract including: previous identifiers, trade classification(s), GPO membership IDs, and account class codes. REF01 and REF02 must be present and in some instances, REF03 may be appropriate for description clarification.

–

segment REF (loop CON-N1-N3-N4-REF)

transactionReferenceType

string

Transaction reference type for N9 X12 segments for general reference data that is not a transaction document identifier. HDA mapping.

Valid values include:

PAYERIDENTIFIER - Payer Identification Number used for covered entity
DEA - Drug Enforcement Administration Number
HIN - Health Industry Number (HIN)
LETTERS - Letters or Notes
LOCATIONIDENTIFIER - GS1-US Global Location Number (GLN)
PRODUCTLINENUMBER - Product Line Number
SECONDARYTRADECLASS
PRIMARYCLASS

–

REF01 =

2U (PAYERIDENTIFIER) or
DH (DEA) or
HI (HIN) or
L1 (LETTERS) or
LU (LOCATIONIDENTIFIER) or
X8 (SECONDARYTRADECLASS) or
ACD (PRIMARYCLASS) or
P7 (PRODUCTLINENUMBER)

Use java call out.

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType.

Pass thru X12 mapping. HDA usage description: Class of Trade List: When REF01 = ACD, primary class of trade codes and descriptions will be mapped in REF02 and REF03. Also, note that since a REF segment is being used, trading partners are not restricted to using only the codes and descriptions listed below.

Trading partners may elect to add/replace primary class of trade codes and descriptions agreed to by both partners to further meet requirements.

–

REF02

description

string

Identifier or description defined by qualifier code in transactionReferenceIdentifier. HDA Notes: 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.

–

N/A

epochTransactionReferenceDate

integer

Transaction reference date and time in EPOCH date time format.

–

N/A

salesItemInformation

array

To specify line item information related to a sale of an item.

–

segment loop CON-N1-SII

productCodesIdentifiers

Product code identifier types and values. Only one instance of productCodesIdentifiers per productAdjustmentDetails loop.

–

segment loop CON-N1-SII

productCodeType

string

Code to qualify product identifier type.

Valid values include:

CUSTOMER
GTIN12
GTIN13
GTIN14
CASEUPC
PACKAGEUPC
VENDORCATALOG
PC -US_NDC442
US_NDC532
US_NDC541
US_NDC542
US_NHRIC55
US_NHRIC64
US_NHRIC
US_NDC

–

SII01 = VC (VENDORCATALOG) or UI (PACKAGEUPC) or UP (UPC) or EN (GTIN13) UK (GTIN14) or UA (CASEUPC) or N1 (US_NDC442) or N2 (US_NDC532) or N3 (US_NDC541) or N4 (US_NDC542) or N5 (US_NHRIC55) or N6 (US_NHRIC64) or NH (US_NHRIC) or BP (CUSTOMER) or ND (US_NDC) Use Java call out.

productCodeValue

string

Product code identifier value

–

SII02

itemQuantity

Quantity of item in sales item information

–

segment loop CON-N1-SII

quantityType

string

Type of quantity recorded.

–

N/A

quantityValue

number

Quantity of product required for planning

–

SII03

unitOfMeasure

string

Composite Unit or Basis for Measurement Code.

Unit of entry UOM's include:

CA - Case
CP - Crate
EA - Each
PC - Piece
UN - Unit

–

SII04-01 =

UN (UN) or
EA (EA) or
CA (CA)

Use java lookup

salesUnitDetailInformation

array

Specifies item unit details for an initial bid award or a subsequent bid award/change.

–

segment loop CON-N1-SII

unitOfMeasure

string

Unit of measure for recorded product in adjustment.

Valid values

UN (HDA)
EA
CA

–

N/A

unitPriceTypeCode

string

Code identifying the type of unit price.

The valid value is CONTRACT - WHOLESALE.

–

N/A

itemUnitPrice

number

Unit price for product

–

SII05 (where unitPriceTypeCode = WHOLESALE)

SII06 (where unitPriceTypeCode = CONTRACT)

adjustmentAmount

number

Chargeback claim amount deals with extended rebate amount

–

SII07

extendedTransactionReferenceInformation

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments N9 for information may be related to transaction documents. HDA Description:

If 8X is used, it will override BAA01. Designates transaction type in N907-04. It can house either letters/notes or the chargeback line number but not both.

If ZZ is used in N907-03, include Invoice Date at header. Transaction types will be look like as follows: If 8X is used in N907-03, use below for BAA01 at header: '00' for original '15' for resubmission '18' for credit/rebill with original '41' for credit/rebill with no original

–

loop CON-N1-SII-N9

salesItemReferenceInformation

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

The valid value is DISTRIBUTORINVOICE - Distributor Invoice Number

–

N901 = DI (DISTRIBUTORINVOICE)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping.

–

N902

description

string

Identifier or description defined by qualifier code in transactionReferenceIdentifier, widely used for Order date references as per HAD usage guideline.

–

N903

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.

HAD Usage: This date must be the original date of sale rather than the invoice date because an 844 can be sent to a manufacturer more than once.

–

N904

epochTransactionReferenceDate

integer

Transaction reference date and time in EPOCH date time format.

–

N/A

salesItemLotNumberReferenceInformation

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

The valid value is LOTNUMBER - Manufacturer's batch / Lot Number.

–

N907.01 or N907.03 or N907.05 = LT (LOTNUMBER)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01. N907.04, when transactionReferenceType maps to N907.03. N907.06, when transactionReferenceType maps to N907.05.

salesItemProductLineReferenceInformation

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

The valid value is PRODUCTLINENUMBER - Product Line Number.

–

N907.01, N907.03, N907.05 = P7 (PRODUCTLINENUMBER)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01.

N907.04, when transactionReferenceType maps to N907.03.

N907.06, when transactionReferenceType maps to N907.05.

salesItemLettersReferenceInformation

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

The valid value is LETTERS - Letters and Notes

–

N907.01, N907.03, N907.05 = L1 (LETTERS)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01.

N907.04, when transactionReferenceType maps to N907.03.

N907.06, when transactionReferenceType maps to N907.05.

salesItemSerialNumberReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

The valid value is SERIALNUMBER - Manufacturer's serialized GTIN.

–

N907.01, N907.03, N907.05 = SE (SERIALNUMBER)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01.

N907.04, when transactionReferenceType maps to N907.03.

N907.06, when transactionReferenceType maps to N907.05.

salesItemTransactionTypeInformation

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

The valid value is TRANSACTIONTYPE - Transaction Category.

–

N907.01, N907.03, N907.05 = 8X (TRANSACTIONTYPE)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01.

N907.04, when transactionReferenceType maps to N907.03.

N907.06, when transactionReferenceType maps to N907.05.

salesItemMutuallyDefinedReferenceInformation

–

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

The valid value is CUSTOM - Mutually Defined.

–

N907.01, N907.03, N907.05 = ZZ (CUSTOM)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01.

N907.04, when transactionReferenceType maps to N907.03.

N907.06, when transactionReferenceType maps to N907.05.

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 eligible customers belonging to the buying group or individual parties eligible for the contract.

–

N101 = "ST"

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.

–

N103 use java call out.

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

–

transactionReferenceIdentifierList

array

Transaction references for Product Transfer request Adjustment at header level that affects the entire message.

–

segment REF (loop CON-N1-N3-N4-REF)

b2bTransactionIdentifierType

string

Transaction reference type for N9 X12 segments for general reference data that is not a transaction document identifier. HDA mapping.

The valid value is PURCHASEORDER - Purchase Order Number.

–

REF01 = PO (PURCHASEORDER)

b2bTransactionIdentifierValue

string

Document identifier for transaction referenced by b2bTransactionIdentifierType.

–

REF02

transactionDate

string

Date transaction created.

–

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.

–

transactionReferenceInformation

array

Reference information for identifiers that are not related to transaction documents. This group would map to X12 REF segments. HDA Description:

This REF segment at the Detail Level in the CON/N1 loop is used in the bid award/change to provide other information regarding the customers eligible for the contract including: previous identifiers, trade classification(s), GPO membership IDs, and account class codes. REF01 and REF02 must be present and in some instances, REF03 may be appropriate for description clarification.

–

segment REF (loop CON-N1-N3-N4-REF)

transactionReferenceType

string

Transaction reference type for N9 X12 segments for general reference data that is not a transaction document identifier. HDA mapping.

Valid values include:

PAYERIDENTIFIER - Payer Identification Number used for covered entity
DEA - Drug Enforcement Administration Number
HIN - Health Industry Number (HIN)
LETTERS - Letters or Notes
LOCATIONIDENTIFIER - GS1-US Global Location Number (GLN)
PRODUCTLINENUMBER - Product Line Number
SECONDARYTRADECLASS
PRIMARYCLASS

–

REF01 =

2U (PAYERIDENTIFIER) or
DH (DEA) or
HI (HIN) or
L1 (LETTERS) or
LU (LOCATIONIDENTIFIER) or
X8 (SECONDARYTRADECLASS) or
ACD (PRIMARYCLASS) or
P7 (PRODUCTLINENUMBER)

Use java call out.

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping. HDA usage description: Class of Trade List:

When REF01 = ACD, primary class of trade codes and descriptions will be mapped in REF02 and REF03. Also, note that since a REF segment is being used, trading partners are not restricted to using only the codes and descriptions listed below.

Trading partners may elect to add/replace primary class of trade codes and descriptions agreed to by both partners to further meet requirements.

–

REF02

description

string

Identifier or description defined by qualifier code in transactionReferenceIdentifier. HDA Notes:

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.

–

N/A

epochTransactionReferenceDate

integer

Transaction reference date and time in EPOCH date time format.

–

N/A

salesItemInformation

array

To specify line item information related to a sale of an item.

–

segment loop CON-N1-SII

productCodesIdentifiers

Product code identifier types and values.

Only one instance of productCodesIdentifiers per productAdjustmentDetails loop.

–

segment loop CON-N1-SII

productCodeType

string

Code to qualify product identifier type.

Valid values include:

CUSTOMER
GTIN12
GTIN13
GTIN14
CASEUPC
PACKAGEUPC
VENDORCATALOG
PC -US_NDC442
US_NDC532
US_NDC541
US_NDC542
US_NHRIC55
US_NHRIC64
US_NHRIC
US_NDC

–

SII01 =

VC (VENDORCATALOG) or
UI (PACKAGEUPC) or
UP (UPC) or
EN (GTIN13)
UK (GTIN14) or
UA (CASEUPC) or
N1 (US_NDC442) or
N2 (US_NDC532) or
N3 (US_NDC541) or
N4 (US_NDC542) or
N5 (US_NHRIC55) or
N6 (US_NHRIC64) or
NH (US_NHRIC) or
BP (CUSTOMER) or
ND (NDC)

Use Java call out.

productCodeValue

string

Product code identifier value.

–

SII02

itemQuantity

Quantity of item in sales item information.

–

segment loop CON-N1-SII

quantityType

string

Type of quantity recorded.

–

quantityValue

number

Quantity of product required for planning.

–

SII03

unitOfMeasure

string

Composite Unit or Basis for Measurement Code.

Unit of entry UOM's include:

CA - Case
CP - Crate
EA - Each
PC - Piece
UN - Unit

–

SII04-01 =

UN (UN) or
EA (EA) or
CA (CA)

Use java lookup

salesUnitDetailInformation

array

Specifies item unit details for an initial bid award or a subsequent bid award/change.

–

segment loop CON-N1-SII

unitOfMeasure

string

Unit of measure for recorded product in adjustment.

Valid values

UN (HDA)
EA
CA

–

unitPriceTypeCode

string

Code identifying the type of unit price.

The valid value is CONTRACT - WHOLESALE.

–

itemUnitPrice

number

Unit price for product.

–

SII05 (where unitPriceTypeCode = WHOLESALE)

SII06 (where unitPriceTypeCode = CONTRACT)

adjustmentAmount

number

Chargeback claim amount deals with extended rebate amount.

–

SII07

extendedTransactionReferenceInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents. HDA Description:

If 8X is used, it will override BAA01. Designates transaction type in N907-04. It can house either letters/notes or the chargeback line number but not both.

If ZZ is used in N907-03, include Invoice Date at header. Transaction types will be look like as follows:

If 8X is used in N907-03, use below for BAA01 at header: '00' for original '15' for resubmission '18' for credit/rebill with original '41' for credit/rebill with no original.

–

loop CON-N1-SII-N9

salesItemReferenceInformation

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

Valid value is DISTRIBUTORINVOICE - Distributor Invoice Number.

–

N901 = DI (DISTRIBUTORINVOICE)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N902

description

string

Identifier or description defined by qualifier code in transactionReferenceIdentifier, widely used for Order date references as per HAD usage guideline.

–

N903

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. HAD Usage:

This date must be the original date of sale rather than the invoice date because an 844 can be sent to a manufacturer more than once.

–

N904

epochTransactionReferenceDate

integer

Transaction reference date and time in EPOCH date time format.

–

salesItemLotNumberReferenceInformation

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

Valid value is LOTNUMBER - Manufacturer's batch / Lot Number

–

N907.01 or N907.03 or N907.05 = LT (LOTNUMBER)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01.

N907.04, when transactionReferenceType maps to N907.03.

N907.06, when transactionReferenceType maps to N907.05.

salesItemProductLineReferenceInformation

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

The valid value is PRODUCTLINENUMBER - Product Line Number.

–

N907.01, N907.03, N907.05 = P7 (PRODUCTLINENUMBER)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01.

N907.04, when transactionReferenceType maps to N907.03.

N907.06, when transactionReferenceType maps to N907.05.

salesItemLettersReferenceInformation

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

The valid value is LETTERS - Letters and Notes.

–

N907.01, N907.03, N907.05 = L1 (LETTERS)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enum in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01.

N907.04, when transactionReferenceType maps to N907.03.

N907.06, when transactionReferenceType maps to N907.05.

salesItemSerialNumberReferenceInformation

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

Valid value is SERIALNUMBER - Manufacturer's serialized GTIN.

–

N907.01, N907.03, N907.05 = SE (SERIALNUMBER)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01.

N907.04, when transactionReferenceType maps to N907.03

N907.06, when transactionReferenceType maps to N907.05.

salesItemTransactionTypeInformation

Reference information for identifiers that are related to transaction documents. This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

Th valid value is TRANSACTIONTYPE - Transaction Category

–

N907.01, N907.03, N907.05 = 8X (TRANSACTIONTYPE)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01.

N907.04, when transactionReferenceType maps to N907.03.

N907.06, when transactionReferenceType maps to N907.05.

salesItemMutuallyDefinedReferenceInformation

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments N9 for information may be related to transaction documents.

–

loop CON-N1-SII-N9

transactionReferenceType

string

Transaction reference type for X12 segments N9 for general reference data will also represent transaction document identifier. HDA mapping.

The valid value is CUSTOM - Mutually Defined.

–

N907.01, N907.03, N907.05 = ZZ (CUSTOM)

transactionReferenceIdentifier

string

Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping.

–

N907.02, when transactionReferenceType maps to N907.01.

N907.04, when transactionReferenceType maps to N907.03

N907.06, when transactionReferenceType maps to N907.05.

productAdjustmentDetails

array

Product adjustment details.

–

segment loop CON-PAD

lineItemNumber

string

Alphanumeric characters assigned for differentiation within a transaction set

–

PAD01

productTransferTypeCode

string

Product transfer type code. X12 pass through.

–

productTransferCode

string

Product transfer type code.

Valid values are:

SHIPDEBITSALE - Ship and Debit sale
STOCKSALE - Stock Sale
DROPSHIPSALE- Drop and ship sale
CONTRACTSALE - Product contract based sale
EXCHANGE - Product exchange
RETURN - Product return

–

PAD02 =

SD (SHIPDEBITSALE) or
SS (STOCKSALE) or
DS (DROPSHIPSALE) or
CS (CONTRACTSALE) or
BR (EXCHANGE) or
BN (RETURN)

adjustmentTypeCode

string

Change or response type code specifying the type of change recorded in the product adjustment details loop.

Valid values include:

ADDITEM
CHANGE
CHANGEDATE
DELETEITEMS
ORIGINALREVISED
ORIGINAL

–

PAD03 =

AI (ADDITEM) or
CA (CHANGE) or
CT (CHANGEDATE) or
DI (DELETEITEMS) or
OA (ORIGINALREVISED) or
OC (ORIGINAL) or
PC (PRICECHANGE) or
RB (REPLACEDATES) or
RE (REPLACEMENT)

receivedProductInformation

array

Information about the product that was received that is being reported in the receiving advice.

–

segment loop CON-PAD-LIN

lineItemNumber

string

Receipt advice item detail line item number.

–

LIN01

lineItemStatus

string

Line item status.

–

lotNumber

string

Lot or batch identifier.

–

alternateLot

string

Alternate lot number, ie, third-party supplier, customer, etc.

–

expirationDate

date

Lot expiration date.

–

productCodesIdentifiers

array

Internal material identifier in the backend/ERP systems for the product. In the delivery this will be the supplier, although the customer and other identifiers may also be present.

–

segment LIN in segment loop group CON-PAD LIN pairs being mapped:

productCodeType

string

Code to qualify product identifier type.

Valid value:

VENDORPARTNUM - Seller's Part Number
CUSTOMER - Customer's Part Number

–

LIN02 =

VP (VENDORPARTNUM) or
BP (CUSTOMER)

Use Java call-out to enumeration mapping worksheet CL_ProductCodeType.txt.

productCodeValue

string

Product code identifier value.

–

LIN03

unitDetailInformation

array

Specifies item unit details for an initial bid award or a subsequent bid award/change.

HDA usage note: Two occurrences of this segment at the detail level in the productAdjustmentDetails loop are required to add an item in a bid award: one to specify the wholesale price and the other to specify the contract price.

This is not necessarily the case in a bid award/change, when specifying a price change, for example. If the contract price changed then only one occurrence of the UIT segment would be required for the manufacturer to notify the distributor of this change.

–

segment loop CON-PAD

unitOfMeasure

string

Unit of measure for recorded product in adjustment.

Valid values

UN (HDA)
EA
CA

–

UIT01 =

UN (UN) or
EA (EA) or
CA (CA)

Use java lookup

itemUnitPrice

number

Unit price for product

–

UIT02

unitPriceTypeCode

string

Code identifying the type of unit price.

Valid values include:

CONTRACT
BOOK
RESALE
WHOLESALE
CATLOG
CURRENT
DISTRIBUTOR
QUOTED
RETAILPER1000
RETAILPER100

–

UIT03 =

CT (CONTRACT) or
CA (CATLOG) or
CP (CURRENT) or
DI (DISTRIBUTOR) or
LE (BOOK) or
QT (QUOTED) or
RE (RESALE) or
RM (RETAILPER1000) or
RT (RETAILPER100) or
WH (WHOLESALE)

adjustmentQuantity

array

Quantity of items in product adjustment

–

segment loop CON-PAD-QTY

quantityType

string

Type of quantity recorded.

The valid value is SHIPPED - Quantity shipped

–

QTY01 = 39 (SHIPPED)

quantityValue

number

Quantity of product required for planning

–

QTY02

unitOfMeasure

string

Unit or Basis for Measurement Code.

Unit of entry UOM's include:

CA - Case
CP - Crate
EA - Each
PC - Piece
UN - Unit

–

QTY03

transactionReferenceInformation

array

Reference information for identifiers that are not related to transaction documents. This group would map to X12 REF segments.

–

loop CON-PAD

transactionReferenceType

string

Transaction reference type for REF X12 segments for other reference data that is not a transaction document identifier.

Valid values include:

DISTRIBUTORINVOICE - Distributor Invoice Number
SELLERSIDENTIFIER - Sellers Identifier

–

REF01 =

DI (DISTRIBUTORINVOICE) or
LI (SELLERSIDENTIFIER)

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.

–

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 request. Optional segment.

–

loop CON-PAD

dateType

string

Date type at item level for product transfer account adjustment request in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

The valid value is SHIPPED - Shipped date.

–

DTM01 = 011 (SHIPPED)

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.

–

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.

–

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

To indicate the total monetary amount to be charged back from distributor to manufacturer.

–

Segment AMT

pricingType

string

Code specifying the amount qualifier.

Valid values are:

CHARGEBACKCLAIM - Chargeback claim amount
SUMMARY - Summary of claim amount
CHANGE - Any change in claim amount
NETCLAIM - Net claim amount

–

AMT01 =

CC (CHARGEBACKCLAIM) or
CE (SUMMARY) or
CH (CHANGE) or
CQ (NETCLAIM)

pricingAmount

string

Monetary amount.

–

AMT02

isCreditOrDebit

boolean

Credit or debit boolean. Only populated if identified. HDA optional value.

Valid values:

True - Credit
False - Debit Not populated (default)

–

AMT03

If isCreditOrDebit = true, hard code C
If isCreditOrDebit = false, hard code D Else do not map

canonicalProductTransferAccountAdjustmentRequestSummary

array

Summary totals for product transfer account adjustment request.

–

segment CTT

summaryType

string

Summary type for product transfer account adjustment request. Number of line items.

The valid value is NUMBEROFITEMS.

–

CTT01

summaryValue

string

Summary value.

–

CTT02

summaryValueUnit

string

Summary value unit of measure.

–

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.

–