DX STF Client API

<back to all web services

AddCustomerMaster

Customer Master Requests

Customer Master

Requires Authentication
The following routes are available for this service:
POST/api/customerMasterAdd new customer master
AddCustomerMaster Parameters:
NameParameterData TypeRequiredDescription
CustomerMastermodelCustomerMasterMessageYesCustomer Master model containing all of the Customer Master data
CustomerMasterMessage Parameters:
NameParameterData TypeRequiredDescription
DataSourceformTransactionalPartyYes
DataRecipientformTransactionalPartyYes
CustomerMasterIdentificationformstringYes
CustomerformList<CustomerMasterType>Yes
DocumentStatusCodeformstringYes
DocumentActionCodeformstringYes
CreationDateTimeformDateTimeNo
LastUpdateDateTimeformDateTimeNo
TransactionalParty Parameters:
NameParameterData TypeRequiredDescription
ContactformList<Contact>Yes
AddressformAddressYes
CommunicationChannelformList<AvpList>Yes
FinancialInstitutionInformationformFinancialInstitutionInformationYes
DutyFeeTaxRegistrationformstringYes
EntityIdentificationformstringYes
Ecom_PartyIdentificationType Parameters:
NameParameterData TypeRequiredDescription
GlnformstringYes
NameformstringYes
AdditionalPartyIdentificationformList<AvpList>Yes
AvpList Parameters:
NameParameterData TypeRequiredDescription
CodeformstringYes
ValueformstringYes
Contact Parameters:
NameParameterData TypeRequiredDescription
ContactTypeCodeformstringYes
PersonNameformstringYes
DepartmentNameformstringYes
JobTitleformstringYes
ResponsibilityformstringYes
CommunicationChannelformList<CommunicationChannel>Yes
CommunicationChannel Parameters:
NameParameterData TypeRequiredDescription
CommunicationChannelCodeformstringYes
CommunicationChannelNameformstringYes
CommunicationValueformstringYes
Address Parameters:
NameParameterData TypeRequiredDescription
StreetAddressOneformstringYes
StreetAddressTwoformstringYes
StreetAddressThreeformstringYes
CityformstringYes
PostalCodeformstringYes
ProvinceCodeformstringYes
CountryCodeformstringYes
FinancialInstitutionInformation Parameters:
NameParameterData TypeRequiredDescription
FinancialInstitutionBranchNameformstringYes
FinancialInstitutionNameformstringYes
FinancialRoutingNumberformFinancialRoutingNumberYes
FinancialAccountformFinancialAccountYes
SwiftCodeformstringYes
ExportersCodeformstringYes
FinancialRoutingNumber Parameters:
NameParameterData TypeRequiredDescription
NumberformstringYes
NumberTypeCodeformstringYes
FinancialAccount Parameters:
NameParameterData TypeRequiredDescription
NumberformstringYes
NumberTypeCodeformstringYes
NameformstringYes
CustomerMasterType Parameters:
NameParameterData TypeRequiredDescription
PayByCustomerformCustomerRecordYes
BillToCustomerformCustomerRecordYes
RoutingCodeformstringYes
StoreTypeformstringYes
CurrencyCodeformstringYes
TypeformstringYes
GroupformstringYes
RegionformstringYes
ZoneRateformstringYes
TaxRuleformstringYes
PaymentTermformstringYes
ShipmentSiteformstringYes
ShipmentSiteNameformstringYes
ShipmentSiteGlnformstringYes
AccountingCodeformstringYes
CommercialRepresentativeformstringYes
CommercialTerritoryformstringYes
CreditformCreditLimitYes
NODformList<string>Yes
NDDformList<string>Yes
CustomerRecord Parameters:
NameParameterData TypeRequiredDescription
GlnformstringYes
CodeformstringYes
NameformstringYes
BuyerAssignedVendorNoformstringYes
SupplierAssignedVendorNoformstringYes
DutyFeeTaxRegistrationformstringYes
EntityIdentificationformstringYes
ContactformList<Contact>Yes
AddressformCustomerMasterAddressYes
AvpListformList<AvpList>Yes
CustomerMasterAddress Parameters:
NameParameterData TypeRequiredDescription
AddressTypeformstringYes
CreditLimit Parameters:
NameParameterData TypeRequiredDescription
LimitformdecimalNo
BalanceformdecimalNo
AvailableformdecimalNo
EffectiveDateTimeformDateTime?No
TokenDto Parameters:
NameParameterData TypeRequiredDescription
TokenformGuidNo

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

HTTP + CSV

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

POST /api/customerMaster HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"customerMaster":{"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"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{}