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,

Price authorization acknowledgment canonical guidelines

The price authorization acknowledgment transaction, is used by manufacturers or suppliers to electronically communicate pricing decisions to distributors, resellers, or buying groups. Price authorization acknowledgment transaction is sent after a pricing agreement or contract has been established. It provides a standardized format to confirm whether a price request has been accepted, rejected, or modified, along with details such as pricing terms, reason codes, and any additional instructions. Upon receiving the Price Authorization Acknowledgment, the distributor acknowledges receipt with an functional acknowledgment, confirming successful processing within their EDI system. By automating this exchange, the Price Authorization Acknowledgment improves communication speed, accuracy, and transparency between trading partners. It helps reduce manual errors, supports faster decision-making, and integrates seamlessly with other EDI documents like purchase orders, acknowledgments, and invoices. As part of a broader digital supply chain strategy, the Price Authorization Acknowledgment plays a vital role in ensuring timely and accurate pricing updates across the procurement and distribution process.

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. - - -
  canonicalPriceAuthorizationAcknowledgmentHeader - Payload for canonical price authorization acknowledgment/status message. - segment BPA -
    processingFunctionTypeCode string

Processing function, transaction set purpose code. Valid values include:

  • CREATE

  • CHANGE

  • DELETE

  • ORIGINAL

  • REPLACE

  • FOLLOWUP

-

BPA01 00 = ORIGINAL

  • 02 - CREATE (Add)

  • 03 - DELETE

  • 04 - CHANGE

  • 05 - REPLACE

  • 45 - FOLLOWUP

 -
    dateReported string Code identifiying purpose of EDI message. - BPA02  
    epochDateReported integer Price catalog requirements profile. - - -
    recordChangeType string

Denotes change type - price changes or customer/member changes:

Valid values:

  • PRICE - Price changes

  • MEMBER - Member changes

 - - -
    transactionReferenceIdentifierList array Transaction references for inventory adjustment at header level that affects the entire message. - segment BPA -
      b2bTransactionIdentifierType string

Referenced document type.

Valid values:

  • CONTRACT

  • PRICEAUTHORIZATIONACKNOWELDGEMENT(Mandetory)

 -

b2bTransactionIdentifierType =

"CONTRACT" and "PRICEAUTHORIZATIONACKNOWELDGEMENT" BPA03 = "CT" (CONTRACT)

 -
      b2bTransactionIdentifierValue string Document identifier for transaction referenced by b2bTransactionIdentifierType. - BPA04 wheretransactionReferenceIdentifierType = "CONTRACT" or "PRICEAUTHROIZATIONACKNOWELDGEMENT" -
      transactionDate string Date transaction created. - - -
      epochTransactionDate integer Date transaction created in epoch integer date format. - - -
      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.

The valid values include CONTRACTCLASS.

- transactionReferenceType = "CONTRACTCLASS" REF01 = CE -
      transactionReferenceIdentifier string Transaction reference identifier value as defined by enum in transactionReferenceType. -

REF02 HDA codes include:

  • S340B - sub-340B

  • NGPW - Non-GPO/Non-WAC

  • PHS - Public Health Services

  • PHSM - Services with membership

  • VCBA - Vendor Contract/Base or Blanket Agreement

  • GPO - Commercial Group Purchasing

  • GPOM - Commercial Group Purchasing with membership

  • FG - Federal Government Supply

  • SLG - State & Local Government

  • INDVM - Individual Contracts with membership

 -
      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 price authorization header - segment DTM -
      dateType string

Date type at header level for price authorization in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

Valid values:

  • CONTRACTEFFECTIVE

  • CONTRACTEXPIRATION

  • GROUPCONTRACTEFFECTIVE

  • GROUPCONTRACTEXPIRATION

  • WHOLESALECONTRACTEFFECTIVE

  • WHOLESALECONTRACTEXPIRATION

  • DOCUMENT

-

DTM01 =

  • 092 (CONTRACTEFFECTIVE) or

  • 093 (CONTRACTEXPIRATION) or

  • 124 (GROUPCONTRACTEFFECTIVE) or

  • 125 (GROUPCONTRACTEXPIRATION) or

  • 126 (WHOLESALECONTRACTEFFECTIVE) or

  • 127 (WHOLESALECONTRACTEXPIRATION) or

  • 999 (DOCUMENT)

 -
      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. - - -
      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 -
    purchasingGroupInformation - Customer or buyer party company identifiers and address information extended with dates and reference identifiers. - 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 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

 -
          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 - 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. HDA mapping for price authorization in N1 party loop for buying group only.

The valid value CONTRACT.

 - REF01 = CT (CONTRACT) -
        transactionReferenceIdentifier string Transaction reference identifier value as defined by enum in transactionReferenceType. HDA: Contract header type code defining identifier/description in description attribute (REF03). - 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 price authorization 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. - - -
        timeZone string Time zone for referenced dates - - -
    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 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

 -
        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 - PER02 -
        contactTitle string Title of contact - - -
        contactPhone string Contact phone number - PER04 where PER03 = "TE" -
        contactEmail string Contact email address - PER06 where PER05 = "EM" -
    contractPartyInformation - Contract party company identifiers and address information. - N101 = "9O" -
      businessPartyInformation - Contract party information. - N101 = "90" -
        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 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

 -
          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 - 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. HDA mapping for price authorization in N1 party loop for buying group only.

Valid value is CONTRACT.

 - REF01 = CT (CONTRACT) -
          transactionReferenceIdentifier string Transaction reference identifier value. - 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 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. -

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

 -
        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 - 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 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

 -
        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 - 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 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

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

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

 -
        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 - 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. - - -
      textFunctionCode string Text function code. - - -
      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. - - -
  canonicalPriceAuthorizationAcknowledgmentItemDetails array Price Authorization Acknowledgment 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 values include: - SUPPLIERCONTRACT

 - b2bTransactionIdentifierType = "SUPPLIERCONTRACT" CON01 = VC -
    b2bTransactionIdentifierValue string Transaction reference identifier value. - CON02 -
    contractStatusCode string Contract status code. Pass thru mapping. - CON03 -
    previousTransactionIdentifier string Previous transaction identifier, typically the previous contract number. - REF02 where REF01 = P1 -
    mpcDates array Dates relevant for price authorization item - segment DTM in CON loop -
      dateType string

Date type at item level for price authorization in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

Valid values:

  • CONTRACTEFFECTIVE

  • CONTRACTEXPIRATION

  • GROUPCONTRACTEFFECTIVE

  • GROUPCONTRACTEXPIRATION

  • DOCUMENT

-

DTM01 =

  • 092 (CONTRACTEFFECTIVE) or

  • 093 (CONTRACTEXPIRATION) or

  • 124 (GROUPCONTRACTEFFECTIVE) or

  • 125 (GROUPCONTRACTEXPIRATION) or

  • 990 (DOCUMENT)

 -
      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. - - -
      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 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

 -
          companyIdentifierValue string Company identifier value for business partner. - N104 -
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - -
        - - 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 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.

 - 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:

  • GPOIDENTIFIER

  • ACCOUNTCATEGORY

  • DEA

  • HIN

  • PREVIOUSDEA

  • PREVIOUSHIN

  • SECONDARYTRADECLASS

  • PRIMARYCLASS

-

REF01 =

  • 1W (GPOIDENTIFIER) or

  • 9X (ACCOUNTCATEGORY) or

  • DH (DEA) or

  • HI (HIN) or

  • P2 (PREVIOUSDEA) or

  • P3 (PREVIOUSHIN) or

  • X8 (SECONDARYTRADECLASS) or

  • ACD (PRIMARYCLASS)

 -
        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 (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 inventory adjustment header. HDA usage description: This DTM segment at the Detail Level in the CON/N1 loop is used to provide the effective and expiration dates of the individual customers. This segment is required only if these dates are different from the dates of the buying group contract indicated at the Header level. DTM01 and DTM02 must be present. This segment can also be used to provide the effective date of an identifier being implemented. DTM01 and DTM02 must be present. - loop CON-N1-N3-N4-DTM -
        dateType string

Date type at header level for inventory balance in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

Valid values:

  • CUSTOMERCONTRACTEFFECTIVE

  • CUSTOMERCONTRACTEXPIRATION

  • CONTRACTEFFECTIVE

  • CONTRACTEXPIRATION

  • GROUPCONTRACTEFFECTIVE

  • GROUPCONTRACTEXPIRATION

  • DOCUMENT

-

DTM01 =

  • 092 (CONTRACTEFFECTIVE) or

  • 093 (CONTRACTEXPIRATION) or

  • 124 (GROUPCONTRACTEFFECTIVE) or

  • 125 (GROUPCONTRACTEXPIRATION) or

  • 129 (CUSTOMERCONTRACTEFFECTIVE) or

  • 130 (CUSTOMERCONTRACTEXPIRATION)

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

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

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

 - 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:

  • GPOIDENTIFIER

  • ACCOUNTCATEGORY

  • DEA

  • HIN

  • PREVIOUSDEA

  • PREVIOUSHIN

  • SECONDARYTRADECLASS

  • PRIMARYCLASS

-

REF01 =

  • 1W (GPOIDENTIFIER) or

  • 9X (ACCOUNTCATEGORY) or

  • DH (DEA) or

  • HI (HIN) or

  • P2 (PREVIOUSDEA) or

  • P3 (PREVIOUSHIN) or

  • X8 (SECONDARYTRADECLASS) or

  • ACD (PRIMARYCLASS)

 -
        transactionReferenceIdentifier string

Transaction reference identifier value.

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 (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 inventory adjustment header. Optional segment.

This DTM segment at the Detail Level in the CON/N1 loop is used to provide the effective and expiration dates of the individual customers. This segment is required only if these dates are different from the dates of the buying group contract indicated at the Header level. DTM01 and DTM02 must be present. This segment can also be used to provide the effective date of an identifier being implemented.

 - loop CON-N1-N3-N4-DTM -
        dateType string

Date type at header level for inventory balance in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

Valid values:

  • CUSTOMERCONTRACTEFFECTIVE

  • CUSTOMERCONTRACTEXPIRATION

  • CONTRACTEFFECTIVE

  • CONTRACTEXPIRATION

  • GROUPCONTRACTEFFECTIVE

  • GROUPCONTRACTEXPIRATION

 -

DTM01 =

  • 092 (CONTRACTEFFECTIVE) or

  • 093 (CONTRACTEXPIRATION) or

  • 124 (GROUPCONTRACTEFFECTIVE) or

  • 125 (GROUPCONTRACTEXPIRATION) or

  • 129 (CUSTOMERCONTRACTEFFECTIVE) or

  • 130 (CUSTOMERCONTRACTEXPIRATION)

 -
        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. - - -
        timeZone string Time zone for referenced dates. - - -
    contractedPharmacyInformation  

Contracted pharmacy party or location 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 = "C9" -
      businessPartyInformation   Contracted party identifiers and address information. - N101 = "C9" -
        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 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

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

 - 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:

  • GPOIDENTIFIER

  • ACCOUNTCATEGORY

  • DEA

  • HIN

  • PREVIOUSDEA

  • PREVIOUSHIN

  • SECONDARYTRADECLASS

  • PRIMARYCLASS

-

REF01 =

  • 1W (GPOIDENTIFIER) or

  • 9X (ACCOUNTCATEGOR) or

  • DH (DEA) or

  • HI (HIN) or

  • P2 (PREVIOUSDEA) or

  • P3 (PREVIOUSHIN) or

  • X8 (SECONDARYTRADECLASS) or

  • ACD (PRIMARYCLASS)

 -
        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 (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 inventory adjustment header.

HDA usage description: This DTM segment at the Detail Level in the CON/N1 loop is used to provide the effective and expiration dates of the individual customers. This segment is required only if these dates are different from the dates of the buying group contract indicated at the Header level. DTM01 and DTM02 must be present. This segment can also be used to provide the effective date of an identifier being implemented. DTM01 and DTM02 must be present.

 - loop CON-N1-N3-N4-DTM -
        dateType string

Date type at header level for inventory balance in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

Valid values:

  • CUSTOMERCONTRACTEFFECTIVE

  • CUSTOMERCONTRACTEXPIRATION

  • CONTRACTEFFECTIVE

  • CONTRACTEXPIRATION

  • GROUPCONTRACTEFFECTIVE

  • GROUPCONTRACTEXPIRATION

-

DTM01 =

  • 092 (CONTRACTEFFECTIVE) or

  • 093 (CONTRACTEXPIRATION) or

  • 124 (GROUPCONTRACTEFFECTIVE) or

  • 125 (GROUPCONTRACTEXPIRATION) or

  • 129 (CUSTOMERCONTRACTEFFECTIVE) or

  • 130 (CUSTOMERCONTRACTEXPIRATION) or

 -
        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. - - -
        timeZone string Time zone for referenced dates. - - -
    eligibleContractPartyInformation array

Eligible 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 = "EB" -
      businessPartyInformation - Eligible contract party identifiers and address information. - N101 = "EB" -
        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 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

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

 - 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:

  • GPOIDENTIFIER

  • ACCOUNTCATEGORY

  • DEA

  • HIN

  • PREVIOUSDEA

  • PREVIOUSHIN

  • SECONDARYTRADECLASS

  • PRIMARYCLASS

-

REF01 =

  • 1W (GPOIDENTIFIER) or

  • 9X (ACCOUNTCATEGOR) or

  • DH (DEA) or

  • HI (HIN) or

  • P2 (PREVIOUSDEA) or

  • P3 (PREVIOUSHIN) or

  • X8 (SECONDARYTRADECLASS) or

  • ACD (PRIMARYCLASS)

 -
        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 (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 inventory adjustment header.

HDA usage description: This DTM segment at the Detail Level in the CON/N1 loop is used to provide the effective and expiration dates of the individual customers. This segment is required only if these dates are different from the dates of the buying group contract indicated at the Header level. DTM01 and DTM02 must be present. This segment can also be used to provide the effective date of an identifier being implemented. DTM01 and DTM02 must be present.

 - loop CON-N1-N3-N4-DTM -
        dateType string

Date type at header level for inventory balance in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

Valid values:

  • CUSTOMERCONTRACTEFFECTIVE

  • CUSTOMERCONTRACTEXPIRATION

  • CONTRACTEFFECTIVE

  • CONTRACTEXPIRATION

  • GROUPCONTRACTEFFECTIVE

  • GROUPCONTRACTEXPIRATION

-

DTM01 =

  • 092 (CONTRACTEFFECTIVE) or

  • 093 (CONTRACTEXPIRATION) or

  • 124 (GROUPCONTRACTEFFECTIVE) or

  • 125 (GROUPCONTRACTEXPIRATION) or

  • 129 (CUSTOMERCONTRACTEFFECTIVE) or

  • 130 (CUSTOMERCONTRACTEXPIRATION) or

 -
        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. - - -
        timeZone string Time zone for referenced dates. - - -
    eligiblePartyForRateInformation - Eligible party for rate 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 = "EP" -
      businessPartyInformation - Eligible party for rate identifiers and address information. - N101 = "EP" -
        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 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

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

 - 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:

  • GPOIDENTIFIER

  • ACCOUNTCATEGORY

  • DEA

  • HIN

  • PREVIOUSDEA

  • PREVIOUSHIN

  • SECONDARYTRADECLASS

  • PRIMARYCLASS

-

REF01 =

  • 1W (GPOIDENTIFIER) or

  • 9X (ACCOUNTCATEGOR) or

  • DH (DEA) or

  • HI (HIN) or

  • P2 (PREVIOUSDEA) or

  • P3 (PREVIOUSHIN) or

  • X8 (SECONDARYTRADECLASS) or

  • ACD (PRIMARYCLASS)

 -
        transactionReferenceIdentifier string

Transaction reference identifier value.

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 (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 inventory adjustment header.

HDA usage description: This DTM segment at the Detail Level in the CON/N1 loop is used to provide the effective and expiration dates of the individual customers. This segment is required only if these dates are different from the dates of the buying group contract indicated at the Header level. DTM01 and DTM02 must be present. This segment can also be used to provide the effective date of an identifier being implemented. DTM01 and DTM02 must be present.

 - loop CON-N1-N3-N4-DTM -
        dateType string

Date type at header level for inventory balance in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

Valid values:

  • CUSTOMERCONTRACTEFFECTIVE

  • CUSTOMERCONTRACTEXPIRATION

  • CONTRACTEFFECTIVE

  • CONTRACTEXPIRATION

  • GROUPCONTRACTEFFECTIVE

  • GROUPCONTRACTEXPIRATION

-

DTM01 =

  • 092 (CONTRACTEFFECTIVE) or

  • 093 (CONTRACTEXPIRATION) or

  • 124 (GROUPCONTRACTEFFECTIVE) or

  • 125 (GROUPCONTRACTEXPIRATION) or

  • 129 (CUSTOMERCONTRACTEFFECTIVE) or

  • 130 (CUSTOMERCONTRACTEXPIRATION) or

 -
        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. - - -
        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 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 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

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

 - 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:

  • GPOIDENTIFIER

  • ACCOUNTCATEGORY

  • DEA

  • HIN

  • PREVIOUSDEA

  • PREVIOUSHIN

  • SECONDARYTRADECLASS

  • PRIMARYCLASS

-

REF01 =

  • 1W (GPOIDENTIFIER) or

  • 9X (ACCOUNTCATEGOR) or

  • DH (DEA) or

  • HI (HIN) or

  • P2 (PREVIOUSDEA) or

  • P3 (PREVIOUSHIN) or

  • X8 (SECONDARYTRADECLASS) or

  • ACD (PRIMARYCLASS)

 -
        transactionReferenceIdentifier string

Transaction reference identifier value.

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 (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 inventory adjustment header. Optional segment.

HDA usage description: This DTM segment at the Detail Level in the CON/N1 loop is used to provide the effective and expiration dates of the individual customers. This segment is required only if these dates are different from the dates of the buying group contract indicated at the Header level. DTM01 and DTM02 must be present. This segment can also be used to provide the effective date of an identifier being implemented.

 - loop CON-N1-N3-N4-DTM -
        dateType string

Date type at header level for inventory balance in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

Valid values:

  • CUSTOMERCONTRACTEFFECTIVE

  • CUSTOMERCONTRACTEXPIRATION

  • CONTRACTEFFECTIVE

  • CONTRACTEXPIRATION

  • GROUPCONTRACTEFFECTIVE

  • GROUPCONTRACTEXPIRATION

-

DTM01 =

  • 092 (CONTRACTEFFECTIVE) or

  • 093 (CONTRACTEXPIRATION) or

  • 124 (GROUPCONTRACTEFFECTIVE) or

  • 125 (GROUPCONTRACTEXPIRATION) or

  • 129 (CUSTOMERCONTRACTEFFECTIVE) or

  • 130 (CUSTOMERCONTRACTEXPIRATION) or

 -
        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. - - -
        timeZone string Time zone for referenced dates - - -
    purchasingGroupInformation -

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

 - 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 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

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

 - 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:

  • GPOIDENTIFIER

  • ACCOUNTCATEGORY

  • DEA

  • HIN

  • PREVIOUSDEA

  • PREVIOUSHIN

  • SECONDARYTRADECLASS

  • PRIMARYCLASS

-

REF01 =

  • 1W (GPOIDENTIFIER) or

  • 9X (ACCOUNTCATEGOR) or

  • DH (DEA) or

  • HI (HIN) or

  • P2 (PREVIOUSDEA) or

  • P3 (PREVIOUSHIN) or

  • X8 (SECONDARYTRADECLASS) or

  • ACD (PRIMARYCLASS)

 -
        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 (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 inventory adjustment header. Optional segment.

HDA usage description: This DTM segment at the Detail Level in the CON/N1 loop is used to provide the effective and expiration dates of the individual customers. This segment is required only if these dates are different from the dates of the buying group contract indicated at the Header level. DTM01 and DTM02 must be present. This segment can also be used to provide the effective date of an identifier being implemented.

 - loop CON-N1-N3-N4-DTM -
        dateType   string

Date type at header level for inventory balance in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

Valid values:

  • CUSTOMERCONTRACTEFFECTIVE

  • CUSTOMERCONTRACTEXPIRATION

  • CONTRACTEFFECTIVE

  • CONTRACTEXPIRATION

  • GROUPCONTRACTEFFECTIVE

  • GROUPCONTRACTEXPIRATION

-

DTM01 =

  • 092 (CONTRACTEFFECTIVE) or

  • 093 (CONTRACTEXPIRATION) or

  • 124 (GROUPCONTRACTEFFECTIVE) or

  • 125 (GROUPCONTRACTEXPIRATION) or

  • 129 (CUSTOMERCONTRACTEFFECTIVE) or

  • 130 (CUSTOMERCONTRACTEXPIRATION) or

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

 - N101 = "DS" -
      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 -

N103 X12 codes for N103:

  • DUNS - 1

  • DUNS4 - 9

  • DEA - 11

  • HIN - 21

  • COMPANYID - 91

  • COMPANYSITEID - 92

  • GLN - UL

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

 - 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:

  • GPOIDENTIFIER

  • ACCOUNTCATEGORY

  • DEA

  • HIN

  • PREVIOUSDEA

  • PREVIOUSHIN

  • SECONDARYTRADECLASS

  • PRIMARYCLASS

-

REF01 =

  • 1W (GPOIDENTIFIER) or

  • 9X (ACCOUNTCATEGOR) or

  • DH (DEA) or

  • HI (HIN) or

  • P2 (PREVIOUSDEA) or

  • P3 (PREVIOUSHIN) or

  • X8 (SECONDARYTRADECLASS) or

  • ACD (PRIMARYCLASS)

 -
        transactionReferenceIdentifier string

Transaction reference identifier value.

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 (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 inventory adjustment header. Optional segment. HDA usage description: This DTM segment at the Detail Level in the CON/N1 loop is used to provide the effective and expiration dates of the individual customers. This segment is required only if these dates are different from the dates of the buying group contract indicated at the Header level. DTM01 and DTM02 must be present. This segment can also be used to provide the effective date of an identifier being implemented. - loop CON-N1-N3-N4-DTM -
        dateType string

Date type at header level for inventory balance in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

Valid values:

  • CUSTOMERCONTRACTEFFECTIVE

  • CUSTOMERCONTRACTEXPIRATION

  • CONTRACTEFFECTIVE

  • CONTRACTEXPIRATION

  • GROUPCONTRACTEFFECTIVE

  • GROUPCONTRACTEXPIRATION

-

DTM01 =

  • 092 (CONTRACTEFFECTIVE) or

  • 093 (CONTRACTEXPIRATION) or

  • 124 (GROUPCONTRACTEFFECTIVE) or

  • 125 (GROUPCONTRACTEXPIRATION) or

  • 129 (CUSTOMERCONTRACTEFFECTIVE) or

  • 130 (CUSTOMERCONTRACTEXPIRATION) or

 -
        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. - - -
        timeZone string Time zone for referenced dates - - -
    productAdjustmentDetails array Product adjustment details. - segment loop CON-PAD -
      lineItemNumber string

Line item number for canonicalPriceAuthorizationItemDetails.

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 canonicalPriceAuthorizationItemDetails array.

 - PAD01 -
      productTransferTypeCode string Product transfer type code. - PAD02 -
      adjustmentTypeCode string

Change or reponse 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)

 -
      productAdjustmentRestrictions array

Optional restrictions or conditions on product adjustments.

HDA usage note: This segment should only be used when the minimum order quantity is greater than one. Use of this segment is discouraged, because minimum order quantities defeat the purpose of the prime vendor program. Minimum order quantity restrictions result in excess inventory and are a major cause of returned goods.

 - segment loop CON-PAD-CTB -
        restrictionsType string

Restrictions or conditions code identifying the reason for the restriction or condition.

Valid value (HDA) - ORDERING.

 - CTB01 = OR (ORDERING) -
        minimumQuantity number Minimum quantity for product. - CTB04 -
        minimumAmount number Minimum monetary amount. - CTB06 -
        description string Description of restriction or condition. - CTB02 -
      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-UIT -
        unitOfMeasure string

Unit of measure for recorded product in adjustment. Valid values include:

  • UN (HDA)

  • EA

  • CA

-

UIT01 =

  • UN (UN) or

  • EA (EA) or

  • CA (CA)

-
        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)

 -
      mpcDates array

Dates relevant for price authorization 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 contract effective and expiration dates that are different from the buying group dates at the header level. When adding an item in a bid award/change, two occurrences of this date segment are required — one to specify the item contract effective date and the other to specify the item contract expiration date. DTM01 and DTM02 must be present.

 - loop CON-N1-N3-N4-DTM -
        dateType string

Date type at item level for price authorization in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

Valid values:

  • ITEMCONTRACTEFFECTIVE

  • ITEMCONTRACTEXPIRATION

 -

DTM01 =

  • 131 (ITEMCONTRACTEFFECTIVE) or

  • 132 (ITEMCONTRACTEXPIRATION)

 -
        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. - - -
        timeZone string Time zone for referenced dates. - - -
      productCodesIdentifiers -

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:

  • CUSTOMER

  • GTIN12

  • GTIN13

  • GTIN14

  • CASEUPC

  • PACKAGEUPC

  • VENDORCATALOG

  • UPC

  • US_NDC442

  • US_NDC532

  • US_NDC541

  • US_NDC542

  • US_NHRIC55

  • US_NHRIC64

  • US_NHRIC

-

LIN02 =

  • 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)

  • BP (CUSTOMER)

 -
        productCodeValue string Product code identifier value. - LIN03 -
      productItemInformation array Product item code information. Only using a subset of all available attributes. - Segment PID in HL ITEM loop / looping segment PO1 -
        productLanguageCode string Language for product description. - PID09 Set PID01 to F (free form) if PID present -
        productName string Name of product. - - -
        genericName string Generic name for product. - - -
        productDescription string Description of the product defined by the current product identifier. - PID05 -
      pricingInformation array

Pricing information for product.

HDA usage note: Used to communicate pricing scenarios where multiple price points exist for a given product on the same contract ID. This array does not represent tier contracts with unique contract IDs, which are typically sent in separate X12 845s messages. Use of this segment must be agreed on by the manufacturer and wholesaler to ensure interpretation/implementation is as the manufacturer intended. The price point for example, could be based on quantity purchased per order, per calendar quarter or some other parameter. Impacts on membership should also be considered. Feasibility may dictate all attached members are be able to access all price points sent in this segment.

 - - -
        conditionRecordIdentifier string Pricing condition record identifier. - - -
        validFromDate string Pricing condition valid from date. - - -
        epochValidFromDate integer Pricing condition valid from date generated in epoch integer date format. - - -
        validToDate string Pricing condition valid to date. - - -
        epochValidToDate integer Pricing condition valid to date generated in epoch integer date format. - - -
        pricingType string

Pricing type for price sales catalog.

Valid values include:

  • CONTRACT = Contract price

  • CONTRACT_TIER1

  • CONTRACT_TIER2

  • CONTRACT_TIER3

  • CONTRACT_TIER4

  • CONTRACT_TIER5

  • CONTRACT_TIER6

  • BEGINQUANTITY

-

CTP02 = "

  • CON (CONTRACT) or

  • C01 (CONTRACT_TIER1) or

  • C02 (CONTRACT_TIER2) or

  • C03 (CONTRACT_TIER3) or

  • C04 (CONTRACT_TIER4) or

  • C04 (CONTRACT_TIER4) or

  • C05 (CONTRACT_TIER5) or

  • C06 (CONTRACT_TIER6) or

  • PBQ (BEGINQUANTITY)

 -
        pricingAmount number Unit price for pricing type. - CTP03 -
        currencyCode string Currency code for the pricing amount. - - -
        pricingTypeQuantity number Quantity for pricing type. - CTP04 -
        unitPriceBasisQuantity string Quantity basis of unit price, ie, if unit price per one item, the basis is 1. If unit price based on 12, the basis is 12. - - -
        unitOfMeasure string Unit of measure used for pricing at the price conditions line item details level. - CTP05-01 -
        altUOMDenominator string

Denominator is used to convert from an alternate unit of measure, ie KG, to a base unit of measure, ie EA.

The denominator is the number of units of the alternative UOM (KG) that corresponds to the number of units of the base UOM (EA).

If 5 KG = 3 EA, 1 KG = 3/5 EA. 5 is the denominator. In most cases, this value will be 1.

 - - -
        altUOMNumerator string

Numerator is used to convert from an alternate unit of measure, ie, KG to a base unit of measure, ie, EA.

The numerator is the number of units of the base UOM (EA) that corresponds to the number of units of the alternative UOM (KG).

If 5 KG = 3 EA, 1 KG = 3/5 EA. 3 is the numerator. In most cases, this value will be 1.

 - - -
        conditionItemIndex string Pricing condition item index. - - -
        pricingScaleBaseInformation array Pricing scale base information at the pricing condition item details level. - - -
          scaleType string Pricing condition scale type. - - -
          scaleBasis string Basis for populating scale tables, ie, quantity. - - -
          scaleQuantity number Scale quantity at pricing conditions item details level. - - -
          unitOfMeasure string Unit of measure for scale quantity. - - -
          scaleValue number Monetary value of pricing condition scale. - - -
          scaleCalculationType string Scale calculation type. - - -
      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. - - -
    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. - - -
      name string Name of mapped field. - - -
      value string Value in named field. - - -
  canonicalPriceAuthorizationAcknowledgmentSummary array Summary totals for price authorization acknowledgment. - CTT -
    summaryType string

Summary type for price authorization acknowledgment. Number of line items.

The valid value is NUMBEROFITEMS.

 - CTT01 -
    summaryValue string Summary value. - CTT02 -
    summaryValueUnit string Summary value unit of measure. - CTT04 -

Tag end