Type = Technical Guides, Technical Tools, What's New,; Topic = Multienterprise Information Network Tower (MINT), Technical Documentation,;Persona = Solution Designer, TraceLink Administrator, User, Orchestration Architect, Solution Partner, Technology Partner,; Orchestration = Manufacturing, Logistics, Commerce, Transportation, Clinical Supply,; Function = IT, Quality, Procurement,

Product transfer resale canonical guidelines

The Product Transfer Resale Transaction is used primarily by distributors, wholesalers, and resellers to share detailed information with manufacturers or suppliers about the movement of their products. This includes data on sales, returns that are eligible for rebates, transfers, and sometimes non-physical movements, helping manufacturers gain visibility into how their products are performing across different locations and customer segments.

Canonical Element Type Definition Description IDoc mapping X12 mapping EDIFACT mapping
Schema structure – 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. – – –
  canonicalProductTransferResaleReportHeader – Payload for canonical Product Transfer Resale Report message. – segment BPT –
    processingFunctionTypeCode string

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

  • ORIGINAL - Original

  • REPLACE - Replace

 –

BPT01 =

  • 00 (ORIGINAL) or

  • 05 (REPLACE)

Use Java call-out to enum lookup table CL_ProcessingFunctionTypeCode.txt

 –
    productTransferResaleReportType string

Report type for message.

Valid values include:

  • PRODUCTTRANSFER - Product transfer report

  • RESALE - Resale

  • DISTRIBUTORCUSTOMERINVENTORY - Report between Distributor/Customer inventory report

  • DISTRIBUTORINVENTORY - Distributor inventory report

  • DISTRIBUTORMANUFACTURERINVENTORY - Report between Distributor/Manufacturer inventory report

  • INVOICE - Sellers invoice

  • MANUFACTURERDISTRIBUTORINVENTORY - Report between Manufacturer/Distributor inventory report

  • SELLERSALES - Seller sales report

  • MUTUALLYDEFINED - Mutually defined

 –

BPT04 =

  • 01 (PRODUCTTRANSFER) Or

  • 02 (RESALE) Or DC (DISTRIBUTORCUSTOMERINVENTORY) Or

  • DD (DISTRIBUTORINVENTORY) Or

  • DM (DISTRIBUTORMANUFACTURERINVENTORY) Or

  • IV (INVOICE) Or

  • MB (MANUFACTURERDISTRIBUTORINVENTORY) Or

  • SS (SELLERSALES) Or

  • ZZ (MUTUALLYDEFINED)

Use Java call-out to enum lookup table CL_ProductTransferResaleReportType

 –
    transactionReferenceIdentifierList array Transaction references for Product Transfer Resale Report at header level that affects the entire message. – segment BPT and REF –
      b2bTransactionIdentifierType string

Referenced document type.

Valid values include:

  • PRODUCTTRANSFERRESALEREPORT (Required)

  • PRECEDINGDOCUMENT - Reference to previous report number

  • INVOICE - Seller Invoice number

  • SUPPLIERORDER - Supplier order number

  • PURCHASEORDER - Purchase order number

  • DEBITMEMO - Sellers debit memo

  • CREDITMEMO - Buyer credit memo

  • ORIGINALINVOICE - Original invoice number

 –

REF01 =

  • IV (INVOICE) or

  • VN (SUPPLIERORDER) or

  • PO (PURCHASEORDER) or

  • DL (DEBITMEMO) or

  • CM (CREDITMEMO) or

  • OI (ORIGINALINVOICE)

 –
      b2bTransactionIdentifierValue string Document identifier for transaction referenced by b2bTransactionIdentifierType. –

BPT02 whereb2bTransactionIdentifierType = "PRODUCTTRANSFERRESALEREPORT" (Required) BPT09 whereb2bTransactionIdentifierType = "PRECEDINGDOCUMENT" REF02 where b2bTransactionIdentifierType =

  • INVOICE or

  • SUPPLIERORDER or

  • PURCHASEORDER or

  • DEBITMEMO or

  • CREDITMEMO or

  • ORIGINALINVOICE

 –
      transactionDate string

Date of Product Transfer Resale transaction created date in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.

HDA Note: This date should be greater then or equal to sale period end date.

 – BPT03 (Date) & BPT08 (Time) whereb2bTransactionIdentifierType = "PRODUCTTRANSFERRESALE" –
      epochTransactionDate integer Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. – – –
      lineItemNumber string Line item number in customer purchase order. Line item level only. – – –
    transactionReferenceInformation array

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

This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.

 – 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 value is SALESREGION - Sales Region Number.

 –

REF01 = SB (SALESREGION)

Use Java call-out to enumeration

lookup table for REF segment CL_TransactionReferenceType

 –
      transactionReferenceIdentifier string Transaction reference identifier value as defined by enumeration in transactionReferenceType. – REF02 –
      description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). – – –
      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 Product transfer resale report start and end dates. – – –
      dateType string

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

Valid values include:

  • REPORTSTART - Report start date

  • REPORTEND - Report end date

  • PURCHASEORDER - Purchase order date

  • STATUSAFTERINCLUSIVE - Status after and Including this date

  • STATUSPRIORINCLUSIVE - Status prior and Including this date

 –

DTM01 =

  • 090 (REPORTSTART) or

  • 091 (REPORTEND) or

  • 004 (PURCHASEORDER) or

  • 040 (STATUSAFTERINCLUSIVE) or

  • 041 (STATUSPRIORINCLUSIVE)

Use Java call-out to enumeration lookup table CL_DateType

 –
      dateValue string Date defined by referenced date type in date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – DTM02 & DTM03 (if time available) –
      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. – DTM04 –
    mpcCurrency 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/

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
        companyIdentifierValue string Company identifier value for business partner. – N104 –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – N301 –
        address2 string Supplemental street address. – N302 –
        city string City – N401 –
        district string District – – –
        state string State or region code – N402 –
        postalCode string Postal code – N403 –
        country string Country code – N404 –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building. – – –
        lscAddressIdentifier string LSC address identifier. – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – Hard code PER01 to "AJ" primary contact –
        contactName string Contact name – PER02 –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number. – PER04 where PER03 = "TE" –
        contactEmail string Contact email address. – PER06 where PER05 = "EM" –
    shipToBusinessInformation – Ship to party company identifiers and address information. – N101 = "ST" –
      businessPartyInformation – Contract party information. – N101 = "ST" –
        businessName string Business name for partner or location. – N102 –
        mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
          companyIdentifierType string

Company identifier type for business partner/

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
          companyIdentifierValue string Company identifier value for business partner. – N104 –
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
        address – Party address information. – – –
          address1 string Main street address. – N301 –
          address2 string Supplemental street address. – N302 –
          city string City – N401 –
          district string District – – –
          state string State or region code – N402 –
          postalCode string Postal code – N403 –
          country string Country code – N404 –
          telephone string Telephone number – – –
          fax string Fax number – – –
          url string Website URL – – –
          buildingNumber string Building number – – –
          plantNumber string Plant number – – –
          floorNumber string Floor number in building. – – –
          lscAddressIdentifier string LSC address identifier. – – –
          village string Village name – – –
          houseNumber string House number – – –
          township string Township – – –
          premisesCode string Premises code – – –
        companyLocationContactInformation – – – Hard code PER01 to "AJ" primary contact –
          contactName string Contact name – PER02 –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number – PER04 where PER03 = "TE" –
          contactEmail string Contact email address – PER06 where PER05 = "EM" –
        transactionReferenceInformation array

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

This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.

 – loop N1-N3-N4-REF –
          transactionReferenceType string Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier. – – –
          transactionReferenceIdentifier string

Transaction reference identifier value as defined by enumeration in transactionReferenceType.

HDA: Contract header type code defining identifier/description in description attribute (REF03).

 – – –
          description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). – – –
          transactionReferenceDate string Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –
          epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. – – –
    supplierBusinessInformation – Supplier party company identifiers and address information. – N101 = "SU" –
      businessName string Business name for partner or location. – N102 –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner/

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
        companyIdentifierValue string Company identifier value for business partner – N104 –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value – – –
      address – Party address information – – –
        address1 string Main street address – N301 –
        address2 string Supplemental street address – N302 –
        city string City – N401 –
        district string District – – –
        state string State or region code – N402 –
        postalCode string Postal code – N403 –
        country string Country code – N404 –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – Hard code PER01 to "AJ" primary contact –
        contactName string Contact name – PER02 –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – PER04 where PER03 = "TE" –
        contactEmail string Contact email address – PER06 where PER05 = "EM" –
    vendorBusinessInformation – Vendor party company identifiers and address information. – N101 = "VN" –
      businessName string Business name for partner or location – N102 –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean – – –
        companyIdentifierType string

Company identifier type for business partner/

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
        companyIdentifierValue string Company identifier value for business partner. – N104 –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – N301 –
        address2 string Supplemental street address. – N302 –
        city string City – N401 –
        district string District – – –
        state string State or region code – N402 –
        postalCode string Postal code – N403 –
        country string Country code – N404 –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – Hard code PER01 to "AJ" primary contact –
        contactName string Contact name – PER02 –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number. – PER04 where PER03 = "TE" –
        contactEmail string Contact email address. – PER06 where PER05 = "EM" –
    billToBusinessInformation – Bill to party company identifiers and address information. – N101 = "BT" –
      businessName string Business name for partner or location. – N102 –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner/

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
        companyIdentifierValue string Company identifier value for business partner. – N104 –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – N301 –
        address2 string Supplemental street address. – N302 –
        city string City – N401 –
        district string District – – –
        state string State or region code – N402 –
        postalCode string Postal code – N403 –
        country string Country code – N404 –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building. – – –
        lscAddressIdentifier string LSC address identifier. – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – Hard code PER01 to "AJ" primary contact –
        contactName string Contact name – PER02 –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – PER04 where PER03 = "TE" –
        contactEmail string Contact email address – PER06 where PER05 = "EM" –
    manufacturerBusinessInformation – Manufacturer company identifiers and address information. – N101 = "MF" –
      businessName string Business name for partner or location. – N102 –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
        companyIdentifierValue string Company identifier value for business partner. – N104 –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – N301 –
        address2 string Supplemental street address. – N302 –
        city string City – N401 –
        district string District – – –
        state string State or region code – N402 –
        postalCode string Postal code – N403 –
        country string Country code – N404 –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building. – – –
        lscAddressIdentifier string LSC address identifier. – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – Hard code PER01 to "AJ" primary contact –
        contactName string Contact name – PER02 –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – PER04 where PER03 = "TE" –
        contactEmail string Contact email address – PER06 where PER05 = "EM" –
    reportingLocationBusinessInformation – Reporting location company identifiers and address information. – N101 = "RL" –
      businessName string Business name for partner or location. – N102 –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
        companyIdentifierValue string Company identifier value for business partner. – N104 –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – N301 –
        address2 string Supplemental street address. – N302 –
        city string City – N401 –
        district string District – – –
        state string State or region code – N402 –
        postalCode string Postal code – N403 –
        country string Country code – N404 –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – Hard code PER01 to "AJ" primary contact –
        contactName string Contact name – PER02 –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number. – PER04 where PER03 = "TE" –
        contactEmail string Contact email address. – PER06 where PER05 = "EM" –
    distributorBusinessInformation – Distributor party company identifiers and address information. – N101 = "DS" –
      businessName string Business name for partner or location. – N102 –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
        companyIdentifierValue string Company identifier value for business partner. – N104 –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – N301 –
        address2 string Supplemental street address. – N302 –
        city string City – N401 –
        district string District –   –
        state string State or region code – N402 –
        postalCode string Postal code – N403 –
        country string Country code – N404 –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – Hard code PER01 to "AJ" primary contact –
        contactName string Contact name – PER02 –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – PER04 where PER03 = "TE" –
        contactEmail string Contact email address – PER06 where PER05 = "EM" –
    distributorBranchformation – Distributor branch location identifiers and address information. – N101 = "DB" –
      businessName string Business name for partner or location. – N102 –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
        companyIdentifierValue string Company identifier value for business partner. – N104 –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – N301 –
        address2 string Supplemental street address. – N302 –
        city string City – N401 –
        district string District –   –
        state string State or region code – N402 –
        postalCode string Postal code – N403 –
        country string Country code – N404 –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – Hard code PER01 to "AJ" primary contact –
        contactName string Contact name – PER02 –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number. – PER04 where PER03 = "TE" –
        contactEmail string Contact email address. – PER06 where PER05 = "EM" –
    freeTextNote array Free text/ instructions/ notes/ descriptions and other free text elements. – – –
      textReferenceCode string Text reference or subject code. Will map whatever is found. – – –
      textFunctionCode string Text function code. Will map whatever is found. – – –
      language string Language of free text. – – –
      textFormatCode string Format code for free text. – – –
      freeFormText string Free test string. – – –
    customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Header level. – – –
      name string Name of mapped field. – – –
      value string Value in named field. – – –
  canonicalProductTransferResaleReportItemDetails array Product Transfer or Resale Report item details. –

PTD segment HDA

Notes:Distributor in PTD01 can use either RV or the combination of RU and TD. All 3 code values should not be used together.

 –
    lineItemNumber string Line item number that have unique incremental value for each iteration of canonicalProductTransferResaleReportItemDetails array, this is for tracelink internal purpose. – – –
    productTransferCode string

Product transfer type code.

Valid values include:

  • CHARITABLECONTRIBUTION - Charitable Contribution

  • STOCKSALE - Stock Sale

  • DROPSHIPSALE - Drop and ship sale

  • INTERBRANCH - Inter branch transfer

  • INVENTORYADJUSTMENT - Inventory adjustment

  • RETURNTOVENDOR - Return from distributor customer to vendor

  • RETURNTOUSE - Return to useable inventory

  • DISPOSAL - Transfer for disposal

  • SHIPDEBITSALE - Ship and Debit sale

  • SAMPLE - Sample products

  • SUMMARY - Total sales from this location/ including different type of sales.

  • RETURN - Product return

  • CREDITREBILL - Credit Re-bill

 –

PTD01 =

  • CC (CHARITABLECONTRIBUTION) or

  • SS (STOCKSALE) or

  • DS (DROPSHIPSALE) or

  • IB (INTERBRANCH) or

  • IA (INVENTORYADJUSTMENT) or

  • RV (RETURNTOVENDOR) or

  • RU (RETURNTOUSE) or

  • TD (DISPOSAL) or

  • SD (SHIPDEBITSALE) or

  • SM (SAMPLE) or

  • SU (SUMMARY) or

  • BN (RETURN) or

  • CR (CREDITREBILL)

Use Java call-out to enumeration lookup table for PTD01 segment CL_ProductTransferCode

 –
    productTransferMovementType string

Product Transfer Movement Type Code

valid values:

  • ADJUSTMENTIN - Adjustment In

  • ADJUSTMENTOUT - Adjustment Out

  • CUSTOMERTODISTRIBUTOR - Customer to Distributor

  • DISTRIBUTORTOCUSTOMER - Distributor to Customer

  • DISTRIBUTORTOMANUFACTURER - Distributor to Manufacturer

  • MANUFACTURERTODISTRIBUTOR - Manufacturer to Distributor

  • TRANSFERIN - Transfer In

  • TRANSFEROUT - Transfer Out.

 –

PTD06 =

  • AI (ADJUSTMENTIN) Or

  • AO (ADJUSTMENTOUT) Or

  • CD (CUSTOMERTODISTRIBUTOR) Or

  • DC (DISTRIBUTORTOCUSTOMER) Or

  • DM (DISTRIBUTORTOMANUFACTURER) Or

  • MD (MANUFACTURERTODISTRIBUTOR) Or

  • TI (TRANSFERIN) Or

  • TO (TRANSFEROUT)

 –
    transactionReferenceIdentifierList array Transaction references for Product Transfer Resale Report at line item level. – segment PTD-REF –
      b2bTransactionIdentifierType string

Referenced document type.

Valid values include:

PURCHASEORDER - Purchase order number

CREDITMEMO - Buyer credit memo

INVOICE - Seller invoice number

SUPPLIERCONTRACT - Supplier contract number

QUOTE - Quote number

CONTRACT - Contract number

DISTRIBUTORINVOICE - Distributor invoice number

TRACKINGNUMBER - Track document change number

 –

REF01 =

  • PO (PURCHASEORDER) or

  • CM (CREDITMEMO) or

  • IV (INVOICE) or

  • CT (CONTRACT)

  • PTD04 =

  • VC (SUPPLIERCONTRACT) or

  • Q1 (QUOTE) or

  • CT (CONTRACT) or

  • DI (DISTRIBUTORINVOICE) or

  • 92 (TRACKINGNUMBER)

Use Java call-out to enumeration lookup table for PTD04 segment CL_B2BTransactionIdentifierType

 –
      b2bTransactionIdentifierValue string Document identifier for transaction referenced by b2bTransactionIdentifierType. –

REF02 where b2bTransactionIdentifierType =

  • PURCHASEORDER or

  • CREDITMEMO or

  • INVOICE or

  • CONTRACT

PTD05 = where b2bTransactionIdentifierType =

  • SUPPLIERCONTRACT or

  • QUOTE or

  • DISTRIBUTORINVOICE or

  • TRACKINGNUMBER

 –
      transactionDate string Date of Product Transfer Resale Report transaction created date in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –
      epochTransactionDate integer

Date transaction created in epoch integer date format.

Each string date recorded will have an epoch date format generated by a java exit.

 – – –
      lineItemNumber string Line item number in customer purchase order. Line item level only. – – –
    transactionReferenceInformation array

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

This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.

 – segment PTD-REF –
      transactionReferenceType string

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

Valid values include:

  • DISTRIBUTORINVOICE - Distributed invoice number

  • CUSTOM - Mutually defined information

  • REBATEIDENTIFIER - Rebate reference number

  • CONTRACT - Contract Number

 –

REF01 =

  • DI (DISTRIBUTORINVOICE)or

  • ZZ (CUSTOM) or

  • RY (REBATEIDENTIFIER)

Use Java call-out to enumeration lookup table

for REF segment CL_TransactionReferenceType

 –
      transactionReferenceIdentifier string Transaction reference identifier value as defined by enumeration in transactionReferenceType. –

REF02 when where transactionReferenceType =

  • DISTRIBUTORINVOICE or

  • CUSTOMor

  • REBATEIDENTIFIER

 –
      description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). – – –
      transactionReferenceDate string Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. – – –
      epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. – – –
    mpcDates array Dates relevant for product transfer resale report item. – loop PTD-QTY-DTM –
      dateType string

Date type at item level for responded to chargeback request in date format YYYYMMDD and time format (IDoc/ X12) HHMMSS.

The valid value is INVOICE - Invoice date.

 –

DTM01 = 003 (INVOICE)

Use Java call-out to enumeration

lookup table CL_DateType.txt

 –
      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. – – –
    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 PTD loop is required to identify customers belonging to the buying group or individual parties involved in product transfers.

 – segment PTD-N1 –
      businessPartyInformation – Ship to party company identifiers and address information. – N101 = "ST" –
        businessName string Business name for partner or location. – N102 –
        mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
          companyIdentifierType string

Company identifier type for business partner.

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
          companyIdentifierValue string Company identifier value for business partner – N104 –
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value – – –
        address – Party address information – – –
          address1 string Main street address – N301 –
          address2 string Supplemental street address – N302 –
          city string City – N401 –
          district string District – – –
          state string State or region code – N402 –
          postalCode string Postal code – N403 –
          country string Country code – N404 –
          telephone string Telephone number – – –
          fax string Fax number – – –
          url string Website URL – – –
          buildingNumber string Building number – – –
          plantNumber string Plant number – – –
          floorNumber string Floor number in building – – –
          lscAddressIdentifier string LSC address identifier – – –
          village string Village name – – –
          houseNumber string House number – – –
          township string Township – – –
          premisesCode string Premises code – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number – – –
          contactEmail string Contact email address – – –
      transactionReferenceInformation array

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

This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.

 – loop PTD-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:

  • DEA - Drug Enforcement Administration Number

  • HIN - Health Industry Number (HIN)

  • INTERNALCUSTOMERNUMBER - Internal customer/buyer number

 –

REF01 =

  • DH (DEA) or

  • HI (HIN) or

  • IT (INTERNALCUSTOMERNUMBER)

Use Java call-out to enumeration lookup table CL_TransactionReferenceType

 –
        transactionReferenceIdentifier string Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping. – REF02 –
        description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). – 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. – – –
      transactionReferenceIdentifierList array Transaction references for Product Transfer Resale Report at Partner level – loop PTD-N1-N3-N4-REF –
        b2bTransactionIdentifierType string

Referenced document type.

Valid values include:

  • ORDERNUMBER - Supplier order number

  • PURCHASEORDER - Purchase order number

 –

REF01 =

  • OQ (ORDERNUMBER) or

  • PO (PURCHASEORDER)

 –
        b2bTransactionIdentifierValue string Document identifier for transaction referenced by b2bTransactionIdentifierType. – REF02 –
        transactionDate string

Date of Product Transfer Resale transaction created date in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. HDA .

Note: This date should be greater then or equal to sale period end date.

 – – –
        epochTransactionDate integer

Date transaction created in epoch integer date format.

Each string date recorded will have an epoch date format generated by a java exit.

 – – –
        lineItemNumber string Line item number in customer purchase order. Line item level only. – – –
    billToShipToBusinessInformation – Bill to Ship to location identifiers and address information extended with reference and date type identifiers. – segment PTD-N1 –
      businessPartyInformation – Bill to Ship to party company identifiers and address information. – N101 = "BS" –
        businessName string Business name for partner or location – N102 –
        mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
          companyIdentifierType string

Company identifier type for business partner.

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
          companyIdentifierValue string Company identifier value for business partner. – N104 –
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
        address – Party address information. – – –
          address1 string Main street address. – N301 –
          address2 string Supplemental street address. – N302 –
          city string City – N401 –
          district string District – – –
          state string State or region code – N402 –
          postalCode string Postal code – N403 –
          country string Country code – N404 –
          telephone string Telephone number – – –
          fax string Fax number – – –
          url string Website URL – – –
          buildingNumber string Building number – – –
          plantNumber string Plant number – – –
          floorNumber string Floor number in building. – – –
          lscAddressIdentifier string LSC address identifier. – – –
          village string Village name – – –
          houseNumber string House number – – –
          township string Township – – –
          premisesCode string Premises code – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number. – – –
          contactEmail string Contact email address. – – –
      transactionReferenceInformation array

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

This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.

 – loop PTD-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:

  • DEA - Drug Enforcement Administration Number

  • HIN - Health Industry Number (HIN)

  • INTERNALCUSTOMERNUMBER - Internal customer/buyer number

 –

REF01 =

  • DH (DEA) or

  • HI (HIN)or

  • IT (INTERNALCUSTOMERNUMBER) or

Use Java call-out to enum lookup table CL_TransactionReferenceType

 –
        transactionReferenceIdentifier string Transaction reference identifier value as defined by enumeration in transactionReferenceType. Pass thru X12 mapping. – REF02 –
        description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). – 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. – – –
      transactionReferenceIdentifierList array Transaction references for Product Transfer Resale Report at Partner level – loop PTD-N1-N3-N4-REF –
        b2bTransactionIdentifierType string

Referenced document type.

Valid values:

  • ORDERNUMBER - Supplier order number

  • PURCHASEORDER - Purchase order number

 –

REF01 =

  • OQ (ORDERNUMBER) or

  • PO (PURCHASEORDER)

 –
        b2bTransactionIdentifierValue string Document identifier for transaction referenced by b2bTransactionIdentifierType. – REF02 –
        transactionDate string Date of Product Transfer Resale transaction created date in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. HDA Note: This date should be greater then or equal to sale period end date – – –
        epochTransactionDate integer

Date transaction created in epoch integer date format.

Each string date recorded will have an epoch date format generated by a java exit.

 – – –
        lineItemNumber string Line item number in customer purchase order. Line item level only. – – –
    manufacturerBusinessInformation – Manufacturer company identifiers and address information. – N101 = "MF" –
      businessName string Business name for partner or location – N102 –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean – – –
        companyIdentifierType string

Company identifier type for business partner.

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
        companyIdentifierValue string Company identifier value for business partner – N104 –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value – – –
      address – Party address information – – –
        address1 string Main street address – N301 –
        address2 string Supplemental street address – N302 –
        city string City – N401 –
        district string District –   –
        state string State or region code – N402 –
        postalCode string Postal code – N403 –
        country string Country code – N404 –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building – – –
        lscAddressIdentifier string LSC address identifier – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – Hard code PER01 to "AJ" primary contact –
        contactName string Contact name – PER02 –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – PER04 where PER03 = "TE" –
        contactEmail string Contact email address – PER06 where PER05 = "EM" –
    billToBusinessInformation – Bill to company identifiers and address information extended with reference and date type identifiers. – segment PTD-N1 –
      businessPartyInformation – Bill to party company identifiers and address information. – N101 = "BT" –
        businessName string Business name for partner or location. – N102 –
        mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
          companyIdentifierType string

Company identifier type for business partner.

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
          companyIdentifierValue string Company identifier value for business partner. – N104 –
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
        address – Party address information. – – –
          address1 string Main street address. – N301 –
          address2 string Supplemental street address. – N302 –
          city string City – N401 –
          district string District –   –
          state string State or region code – N402 –
          postalCode string Postal code – N403 –
          country string Country code – N404 –
          telephone string Telephone number – – –
          fax string Fax number – – –
          url string Website URL – – –
          buildingNumber string Building number – – –
          plantNumber string Plant number – – –
          floorNumber string Floor number in building – – –
          lscAddressIdentifier string LSC address identifier – – –
          village string Village name – – –
          houseNumber string House number – – –
          township string Township – – –
          premisesCode string Premises code – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number – – –
          contactEmail string Contact email address – – –
      transactionReferenceInformation array

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

This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.

 – loop PTD-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:

  • DEA - Drug Enforcement Administration Number

  • HIN - Health Industry Number (HIN)

  • INTERNALCUSTOMERNUMBER - Internal customer/buyer number

 –

REF01 =

  • DH (DEA) or

  • HI (HIN)or

  • IT (INTERNALCUSTOMERNUMBER) or

Use Java call-out to enum lookup table CL_TransactionReferenceType

 –
        transactionReferenceIdentifier string Transaction reference identifier value as defined by enum in transactionReferenceType. – REF02 –
        description string Identifier or description defined by qualifier code in transactionReferenceIdentifier . – 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. – – –
      transactionReferenceIdentifierList array Transaction references for Product Transfer Resale Report at Partner level. – loop PTD-N1-N3-N4-REF –
        b2bTransactionIdentifierType string

Referenced document type.

Valid values:

  • ORDERNUMBER - Supplier order number

  • PURCHASEORDER - Purchase order number

 –

REF01 =

  • OQ (ORDERNUMBER) or

  • PO (PURCHASEORDER)

 –
        b2bTransactionIdentifierValue string Document identifier for transaction referenced by b2bTransactionIdentifierType. – REF02 –
        transactionDate string

Date of Product Transfer Resale transaction created date in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.

HDA Note: This date should be greater then or equal to sale period end date.

 – – –
        epochTransactionDate integer Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. – – –
        lineItemNumber string Line item number in customer purchase order. Line item level only. – – –
    distributorBusinessInformation – Distributor party company identifiers and address information extended with dates and reference identifiers. – segment PTD-N1 –
      businessPartyInformation – Distributor group party information. – N101 = "DS" –
        businessName string Business name for partner or location. – N102 –
        mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
          companyIdentifierType string

Company identifier type for business partner/ valid.

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
          companyIdentifierValue string Company identifier value for business partner. – N104 –
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
        address – Party address information. – – –
          address1 string Main street address. – N301 –
          address2 string Supplemental street address. – N302 –
          city string City – N401 –
          district string District –   –
          state string State or region code – N402 –
          postalCode string Postal code – N403 –
          country string Country code – N404 –
          telephone string Telephone number – – –
          fax string Fax number – – –
          url string Website URL – – –
          buildingNumber string Building number – – –
          plantNumber string Plant number – – –
          floorNumber string Floor number in building – – –
          lscAddressIdentifier string LSC address identifier – – –
          village string Village name – – –
          houseNumber string House number – – –
          township string Township – – –
          premisesCode string Premises code – – –
        companyLocationContactInformation – – – – –
          contactName string Contact name – – –
          contactTitle string Title of contact – – –
          contactPhone string Contact phone number – – –
          contactEmail string Contact email address – – –
      transactionReferenceInformation array

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

This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.

 – loop PTD-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:

  • DEA - Drug Enforcement Administration Number

  • HIN - Health Industry Number (HIN)

  • INTERNALCUSTOMERNUMBER - Internal customer/buyer number

 –

REF01 = DH (DEA) or HI (HIN)or IT (INTERNALCUSTOMERNUMBER) or

Use Java call-out to enum lookup table CL_TransactionReferenceType

 –
        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. – – –
      transactionReferenceIdentifierList array Transaction references for Product Transfer Resale Report at Partner level. – loop PTD-N1-N3-N4-REF –
        b2bTransactionIdentifierType string

Referenced document type.

Valid values:

  • ORDERNUMBER - Supplier order number

  • PURCHASEORDER - Purchase order number

 –

REF01 =

  • OQ (ORDERNUMBER) or

  • PO (PURCHASEORDER)

 –
        b2bTransactionIdentifierValue string Document identifier for transaction referenced by b2bTransactionIdentifierType. – REF02 –
        transactionDate string

Date of Product Transfer Resale transaction created date in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available.

HDA Note: This date should be greater then or equal to sale period end date

 – – –
        epochTransactionDate integer Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. – – –
        lineItemNumber string Line item number in customer purchase order. Line item level only. – – –
    distributorBranchInformation – Distributor branch location identifiers and address information. – N101 = "DB" –
      businessName string Business name for partner or location. – N102 –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
        companyIdentifierValue string Company identifier value for business partner. – N104 –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. –   –
      address – Party address information. –   –
        address1 string Main street address. – N301 –
        address2 string Supplemental street address. – N302 –
        city string City – N401 –
        district string District –   –
        state string State or region code – N402 –
        postalCode string Postal code – N403 –
        country string Country code – N404 –
        telephone string Telephone number –   –
        fax string Fax number –   –
        url string Website URL –   –
        buildingNumber string Building number –   –
        plantNumber string Plant number –   –
        floorNumber string Floor number in building. –   –
        lscAddressIdentifier string LSC address identifier. –   –
        village string Village name –   –
        houseNumber string House number –   –
        township string Township –   –
        premisesCode string Premises code –   –
      companyLocationContactInformation – – – Hard code PER01 to "AJ" primary contact –
        contactName string Contact name. – PER02 –
        contactTitle string Title of contact. –   –
        contactPhone string Contact phone number. – PER04 where PER03 = "TE" –
        contactEmail string Contact email address. – PER06 where PER05 = "EM" –
    transferToPartyBusinessInformation – Transfer to Party business and address information. – N101 = "TT" –
      businessName string Business name for partner or location. – N102 –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
        companyIdentifierValue string Company identifier value for business partner. – N104 –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – N301 –
        address2 string Supplemental street address. – N302 –
        city string City – N401 –
        district string District – – –
        state string State or region code – N402 –
        postalCode string Postal code – N403 –
        country string Country code – N404 –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building. – – –
        lscAddressIdentifier string LSC address identifier. – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – Hard code PER01 to "AJ" primary contact –
        contactName string Contact name. – PER02 –
        contactTitle string Title of contact. – – –
        contactPhone string Contact phone number. – PER04 where PER03 = "TE" –
        contactEmail string Contact email address. – PER06 where PER05 = "EM" –
    diversionPayerBusinessInformation – Transfer to Party business and address information. – N101 = "BD" –
      businessName string Business name for partner or location. – N102 –
      mpcCompanyLocationIdentifierList array Identifier list for business party. – – –
        isIdentifierPresentInEvent boolean Is identifier present in event boolean. – – –
        companyIdentifierType string

Company identifier type for business partner.

Valid values:

  • DUNS - D-U-N-S number/ Dun and Bradstreet

  • SCAC - Standard Carrier Alpha Code

  • DUNS4 - D-U-N-S + 4r/ Dun and Bradstreet number plus suffix

  • DEA - Drug Enforcement Agency registration number

  • HIN - Health Industry Number

  • COMPANYID - Assigned by seller company identifier

  • COMPANYSITEID - Assigned by buyer company site identifier

  • GLN - Global Location Number

  • US_340B_ID - HDA payer identifier for 340B identifier.

 –

N103 Use Java call-out to enumeration

lookup table CL_CompanyIdentifierType

 –
        companyIdentifierValue string Company identifier value for business partner. – N104 –
        alternateCompanyLocationIdentifierValue string Alternate company location identifier value. – – –
      address – Party address information. – – –
        address1 string Main street address. – N301 –
        address2 string Supplemental street address. – N302 –
        city string City – N401 –
        district string District – – –
        state string State or region code – N402 –
        postalCode string Postal code – N403 –
        country string Country code – N404 –
        telephone string Telephone number – – –
        fax string Fax number – – –
        url string Website URL – – –
        buildingNumber string Building number – – –
        plantNumber string Plant number – – –
        floorNumber string Floor number in building. – – –
        lscAddressIdentifier string LSC address identifier. – – –
        village string Village name – – –
        houseNumber string House number – – –
        township string Township – – –
        premisesCode string Premises code – – –
      companyLocationContactInformation – – – Hard code PER01 to "AJ" primary contact –
        contactName string Contact name – PER02 –
        contactTitle string Title of contact – – –
        contactPhone string Contact phone number – PER04 where PER03 = "TE" –
        contactEmail string Contact email address – PER06 where PER05 = "EM" –
    productTransferQuantityDetails array Product Transfer Resale Report Quantity Details/ Product transfer Resale Report transaction is driven by quantity/ hence product/ unit/ price/ reference details are inside this loop. – segment loop PTD-QTY –
      lineItemNumber   string

Line item number for Product Transfer Quantity Details.

The line item number restarts and resets to 1 for each new loop of the productTransferQuantityDetails array.

 – LIN01 –
      lotNumber   string Lot or batch identifier. –

LIN03/ LIN05/ LIN07/ LIN09/ LIN11/ LIN13/

LIN15/ LIN17 when its pair qualifier is "LT"

 –
      productTransferResaleReportQuantity – – – segment QTY –
        quantityType string

Type of quantity recorded.

Valid values include:

  • SOLD- Quantity Sold

  • RETURNED - Quantity rebate returned

  • TRANSFER - Transfer quantity

  • SHIPPED - Shipped quantity

  • BATCHES - Number of batches

  • DAILYADJUSTED - Daily Adjustments

 –

QTY01 =

  • 32 (SOLD) or

  • 76 (RETURNED) or

  • V3 (TRANSFER) or

  • 39 (SHIPPED) or

  • 41 (BATCHES) or

  • AJ (DAILYADJUSTED)

Use Java call-out to enum lookup table CL_QuantityType.txt

 –
        quantityValue string Quantity of product transfer or report. – QTY02 –
        unitOfMeasure string Unit or Basis for Measurement Code. Unit of entry UOM's include: UN - Unit. – QTY03 Use Java call-out to enumeration lookup table UOM_TableLookup2.txt. –
      additionalItemDetails array To specify additional item details like price and quantity variation also to capture the total demand for the line item product/ which is yet to fulfilled. – segment QTY - PO3 –
        additionalItemChangeReasonCode string

Code specifying change or reason code in quantity or price.

valid values:

  • CHANGEDDATE - Changed date

  • ESTIMATEDQUANTITY - Estimated quantity

  • ONHANDQUANTITY - Quantity on hand

  • ORDEREDQUANTITY - Quantity Ordered

  • UNITPRICE - Unit price changes

  • MUTUALLYDEFINED - Custom value

 –

P0301 =

  • DC (CHANGEDDATE) Or

  • EV (ESTIMATEDQUANTITY) Or

  • QH (ONHANDQUANTITY) Or

  • QO (ORDEREDQUANTITY) Or

  • UP (UNITPRICE) Or

  • ZZ (MUTUALLYDEFINED)

 –
        dateValue string Provision to provide date change. – PO302 –
        quantityValue string Product quantity related to the change reason code. – P0306 –
        unitOfMeasure string Unit or Basis for Measurement Code. Unit of entry UOM's include: UN - Unit. – PO307 Use Java call-out to enumeration lookup table UOM_TableLookup2.txt. –
        itemUnitPrice number Additional item changed unit price. – P0304 –
        unitPriceTypeCode string

Code identifying the type of unit price.

  • CONTRACT - Price according to the contract

  • WHOLESALE - Wholesale price

  • DISTRIBUTOR - Distributor price

  • NET - Net price

  • RESALE - Resale price

  • CATALOG - Catalog price

  • DEALER - Dealer price

  • DISCOUNT - Discount price

 –

PO303 =

  • CT (CONTRACT) Or

  • WH (WHOLESALE) Or

  • DI (DISTRIBUTOR) Or

  • NT (NET) Or

  • RS (RESALE) Or

  • CA (CATALOG) Or

  • DR (DEALER) Or

  • DS (DISCOUNT)

 –
        description string Additional item change description. – – –
      productCodesIdentifiers array

Product code identifier types and values.

Only one instance of productCodesIdentifiers per productTransferQuantityDetails loop.

 – map productCodeType and Value pair from/to LIN02/ LIN03 through LIN16/LIN17 (Except "LT") –
        productCodeType string

Code to qualify product identifier type.

Valid values include:

  • EAN251

  • US_NDC442

  • US_NDC532

  • US_NDC541

  • US_NDC542

  • CASEUPC

  • GTIN14

  • VENDORCATALOG

  • US_NDC

  • US_NHRIC

  • PACKAGEUPC

 – LIN02/ LIN04/ LIN06 / LIN08/ LIN10/ LIN12/ LIN14/ LIN16 , Except for "LT", use Java call-out to enumeration lookup table CL_ProductCodeType.txt –
        productCodeValue string Product code identifier value. – LIN03/ LIN05/ LIN07/ LIN09/ LIN11/ LIN13/ LIN15/ LIN17 –
      productItemInformation array Product item code information. Only using product name. – PTD-QTY-PID –
        productLanguageCode string Language for product description. – – –
        productName string Name of product. – – –
        genericName string Generic name for product. – – –
        productDescription string Description of the product defined by the current product identifier. – PID05 Hard code "F" (free text) to PID01 –
      productSalesMeasurements array Specifies same type of product market demand(total sales) and this specified product market share information. – PTD-QTY-MEA –
        measurementCategory string

Broad category of measurement to which measurement type belongs to or applies.

valid values include:

  • ACTUALTOTAL - Total market sales

  • MARKETSHARE - Penetration of apex sales

 – MEA01 =AF (ACTUALTOTAL) or AK (MARKETSHARE) –
        measurementType string

Code identifying a measurement type for a measurement value.

The valid value is NUMBEROFSALES - No of comparable sales.

 – MEA02 =AY (NUMBEROFSALES) –
        measurementValue string The value of the measurement. – MEA03 –
        unitOfMeasure string Unit of measure for the measurement type and value recorded. –

MEA04

Use Java call-out to enumeration lookup table UOM_TableLookup2.txt.

 –
      unitDetailInformation array Specifies item unit details that are being reported in this report. – segment loop PTD-QTY-UIT –
        unitOfMeasure string

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

  • UN - Unit (HDA)

  • PK - Package

  • EA - Each

 –

UIT01 =

  • UN (UN) or

  • EA (EA) or

  • PK (PK)

Use Java call-out to enumeration lookup table UOM_TableLookup2.txt

 –
        itemUnitPrice number Unit price for product. – UIT02 –
        unitPriceTypeCode string

Code identifying the type of unit price.

Valid values include:

  • CONTRACT - Contract price

  • DISTRIBUTOR - Distributor price

  • NET - Net price

  • RESALE - Resale price

  • WHOLESALE - Wholesale

  • DEALER - Dealer price

  • DISCOUNT - Discounted unit price.

  • CATALOG - Catalog price

 –

UIT03 =

  • CT (CONTRACT) or

  • DI (DISTRIBUTOR) or

  • NT (NET) or

  • RS (RESALE) or

  • WH (WHOLESALE) or

  • DR (DELEAR) or

  • DS (DISCOUNT)

  • CA (CATALOG)

 –
      productTransferResaleReportAmount array Line item total amounts – segment loop PTD-QTY-AMT –
        pricingType string

Pricing type for invoice item.

Valid value:

  • LINEITEMTOTAL - Line item total.

  • CHARGEBACKCLAIM - Chargeback Claim Amount

  • CLAIMANTREQUESTEDTOTAL - Claimant Requested Total

  • NET - Net Adjustment

  • SUBMITTEDCHARGEBACK - Submitted Chargeback Claim Amount

  • TOTAL - Total Payment

  • ITEMDISCREPANCYUNITCOST - Unit Cost of Discrepant Material

 –

AMT01 =

  • 1 (LINEITEMTOTAL) Or

  • CC (CHARGEBACKCLAIM) Or

  • CM (CLAIMANTREQUESTEDTOTAL) Or

  • NA (NET) Or

  • S (SUBMITTEDCHARGEBACK) Or

  • TP (TOTAL) Or

  • Z3 (ITEMDISCREPANCYUNITCOST)

 –
        pricingAmount string Total 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 =

  • C (true)

  • D (false)

 –
      creditsAndCharges array Allowances and charges for line level if any exists at line level. – segment loop PTD-QTY-ITA –
        creditChargeKeyType string

Key identifies credit or charges as discounts or additional charges.

Valid values:

  • PROMOTION - Promotion

  • ALLOWANCE - Allowance details

  • CHARGE - Charges details

 –

ITA01 =

  • P (PROMOTION)

  • A (ALLOWANCE) or

  • C (CHARGE)

 –
        creditChargeConditionType string Credit charge condition type. SAP pass thru mapping. –   –
        creditChargeType string

Code representing type of credit or charge.

The valid value is HANDLING - PERITEM.

 –   –
        creditChargeAmount string Total amount for the payment Note: Promotion amount is already netted out of the price reflected in the unit price. – ITA07 (Implicit Decimal) –
        qualifyingAmount string Amount qualifying for cash discount/ allowance/ promotion/ service or charge. –   –
        creditChargePercentRate string Percentage rate for cash discount/ allowance/ promotion/ service or charge. – ITA06 –
        percentRateBasisTypeCode string Code indicating basis that allowance or charge percent is calculated. –   –
        creditChargeCurrencyCode string Currency code for credit or charge. –   –
        creditChargeHandlingCode string

Method of handling for discount or charge.

The valid value is OFFINVOICE - Offinvoice.

 – ITA04 = 02 (OFFINVOICE) –
        description string Description of credit or charge. –   –
        unitPriceAmount string Unit price amount. –   –
        unitPriceBasisQuantity string Quantity basis for the unit price. –   –
        itemQuantity string Item quantity. –   –
        unitOfMeasure string Base unit of measure or UOM for quantity of item in pack. –   –
        baseValue string Base value. –   –
      transactionReferenceIdentifierList array Transaction references for Product Transfer Resale Report at quantity level. – segment PTD-QTY-REF –
        b2bTransactionIdentifierType string

Referenced document type.

Valid values:

  • INVOICE - Seller Invoice number

  • ORIGINALINVOICE - Original invoice number

  • TRACKINGNUMBER - Tracking number

  • DOCUMENT - Document number

  • ORIGINALPURCHSAEORDER - Original purchase order number

  • CUSTOMERCONTRACT - Buyer contract number

  • CREDITDEBITADJUSTMENT - Credit/ Debit adjustmnet number

 –

REF01 =

  • IV (INVOICE) or

  • OI (ORIGINALINVOICE) Or

  • 2I (TRACKINGNUMBER) Or

  • DD (DOCUMENT) Or

  • OP (ORIGINALPURCHSAEORDER) Or

  • BC (CUSTOMERCONTRACT) Or

  • 1X (CREDITDEBITADJUSTMENT)

 –
        b2bTransactionIdentifierValue string Document identifier for transaction referenced by b2bTransactionIdentifierType. – REF02 –
        transactionDate string Date of Product Transfer Resale Report transaction created date in format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. –   –
        epochTransactionDate integer Date transaction created in epoch integer date format. Each string date recorded will have an epoch date format generated by a java exit. –   –
        lineItemNumber string Line item number in customer purchase order. Line item level only. –   –
      transactionReferenceInformation array

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

This group would map to X12 segments REF and N9 and EDIFACT RFF for information other than transaction documents.

 – loop PTD-QTY-REF –
        transactionReferenceType string

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

Valid values include:

  • LOTNUMBER – Lot number

  • CREDITREFERENCE – Credit reference number

  • LINEITEMNUMBER – Line item number

  • ITEMNUMBER – Item number

  • PLANTIDENTIFIER – Plant number

  • REBATEIDENTIFIER – Rebate number

  • DISTRIBUTORINVOICE – Distributor invoic

  • CUSTOM – Custom defined number

 –

REF01 =

  • LT (LOTNUMBER) Or

  • 8V (CREDITREFERENCE) Or

  • DI (DISTRIBUTORINVOICE) Or

  • RY (REBATEIDENTIFIER) Or

  • ZZ (CUSTOM) Or

  • IX (ITEMNUMBER) Or

  • PE (PLANTIDENTIFIER) Or

  • LI (LINEITEMNUMBER)

Use Java call-out to enumeration lookup table CL_TransactionReferenceType

 –
        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 adjustment item. Optional segment. – loop PTD-QTY-DTM –
        dateType string

Date type at item level for respond to chargeback request in date format YYYYMMDD and time format (IDoc/ X12) HHMMSS.

Valid values:

  • CREDITADVICE - Credit advice date

  • INVOICE - Invoice date

  • TRANSFER - Transfer date

  • PURCHASEORDER - Purchase order date

  • SHIPPED - Shipped date

 –

DTM01 =

  • 003 (INVOICE) or

  • 188 (CREDITADVICE) or

  • 514 (TRANSFER) or

  • 004 (PURCHASEORDER) or

  • 011 (SHIPPED)

Use Java call-out to enumeration lookup table CL_DateType.txt

 –
        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. –   –
      referencedSerialNumberList array

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 PTD-QTY-LX –
        lineItemNumber string

Line item number for referenced serial number. Sequential number that begins with 1 and is incremented with each loop of the referencedSerialNumberList array.

The line item number restarts and resets to 1 for each new loop of the productTransferQuantityDetails array.

 – LX01 –
        serializedLotInformationList array

Reference information for identifiers that are related to transaction documents.

This group would map to X12 segments for serial number information.

 – loop PTD-QTY-LX-REF –
          lotNumber string product lot number. –   –
          expirationDate string Product expiration date. –   –
          serialNumberValue string Product unique serial number. – REF02 Hardcode REF01 = SE (SERIALNUMBER) –
    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. –   –
  canonicalProductTransferResaleReportAmount array Product transfer resale report summary level amounts. – segment loop CTT-AMT –
    pricingType string

Pricing type for invoice item.

Valid value:

  • CHARGEBACKCLAIM - Chargeback Claim Amount

  • NET - Net Adjustment

  • SUBMITTEDCHARGEBACK - Submitted Chargeback Claim Amount

  • TOTAL - Total Payment

  • TOTALSALES - Total sales amount

  • TOTALTRANSACTION - Total transaction amount

 –

AMT01 =

  • CC (CHARGEBACKCLAIM) Or

  • NA (NET) Or

  • S (SUBMITTEDCHARGEBACK) Or

  • TP (TOTAL) Or

  • TS (TOTALSALES) Or

  • TT (TOTALTRANSACTION)

 –
    pricingAmount string Total 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 =

  • C (true)

  • D (false)

 –
  canonicalProductTransferResaleReportSummary array Summary totals for Product Transfer Resale Report. – CTT –
    summaryType string

Summary type for Product Transfer Resale Report. Number of line items.

Valid value:

  • NUMBEROFITEMS

  • TOTALQUANTITY

–   –
    summaryValue string Summary value. –

CTT01 when summaryType is NUMBEROFITEMS

CTT02 when summaryType is TOTALQUANTITY

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

Tag end