DX STF Client API

GetCustomerMasterByIdentification

Customer Master Requests

Customer Master

The following routes are available for this service:
GET	/api/customerMaster/{OwnerGln}/{CustomerMasterIdentification}	Get specific customer by customerMasterIdentification Id

**GetCustomerMasterByIdentification** Parameters:
Name	Parameter	Data Type	Required	Description
OwnerGln	path	string	Yes	Owner GLN
CustomerMasterIdentification	path	string	Yes	Customer Master Identification

**CustomerMasterMessage** Parameters:
Name	Parameter	Data Type	Required
DataSource	form	TransactionalParty	Yes
DataRecipient	form	TransactionalParty	Yes
CustomerMasterIdentification	form	string	Yes
Customer	form	List<CustomerMasterType>	Yes
DocumentStatusCode	form	string	Yes
DocumentActionCode	form	string	Yes
CreationDateTime	form	DateTime	No
LastUpdateDateTime	form	DateTime	No

**TransactionalParty** Parameters:
Name	Parameter	Data Type	Required
Contact	form	List<Contact>	Yes
Address	form	Address	Yes
CommunicationChannel	form	List<AvpList>	Yes
FinancialInstitutionInformation	form	FinancialInstitutionInformation	Yes
DutyFeeTaxRegistration	form	string	Yes
EntityIdentification	form	string	Yes

**Ecom_PartyIdentificationType** Parameters:
Name	Parameter	Data Type	Required
Gln	form	string	Yes
Name	form	string	Yes
AdditionalPartyIdentification	form	List<AvpList>	Yes

**AvpList** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	Yes
Value	form	string	Yes

**Contact** Parameters:
Name	Parameter	Data Type	Required
ContactTypeCode	form	string	Yes
PersonName	form	string	Yes
DepartmentName	form	string	Yes
JobTitle	form	string	Yes
Responsibility	form	string	Yes
CommunicationChannel	form	List<CommunicationChannel>	Yes

**CommunicationChannel** Parameters:
Name	Parameter	Data Type	Required
CommunicationChannelCode	form	string	Yes
CommunicationChannelName	form	string	Yes
CommunicationValue	form	string	Yes

**Address** Parameters:
Name	Parameter	Data Type	Required
StreetAddressOne	form	string	Yes
StreetAddressTwo	form	string	Yes
StreetAddressThree	form	string	Yes
City	form	string	Yes
PostalCode	form	string	Yes
ProvinceCode	form	string	Yes
CountryCode	form	string	Yes

**FinancialInstitutionInformation** Parameters:
Name	Parameter	Data Type	Required
FinancialInstitutionBranchName	form	string	Yes
FinancialInstitutionName	form	string	Yes
FinancialRoutingNumber	form	FinancialRoutingNumber	Yes
FinancialAccount	form	FinancialAccount	Yes
SwiftCode	form	string	Yes
ExportersCode	form	string	Yes

**FinancialRoutingNumber** Parameters:
Name	Parameter	Data Type	Required	Description
Number	form	string	Yes
NumberTypeCode	form	string	Yes

**FinancialAccount** Parameters:
Name	Parameter	Data Type	Required
Number	form	string	Yes
NumberTypeCode	form	string	Yes
Name	form	string	Yes

**CustomerMasterType** Parameters:
Name	Parameter	Data Type	Required
PayByCustomer	form	CustomerRecord	Yes
BillToCustomer	form	CustomerRecord	Yes
RoutingCode	form	string	Yes
StoreType	form	string	Yes
CurrencyCode	form	string	Yes
Type	form	string	Yes
Group	form	string	Yes
Region	form	string	Yes
ZoneRate	form	string	Yes
TaxRule	form	string	Yes
PaymentTerm	form	string	Yes
ShipmentSite	form	string	Yes
ShipmentSiteName	form	string	Yes
ShipmentSiteGln	form	string	Yes
AccountingCode	form	string	Yes
CommercialRepresentative	form	string	Yes
CommercialTerritory	form	string	Yes
Credit	form	CreditLimit	Yes
NOD	form	List<string>	Yes
NDD	form	List<string>	Yes

**CustomerRecord** Parameters:
Name	Parameter	Data Type	Required
Gln	form	string	Yes
Code	form	string	Yes
Name	form	string	Yes
BuyerAssignedVendorNo	form	string	Yes
SupplierAssignedVendorNo	form	string	Yes
DutyFeeTaxRegistration	form	string	Yes
EntityIdentification	form	string	Yes
Contact	form	List<Contact>	Yes
Address	form	CustomerMasterAddress	Yes
AvpList	form	List<AvpList>	Yes

**CustomerMasterAddress** Parameters:
Name	Parameter	Data Type	Required	Description
AddressType	form	string	Yes

**CreditLimit** Parameters:
Name	Parameter	Data Type	Required
Limit	form	decimal	No
Balance	form	decimal	No
Available	form	decimal	No
EffectiveDateTime	form	DateTime?	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/customerMaster/{OwnerGln}/{CustomerMasterIdentification} HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	dataSource: 
	{
		contact: 
		[
			{
				contactTypeCode: String,
				personName: String,
				departmentName: String,
				jobTitle: String,
				responsibility: String,
				communicationChannel: 
				[
					{
						communicationChannelCode: String,
						communicationChannelName: String,
						communicationValue: String
					}
				]
			}
		],
		address: 
		{
			streetAddressOne: String,
			streetAddressTwo: String,
			streetAddressThree: String,
			city: String,
			postalCode: String,
			provinceCode: String,
			countryCode: String
		},
		communicationChannel: 
		[
			{
				code: String,
				value: String
			}
		],
		financialInstitutionInformation: 
		{
			financialInstitutionBranchName: String,
			financialInstitutionName: String,
			financialRoutingNumber: 
			{
				number: String,
				numberTypeCode: String
			},
			financialAccount: 
			{
				number: String,
				numberTypeCode: String,
				name: String
			},
			swiftCode: String,
			exportersCode: String
		},
		dutyFeeTaxRegistration: String,
		entityIdentification: String,
		gln: String,
		name: String,
		additionalPartyIdentification: 
		[
			{
				code: String,
				value: String
			}
		]
	},
	dataRecipient: 
	{
		contact: 
		[
			{
				contactTypeCode: String,
				personName: String,
				departmentName: String,
				jobTitle: String,
				responsibility: String,
				communicationChannel: 
				[
					{
						communicationChannelCode: String,
						communicationChannelName: String,
						communicationValue: String
					}
				]
			}
		],
		address: 
		{
			streetAddressOne: String,
			streetAddressTwo: String,
			streetAddressThree: String,
			city: String,
			postalCode: String,
			provinceCode: String,
			countryCode: String
		},
		communicationChannel: 
		[
			{
				code: String,
				value: String
			}
		],
		financialInstitutionInformation: 
		{
			financialInstitutionBranchName: String,
			financialInstitutionName: String,
			financialRoutingNumber: 
			{
				number: String,
				numberTypeCode: String
			},
			financialAccount: 
			{
				number: String,
				numberTypeCode: String,
				name: String
			},
			swiftCode: String,
			exportersCode: String
		},
		dutyFeeTaxRegistration: String,
		entityIdentification: String,
		gln: String,
		name: String,
		additionalPartyIdentification: 
		[
			{
				code: String,
				value: String
			}
		]
	},
	customerMasterIdentification: String,
	customer: 
	[
		{
			payByCustomer: 
			{
				gln: String,
				code: String,
				name: String,
				buyerAssignedVendorNo: String,
				supplierAssignedVendorNo: String,
				dutyFeeTaxRegistration: String,
				entityIdentification: String,
				contact: 
				[
					{
						contactTypeCode: String,
						personName: String,
						departmentName: String,
						jobTitle: String,
						responsibility: String,
						communicationChannel: 
						[
							{
								communicationChannelCode: String,
								communicationChannelName: String,
								communicationValue: String
							}
						]
					}
				],
				address: 
				{
					addressType: String,
					streetAddressOne: String,
					streetAddressTwo: String,
					streetAddressThree: String,
					city: String,
					postalCode: String,
					provinceCode: String,
					countryCode: String
				},
				avpList: 
				[
					{
						code: String,
						value: String
					}
				]
			},
			billToCustomer: 
			{
				gln: String,
				code: String,
				name: String,
				buyerAssignedVendorNo: String,
				supplierAssignedVendorNo: String,
				dutyFeeTaxRegistration: String,
				entityIdentification: String,
				contact: 
				[
					{
						contactTypeCode: String,
						personName: String,
						departmentName: String,
						jobTitle: String,
						responsibility: String,
						communicationChannel: 
						[
							{
								communicationChannelCode: String,
								communicationChannelName: String,
								communicationValue: String
							}
						]
					}
				],
				address: 
				{
					addressType: String,
					streetAddressOne: String,
					streetAddressTwo: String,
					streetAddressThree: String,
					city: String,
					postalCode: String,
					provinceCode: String,
					countryCode: String
				},
				avpList: 
				[
					{
						code: String,
						value: String
					}
				]
			},
			routingCode: String,
			storeType: String,
			currencyCode: String,
			type: String,
			group: String,
			region: String,
			zoneRate: String,
			taxRule: String,
			paymentTerm: String,
			shipmentSite: String,
			shipmentSiteName: String,
			shipmentSiteGln: String,
			accountingCode: String,
			commercialRepresentative: String,
			commercialTerritory: String,
			credit: 
			{
				limit: 0,
				balance: 0,
				available: 0,
				effectiveDateTime: 0001-01-01
			},
			nod: 
			[
				String
			],
			ndd: 
			[
				String
			],
			gln: String,
			code: String,
			name: String,
			buyerAssignedVendorNo: String,
			supplierAssignedVendorNo: String,
			dutyFeeTaxRegistration: String,
			entityIdentification: String,
			contact: 
			[
				{
					contactTypeCode: String,
					personName: String,
					departmentName: String,
					jobTitle: String,
					responsibility: String,
					communicationChannel: 
					[
						{
							communicationChannelCode: String,
							communicationChannelName: String,
							communicationValue: String
						}
					]
				}
			],
			address: 
			{
				addressType: String,
				streetAddressOne: String,
				streetAddressTwo: String,
				streetAddressThree: String,
				city: String,
				postalCode: String,
				provinceCode: String,
				countryCode: String
			},
			avpList: 
			[
				{
					code: String,
					value: String
				}
			]
		}
	],
	documentStatusCode: String,
	documentActionCode: String
}