Company Master Data Guidelines (XML)

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

Message Type: MDX_COMPANY_MASTER

Info Exchange Display Name: Company 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.

Company Master Data Exchange errors are reported in Info Exchange. In addition, a ProcessingResponse message (specifically the ie:CompanyMasterDataSpec 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:MDXCompanyMasterMessage						[1...1] [-]	-	Required. XML message root element.
	mdx:ControlFileHeader					[1...1] [-]	-	Required. XML file control header record.
		cmn:FileSenderNumber				[1...1] [1/20]	String	Required. Unique identification key for the organization that created the standard business document. *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:CompanyMasterItem				[0...1] [-]	-	Captures updates to an existing company master data record. Resubmitting all master data elements is not required when updating company master data. Only the company master data elements that have been changed need to be submitted. Although it is not required to resubmit all master data elements when updating a company record, it is best practice that the entire company record be submitted. The company locations do not need to be resubmitted unless those individual records have changed.
			cmn:PrimaryCompanyId			[1...1] [1/*]	String	Required. Value for the primary company identifier that is used as the key for updating the company master data record. For regulatory use: *6
				@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	Value of the new primary company identifier that replaces the current primary company identifier. This value is used as the new key for updating the company master data record. *8
				@type		[1...1] [1/*]	String	Conditionally required if cmn:NewPrimaryCompanyId is present. The attribute that identifies the new primary company identifier type. *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	Conditionally required if mdx:AlternateCompanyIds is present. The value of the additional company identifier used to refer to this company. *10
					@type	[1...1] [1/*]	String	Conditionally required if mdx:AlternateCompanyIds is present. The attribute that identifies the alternate company identifier type. *11 See the CompanyId enumeration list for valid values.
					@action	[0...1] [0/*]	String	Indicates if the alternate company identifier will be deleted from the company master data record. The alternate company identifier is only deleted if the value is set to `DELETE`. If any other value is entered or if the value is blank, the alternate company identifier is added to the company master data record. *12
			cmn:RecordStatus			[1...1] [1/*]	String	Conditionally required if mdx:AlternateCompanyIds is present. Indicates whether the company master data record is active. *13 See the RecordStatus enumeration list for valid values.
			mdx:CompanyInformation			[-] [-]	-	Required. Captures the business and address information of the company.
				cmn:BusinessName		[1...1] [1/*]	String	Required. The name of the business. *14
				cmn:BusinessType		[1...1] [1/*]	String	The type of business the company conducts. *15 See the BusinessType enumeration list for valid values.
				cmn:Street1		[1...1] [1/*]	String	Conditionally required if any of the following elements are 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 company's street address. *16
				cmn:Street2		[0...1] [0/*]	String	The second line of the company's street address. *17
				cmn:BuildingNumber		[0...1] [0/*]	String	The company's building number. *18
				cmn:PlantNumber		[0...1] [0/*]	String	The company's plant number. *19
				cmn:FloorNumber		[0...1] [0/*]	String	The company's floor number. *20
				cmn:City		[1...1] [1/*]	String	Conditionally required if any of the following elements are 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 that the company is located in. *21
				cmn:Village		[0...1] [0/*]	String	Village that the company is located in.
				cmn:HouseNumber		[0...1] [0/*]	String	Identifying number of the building, house, or unit (e.g. 14B) for this company. House numbers are only separated from the street address for addresses 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 the township that the company is located in.
				cmn:District		[0...1] [0/*]	String	3-digit numeric code of the district where the company is located in India.
				cmn:StateOrRegion		[1...1] [1/6]	String	Conditionally required if any of the following elements are 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 the standard two- or three-letter abbreviation specified in the ISO 3166-2:1998 country subdivision code. *22
				cmn:PostalCode		[0...1] [1/*]	String	Conditionally required if the country has postal codes. The ZIP or other postal codes are used by the country. *23
				cmn:Country		[1...1] [1/3]	String	Conditionally required if any of the following elements are 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 that the company is located in, identified by 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 company's email address. *26
				cmn:CorporateFax		[0...1] [0/*]	String	The company’s fax number.
				cmn:CorporateURL		[0...1] [0/*]	String	The company’s website URL.
				cmn:AddressObjectGUID		[0...1] [0/36]	String	The global identifier assigned by the 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	Optional. 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 code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code).
				cmn:PremisesCode		[0...1] [0/*]	String	The internal identifier associated with this company (e.g. a company with 4 locations in the city of Mumbai internally refers to the 4th location as MUM4).
			mdx:CompanyContactInfo			[0...1] [-]	-	Identifies the person or department to contact to verify the authenticity, serialization, and transaction information related to any regulatory data (i.e. the details of compliance report sent to a government agency) exchanged by the company.
				cmn:Name		[1...] [1/]	String	Conditionally required if mdx:CompanyContactInfo is present. The name of the person or department to contact. *29
				cmn:Title		[1...] [1/]	String	The title of the contact person or department. *30
				cmn:Telephone		[1...] [1/]	String	The phone number of the contact person or department at the company. The phone number must begin with the plus (+) character, followed by the country calling code. *31
				cmn:Email		[1...] [1/]	String	The email address of the contact person or department at the company. *32
		mdx:CompanyLocationMasterItem				[0...*] [-]	-	Captures the full master data record for a company location. This is a repeating element to enable providing data for each company location in a single message. Company locations that belong to the parent company are recorded in the CompanyLocationMasterItem element group. Although it is not required to resubmit all of company location master data elements for the company location being updated, it is best practice that the entire company location record be submitted.
			cmn:CompanyIdReference			[1...1] [1/*]	String	Conditionally required if mdx:CompanyLocationMasterItemis present. The value of the primary identifier for the company that the location belongs to. *33
				@type		[1...1] [1/*]	String	Conditionally required if mdx:CompanyLocationMasterItemis present. The primary identifier for the company that the location belongs to. *34 See the CompanyId enumeration list for valid values.
			cmn:PrimaryLocationId			[1...1] [1/*]	String	Conditionally required if mdx:CompanyLocationMasterItemis present. The value of the primary company location identifier that is used as the key for updating the company location master data record. *35
				@type		[1...1] [1/*]	String	Conditionally required if mdx:CompanyLocationMasterItemis present The primary company location identifier type. *36 See the CompanyId enumeration list for valid values.
			cmn:NewPrimaryLocationId			[1...1] [1/*]	String	The value of the new primary company location identifier that replaces the current primary company location identifier. This value is used as the new key for updating the company master data record. *37
				@type		[1...1] [1/*]	String	Conditionally required if cmn:NewPrimaryLocationIdis present. The attribute that identifies the new primary company location identifier type. *38 See the CompanyId enumeration list for valid values.
			mdx:AlternateLocationIds			[0...1] [0/*]	String	A list of one or more additional company location identifiers used to refer to this company location.
				cmn:AlternateLocationId		[1...1] [1/*]	String	Conditionally required if mdx:AlternateLocationIdsis present. The value of the identifier that is used to identify the company location.
					@type	[1...1] [1/*]	String	Conditionally required if mdx:AlternateLocationIds is present. The attribute that identifies the alternate company location identifier type. See the CompanyId enumeration list for valid values.
					@action	[0...1] [0/*]	String	Indicates if the alternate company location identifier will be deleted from the company location master data record. The alternate company location identifier is only deleted if the value is set to `DELETE`. If any other value is entered or if the value is blank, the alternate company location identifier is added to the company location master data record. *39
			cmn:RecordStatus			[1...1] [1/*]	String	Conditionally required if mdx:AlternateLocationIds is present. Indicates whether the company location master data record is active. *40 See the RecordStatus enumeration list for valid values.
			mdx:CompanyLocationInformation			[1...1] [1/*]	String	Required. Captures the business and address information of the company.
				cmn:LocationName		[1...1] [1/*]	String	Required. The name of the business location. Can be the same as the parent company. *41
				cmn:BusinessType		[1...1] [1/*]	String	The type of business the location conducts. *42 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. *43
				cmn:Street2		[0...1] [0/*]	String	The second line of the location's street address. *44
				cmn:BuildingNumber		[0...1] [0/*]	String	The location's building number. *45
				cmn:PlantNumber		[0...1] [0/*]	String	The location's plant number. *46
				cmn:FloorNumber		[0...1] [0/*]	String	The location's floor number. *47
				cmn:City		[1...1] [1/*]	String	Conditionally required if any of the following elements are 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 that the location is located in. *48
				cmn:Village		[0...1] [0/*]	String	The village that the company location is located in.
				cmn:HouseNumber		[0...1] [0/*]	String	The identifying number of the building, house, or unit (e.g. 14B) for this location. House numbers are only separated from the street address for addresses 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	The name of the township that the company location is located in.
				cmn:District		[0...1] [0/*]	String	The 3-digit numeric code of the district where the company location is located in India.
				cmn:StateOrRegion		[1...1] [1/6]	String	Conditionally required if any of the following elements are 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 that the location is located in using the standard two- or three-letter abbreviation specified in ISO 3166-2:1998 country subdivision code. *49
				cmn:PostalCode		[0...1] [1/*]	String	Conditionally required if the country has a postal codes. The ZIP or other postal codes that are used by a country. 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 are 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 that the company location is located in, identified by using the standard two- or three-letter abbreviation specified in ISO 3166-1alpha-2:1997 country code. *50
				cmn:CorporateTelephone		[0...1] [0/*]	String	The telephone number of the location's corporate office.
				cmn:CorporateEmail		[0...1] [0/*]	String	The location's email address.
				cmn:CorporateFax		[0...1] [0/*]	String	The location’s fax number.
				cmn:CorporateURL		[0...1] [0/*]	String	The location’s website URL.
				cmn:Affiliate		[0...1] [0/*]	String	Indicates whether the location is a separate business entity or a subsidiary of the company that the location belongs to. `true` - The location is a subsidiarity of the company that the location belongs to. `false` - The location is a separate business entity from the company.
				cmn:AddressObjectGUID		[0...1] [0/*]	String	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 code used to identify this entity for tax or other legal reporting purposes (e.g. a Russia KPP Registration Code).
				cmn:PremisesCode		[0...1] [0/*]	String	The internal identifier associated with this location (e.g. a location with 4 locations in the city of Mumbai internally refers to the 4th location as MUM4).
			mdx:CompanyLocationLicenseList			[0...1] [-]	-	A list of one or more federal or state license numbers for this location that are required for its role in the pharmaceutical industry.
				cmn:LicenseInfo		[1...] [1/]	String	Conditionally required if mdx:CompanyLocationLicenseList is present. The license information for this location. *51
					@agency	[0...1] [0/*]	String	The agency that granted the license. *52
					@country	[1...1] [1/3]	String	Conditionally required if mdx:CompanyLocationLicenseList is present. The country that the location is licensed. in using the standard two- or three-letter abbreviation specified in ISO 3166-1 alpha-2:1997 country code.
					@stateOrRegion	[0...1] [0/6]	String	The state or region that the location is licensed in, using the standard two- or three-letter abbreviation specified in ISO 3166-2:1998 country sub-division code.
					@action	[0...1] [0/*]	String	Indicates if the license should be deleted from the company location master data record. The license is only deleted if the value is set to `DELETE`If any other value is entered or if the value is blank, the license is added to the company location's master data record. *53
			mdx:CompanyLocationContactInfo			[0...1] [-]	-	Identifies the person or department to contact to verify the authenticity, serialization, and transaction information related to any regulatory data (i.e. the details of compliance report sent to a government agency) exchanged by the company.
				cmn:Name		[1...1] [1/*]	String	Conditionally required if mdx:CompanyLocationContactInfo is present. Name of person or department to contact. *54
				cmn:Title		[0...1] [0/*]	String	The title of the contact person or department.
				cmn:Telephone		[1...1] [1/*]	String	The phone number of the contact person or department at the location. The phone number must begin with the plus (+) character, followed by the country calling code. *55
				cmn:Email		[1...1] [1/*]	String	The email address of the contact person or department at the location. *56