Partner Master Data Guidelines (XML)

See How To Use this Guide before interpreting the guidelines below.

Message Type: MDX_TRADE_PARTNER_MASTER

Info Exchange Display Name: Partner Master Data

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.
Partner Master Data Exchange errors are reported in Info Exchange. In addition, a ProcessingResponse message (specifically the ie:PartnerMasterDataSpec element within the message) may be generated and sent to the message sender with the process results indicating the message's successes or failures, though this is contingent on the Workflow settings in Company Administration.
Data Element Occurs
Length
Type Description
mdx:MDXPartnerMasterMessage [1...1]
[-]
-

Required. Root element of message.

  mdx:ControlFileHeader [1...1]
[-]
-

Required. XML file control header record.

    cmn:FileSenderNumber [1...1]
[1/20]
String

Required. File sender's company identifier. *1

    cmn:FileReceiverNumber [1...1]
[1/20]
String

Required. File recipient's company identifier. *2

    cmn:FileControlNumber [1...1]
[1/*]
String

Required. Unique file control ID number. *3

    cmn:FileDate [1...1]
[10/10]
Date

Required. Date file generated in XML YYYY-MM-DD format. *4

    cmn:FileTime [1...1]
[9/9]
Time

Required. Time file generated in XML HH:MM:SSZ format (must be GMT). *5

  mdx:MessageBody [1...1]
[-]
-

Required. Main body of message.

    mdx:PartnerCompanyMasterItem [0...*]
[-]
-

Captures the full master data record for a partner company. This is a repeating element to enable the ability to provide data for each trade partner company in a single message. Partner Locations that are dependent to the partner company are in the mdx:PartnerLocationMasterItem element group. When providing updates to existing partner company master data, a full master data dump is not required. Only the company master data records for trade partners whose company master data has changed need to be submitted. However, when submitting a change record, the entire trade partner company record should be submitted. The trade partner locations do not need to be resubmitted unless those individual records have changed.

      cmn:PrimaryCompanyId [1...1]
[1/*]
String

Required. Primary company identifier that is used as the key for updating the partner master data record. For regulatory use: *6

  • Argentina: Provide both GLN and CUIT to identify sold from and sold to entities.
  • Brazil: Provide the CNPJ to identify sold from/to and ship from/to entities.
  • Turkey: Provide the GLN to identify sold from and sold to entities.
  • US: Provide the GLN, SGLN, DEA, and HIN to identify sold from and sold to entities for EPCIS events.
        @type [1...1]
[1/*]
String

Required. Attribute that identifies the company id type. *7

See the LocationId enumeration list for valid values.

      cmn:NewPrimaryCompanyId [0...1]
[0/*]
String

New primary company identifier to replace the original primary identifier. This value is used as the new key for updating the partner master data record. *8

        @type [1...1]
[1/*]
String

Required. Attribute that identifies the company id type and includes same values as above. *9

See the LocationId enumeration list for valid values.

      mdx:AlternateCompanyIds [0...1]
[-]
-

A list of one or more alternate company identifiers used to refer to this company.

        cmn:AlternateCompanyId [1...*]
[1/*]
String

Required. Alternate company identifier that is used to identify the company. For regulatory use: *10

  • Argentina: Provide both GLN and CUIT to identify sold from and sold to entities.
  • Brazil: Provide the CNPJ to identify sold from/to and ship from/to entities.
  • Turkey: Provide the GLN to identify sold from and sold to entities.
  • US: Provide the GLN, SGLN, DEA, and HIN to identify sold from and sold to entities for EPCIS events.
          @type [1...1]
[1/*]
String

Required. Attribute that identifies the company ID types. *11

Only one of the following values may be used at once:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the CompanyId enumeration list for valid values.

          @action [0...1]
[0/*]
String

Attribute defining if the alternate product identifier should be deleted. The delete action only occurs if explicitly set to DELETE. *12

      cmn:RecordStatus [1...1]
[1/*]
String

Required. Indicates if master data record status is Active or Inactive. *13

See the RecordStatus enumeration list for valid values.

      mdx:PartnerCompanyInformation [-]
[-]
-

Required. Captures the business name and address master data field for the partner company.

        cmn:BusinessName [1...1]
[1/*]
String

Required. The business name. *14

        cmn:BusinessType [1...1]
[1/*]
String

The business entity type. *15

See the BusinessType enumeration list for valid values.

        cmn:Street1 [1...1]
[1/*]
String

Conditionally required if any of the following elements is present:

  • cmn:Street1
  • cmn:Street2
  • cmn:BuildingNumber
  • cmn:PlantNumber
  • cmn:FloorNumber
  • cmn:City
  • cmn:District
  • cmn:StateOrRegion
  • cmn:PostalCode
  • cmn:Country
  • cmn:AddressObjectGUID
  • cmn:HouseGUID
  • cmn:TaxRegistrationCode

The first line of the street address. *16

        cmn:Street2 [0...1]
[0/*]
String

The second line of the street address. *17

        cmn:BuildingNumber [0...1]
[0/*]
String

The building number of the facility. *18

        cmn:PlantNumber [0...1]
[0/*]
String

The plant number associated with the facility, if the facility is a plant. *19

        cmn:FloorNumber [0...1]
[0/*]
String

The floor number of the facility. *20

        cmn:City [1...1]
[1/*]
String

Conditionally required if any of the following elements is present:

  • cmn:Street1
  • cmn:Street2
  • cmn:BuildingNumber
  • cmn:PlantNumber
  • cmn:FloorNumber
  • cmn:City
  • cmn:District
  • cmn:StateOrRegion
  • cmn:PostalCode
  • cmn:Country
  • cmn:AddressObjectGUID
  • cmn:HouseGUID
  • cmn:TaxRegistrationCode

The city. *21

        cmn:Village [0...1]
[0/*]
String Village name in which the company is located.
        cmn:HouseNumber [0...1]
[0/*]
String Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1.
        cmn:Township [0...1]
[0/*]
String Name of town in which the company is located.
        cmn:District [0...1]
[0/*]
String

District Code only for India.

Must be a 3-digit numeric code.
        cmn:StateOrRegion [1...1]
[1/6]
String

Conditionally required if any of the following elements is present:

  • cmn:Street1
  • cmn:Street2
  • cmn:BuildingNumber
  • cmn:PlantNumber
  • cmn:FloorNumber
  • cmn:City
  • cmn:District
  • cmn:StateOrRegion
  • cmn:PostalCode
  • cmn:Country
  • cmn:AddressObjectGUID
  • cmn:HouseGUID
  • cmn:TaxRegistrationCode

The state, province, or region using the standard two- or three-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *22

        cmn:PostalCode [0...1]
[1/*]
String

Conditionally required if the country has a postal code. The ZIP or other postal code that is operational for countries that do not have a postal code. See NoPostalCodes for exclusions. If country does have a postal code and it is omitted, an error will be generated. *23

        cmn:Country [1...1]
[1/3]
String

Conditionally required if any of the following elements is present:

  • cmn:Street1
  • cmn:Street2
  • cmn:BuildingNumber
  • cmn:PlantNumber
  • cmn:FloorNumber
  • cmn:City
  • cmn:District
  • cmn:StateOrRegion
  • cmn:PostalCode
  • cmn:Country
  • cmn:AddressObjectGUID
  • cmn:HouseGUID
  • cmn:TaxRegistrationCode

The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *24

        cmn:CorporateTelephone [0...1]
[0/*]
String

The telephone number of the corporate office. *25

        cmn:CorporateEmail [0...1]
[0/*]
String

The email address of corporate contact. *26

        cmn:CorporateFax [0...1]
[0/*]
String Company fax number.
        cmn:AddressObjectGUID [0...1]
[0/36]
String

Conditionally required for Russia. The global identifier assigned by Russian Federation Information Address System (FIAS). *27

Maximum 36 characters, using the digits 0-9 and letters A-F.
        cmn:HouseGUID [0...1]
[0/36]
String

The global House identifier assigned by the Russian Federation Information Address System (FIAS). *28

Maximum 36 characters, using the digits 0-9 and letters A-F.
        cmn:TaxRegistrationCode [0...1]
[0/*]
String

The tax registration code. Allows TraceLink owners to differentiate between their Partners and their Partner locations for legal or tax purposes.

        cmn:PremisesCode [0...1]
[0/*]
String Identifier representing a physical area within the company location (e.g. a location's second floor).
      mdx:PartnerLicenseList [0...1]
[-]
-

List of one or more federal or state license numbers of the company for this facility that permit drug distribution.

        cmn:LicenseInfo [1...*]
[1/*]
String

Required. The license information of the company for this facility. Combination of License Number, Country, State or Region, and Agency. *29

Must not already be assigned to another company inside the application owner's instance of MDX.
          @agency [0...1]
[0/*]
String

The agency that granted the license. *30

          @country [1...1]
[1/3]
String

Required. Country in which facility is licensed using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *31

          @stateOrRegion [0...1]
[0/6]
String

The state or region in which the trading partner is licensed, using the standard two- or three-letter abbreviation specified in ISO 3166-2:1998 country sub-division code. *32

          @action [0...1]
[0/*]
String

Attribute defining if the license should be deleted. The delete action only occurs if explicitly set to DELETE. *33

      mdx:PartnerContactInfo [0...1]
[-]
-

Identification of the person or department contact to verify the regulatory data exchanged.

        cmn:Name [1...1]
[1/*]
String

Name of person or department to contact to verify pedigree, serialization, and transaction information. *34

        cmn:Title [0...1]
[0/*]
String

The title of the contact person. For regulatory use. *35

        cmn:Telephone [1...1]
[1/*]
String

The phone number of the contact department or individual at the company. This must begin with the + character followed by the Country Calling Code. *36

        cmn:Email [1...1]
[1/*]
String

The email address of the contact department or individual at the partner company. *37

    mdx:PartnerLocationMasterItem [0...*]
[-]
-

Captures the full master data record for a partner location. This is a repeating element to enable the ability to provide data for each trade partner location in a single message. Partner locations that are dependent on the partner company are in the PartnerLocationMasterItem element group. When providing updates to existing partner company location data, a full master data dump is not required. Only the location master data records for trade partners whose location master data has changed need to be submitted. However, when submitting a change record, the entire trade partner location record should be submitted. The trade partner locations do not need to be resubmitted unless those individual records have changed.

      cmn:CompanyIdReference [1...1]
[1/*]
String

Required. Primary company identifier for the company to which the location belongs. *38

        @type [1...1]
[1/*]
String

Attribute identifies the company ID types. *39

Only one of the following values may be used at once:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the CompanyId enumeration list for valid values.

      cmn:PrimaryLocationId [1...1]
[1/*]
String

Required. Primary location identifier that is used as the key for updating the location master data record. For regulatory use:  *40

  • Argentina: Provide both GLN and CUIT to identify sold from and sold to entities.
  • Brazil: Provide the CNPJ to identify sold from/to and ship from /to entities.
  • Turkey: Provide the GLN to identify sold from and sold to entities.
  • US: Provide the GLN, SGLN, DEA, and HIN to identify sold from and sold to entities for EPCIS events.
        @type [1...1]
[1/*]
String

Required. Attribute identifies the location id types. *41

See the LocationId enumeration list for valid values.

      cmn:NewPrimaryLocationId [0...1]
[0/*]
String

New primary location identifier to replace the original primary identifier, which is used as the new key for updating the partner location master data record. *42

        @type [1...1]
[1/*]
String

Required. Attribute identifies the location id types and includes same values as above. *43

See the LocationId enumeration list for valid values.

      mdx:AlternateLocationIds [0...1]
[-]
-

A list of one or more alternate location identifiers used to refer to this location.

        cmn:AlternateLocationId [1...*]
[1/*]
String

Required. Alternate location identifier that is used to identify the company. For regulatory use:

  • Argentina: requires GLN and CUIT to identify sold from and sold to entities.
  • Brazil: requires CNPJ to identify sold from/to and ship from /to entities.
  • Turkey: requires GLN to identify sold from and sold to entities.
  • US: use of GLN, SGLN, DEA, and HIN to identify sold from and sold to entities for EPCIS events.
          @type [1...1]
[1/*]
String

Required. Attribute that identifies the location id types.

Only one of the following values may be used at once:
  • RU_INN_FOREIGN_ENTITY
  • RU_INN_INDIV
  • RU_INN_LOCAL_ENTITY

See the CompanyId enumeration list for valid values.

          @action [0...1]
[0/*]
String

Attribute defining if the alternate product identifier should be deleted. The delete action only occurs if explicitly set to DELETE. *44

      cmn:RecordStatus [1...1]
[1/*]
String

Required. Indicates if master data record status is Active or Inactive. *45

See the RecordStatus enumeration list for valid values.

      mdx:PartnerLocationInformation [1...*]
[-]
-

Required. Captures the business name and address master data fields for the partner location.

        cmn:LocationName [1...1]
[1/*]
String

Required. The name of the business location. Can be the same as the parent company. *46

        cmn:Street1 [1...1]
[1/*]
String

Conditionally required if any of the following elements is present:

  • cmn:Street1
  • cmn:Street2
  • cmn:BuildingNumber
  • cmn:PlantNumber
  • cmn:FloorNumber
  • cmn:City
  • cmn:District
  • cmn:StateOrRegion
  • cmn:PostalCode
  • cmn:Country
  • cmn:AddressObjectGUID
  • cmn:HouseGUID
  • cmn:TaxRegistrationCode

The first line of the street address. *47

        cmn:Street2 [0...1]
[0/*]
String

The second line of the street address. *48

        cmn:BuildingNumber [0...1]
[0/*]
String

The building number of the facility. *49

        cmn:PlantNumber [0...1]
[0/*]
String

The plant number associated with the facility, if the facility is a plant. *50

        cmn:FloorNumber [0...1]
[0/*]
String

The floor number of the facility. *51

        cmn:City [1...1]
[1/*]
String

Conditionally required if any of the following elements is present:

  • cmn:Street1
  • cmn:Street2
  • cmn:BuildingNumber
  • cmn:PlantNumber
  • cmn:FloorNumber
  • cmn:City
  • cmn:District
  • cmn:StateOrRegion
  • cmn:PostalCode
  • cmn:Country
  • cmn:AddressObjectGUID
  • cmn:HouseGUID
  • cmn:TaxRegistrationCode

The city. *52

        cmn:Village [0...1]
[0/*]
String Village name in which the company is located.
        cmn:HouseNumber [0...1]
[0/*]
String Building, house, or unit number of the company. House numbers are usually only separated from the street address in China. For all addresses outside of China, continue to enter the building, house, or unit number in Street1.
        cmn:Township [0...1]
[0/*]
String Name of town in which the company is located.
        cmn:District [0...1]
[0/*]
String

District Code only for India.

Must be a 3-digit numeric code.
        cmn:StateOrRegion [1...1]
[1/6]
String

Conditionally required if any of the following elements is present:

  • cmn:Street1
  • cmn:Street2
  • cmn:BuildingNumber
  • cmn:PlantNumber
  • cmn:FloorNumber
  • cmn:City
  • cmn:District
  • cmn:StateOrRegion
  • cmn:PostalCode
  • cmn:Country
  • cmn:AddressObjectGUID
  • cmn:HouseGUID
  • cmn:TaxRegistrationCode

The state, province, or region using the standard two- or three-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *53

        cmn:PostalCode [0...1]
[1/*]
String

Conditionally required for countries that have a postal code. The ZIP or other postal code Operational for countries that do not have a postal code. See NoPostalCodes for exclusions. If country does have a postal code and it is omitted, an error is generated.

        cmn:Country [1...1]
[1/3]
String

Conditionally required if any of the following elements is present:

  • cmn:Street1
  • cmn:Street2
  • cmn:BuildingNumber
  • cmn:PlantNumber
  • cmn:FloorNumber
  • cmn:City
  • cmn:District
  • cmn:StateOrRegion
  • cmn:PostalCode
  • cmn:Country
  • cmn:AddressObjectGUID
  • cmn:HouseGUID
  • cmn:TaxRegistrationCode

The country using the standard two-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *54

        cmn:CorporateTelephone [0...1]
[0/*]
String

Conditionally required for India. The telephone number of the corporate office.

        cmn:CorporateEmail [0...1]
[0/*]
String

Conditionally required for India. The email address of corporate contact.

        cmn:CorporateFax [0...1]
[0/*]
String Company fax number.
        cmn:AddressObjectGUID [0...1]
[0/*]
String

Conditionally required for Russia. The global identifier assigned by Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
        cmn:HouseGUID [0...1]
[0/*]
String

The global House identifier assigned by the Russian Federation Information Address System (FIAS).

Maximum 36 characters, using the digits 0-9 and letters A-F.
        cmn:TaxRegistrationCode [0...1]
[0/*]
String

The tax registration code. Allows TraceLink owners to differentiate between their Partners and their Partner locations for legal or tax purposes.

        cmn:PremisesCode [0...1]
[0/*]
String Identifier representing a physical area within the company location (e.g. a location's second floor).
      mdx:PartnerLicenseList [0...1]
[-]
-

List of one or more federal or state license numbers of the company for this facility that permit drug distribution.

        cmn:LicenseInfo [1...*]
[1/*]
String

Required. The license information of the company for this facility. Combination of License Number, Country, State or Region, and Agency. *55

Must not already be assigned to another company inside the application owner's instance of MDX.
          @agency [0...1]
[0/*]
String

The agency that granted the license. *56

          @country [1...1]
[1/3]
String

Required. Country in which facility is licensed using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code.

          @stateOrRegion [0...1]
[0/6]
String

The state or region in which the trading partner is licensed, using the standard two- or three-letter abbreviation specified in ISO 3166-2:1998 country sub-division code.

          @action [0...1]
[0/*]
String

Attribute defining if the license should be deleted. The delete action only occurs if explicitly set to DELETE. *57

      mdx:PartnerContactInfo [0...1]
[-]
-

Identification of person or department contact to verify regulatory data exchanged.

        cmn:Name [1...1]
[1/*]
String

Required. Name of person or department to contact to verify pedigree, serialization, and transaction information. *58

        cmn:Title [0...1]
[0/*]
String

Conditionally required for India. The title of the contact person.

        cmn:Telephone [1...1]
[1/*]
String

Required. The phone number of the contact department or individual at the company. This must begin with the + character followed by the Country Calling Code. *59

        cmn:Email [1...1]
[1/*]
String

Required. The email address of the contact department or individual at the company. *60