| GET | /api/customerMaster/{OwnerGln}/{CustomerMasterIdentification} | Get specific customer by customerMasterIdentification Id |
|---|
"use strict";
export class AvpList {
/** @param {{code?:string,value?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
code;
/** @type {string} */
value;
}
export class Ecom_PartyIdentificationType {
/** @param {{gln?:string,name?:string,additionalPartyIdentification?:AvpList[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
gln;
/** @type {string} */
name;
/** @type {AvpList[]} */
additionalPartyIdentification = [];
}
export class CommunicationChannel {
/** @param {{communicationChannelCode?:string,communicationChannelName?:string,communicationValue?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
communicationChannelCode;
/** @type {string} */
communicationChannelName;
/** @type {string} */
communicationValue;
}
export class Contact {
/** @param {{contactTypeCode?:string,personName?:string,departmentName?:string,jobTitle?:string,responsibility?:string,communicationChannel?:CommunicationChannel[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
contactTypeCode;
/** @type {string} */
personName;
/** @type {string} */
departmentName;
/** @type {string} */
jobTitle;
/** @type {string} */
responsibility;
/** @type {CommunicationChannel[]} */
communicationChannel = [];
}
export class Address {
/** @param {{streetAddressOne?:string,streetAddressTwo?:string,streetAddressThree?:string,city?:string,postalCode?:string,provinceCode?:string,countryCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
streetAddressOne;
/** @type {string} */
streetAddressTwo;
/** @type {string} */
streetAddressThree;
/** @type {string} */
city;
/** @type {string} */
postalCode;
/** @type {string} */
provinceCode;
/** @type {string} */
countryCode;
}
export class FinancialRoutingNumber {
/** @param {{number?:string,numberTypeCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
number;
/** @type {string} */
numberTypeCode;
}
export class FinancialAccount {
/** @param {{number?:string,numberTypeCode?:string,name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
number;
/** @type {string} */
numberTypeCode;
/** @type {string} */
name;
}
export class FinancialInstitutionInformation {
/** @param {{financialInstitutionBranchName?:string,financialInstitutionName?:string,financialRoutingNumber?:FinancialRoutingNumber,financialAccount?:FinancialAccount,swiftCode?:string,exportersCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
financialInstitutionBranchName;
/** @type {string} */
financialInstitutionName;
/** @type {FinancialRoutingNumber} */
financialRoutingNumber;
/** @type {FinancialAccount} */
financialAccount;
/** @type {string} */
swiftCode;
/** @type {string} */
exportersCode;
}
export class TransactionalParty extends Ecom_PartyIdentificationType {
/** @param {{contact?:Contact[],address?:Address,communicationChannel?:AvpList[],financialInstitutionInformation?:FinancialInstitutionInformation,dutyFeeTaxRegistration?:string,entityIdentification?:string,gln?:string,name?:string,additionalPartyIdentification?:AvpList[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {Contact[]} */
contact = [];
/** @type {Address} */
address;
/** @type {AvpList[]} */
communicationChannel = [];
/** @type {FinancialInstitutionInformation} */
financialInstitutionInformation;
/** @type {string} */
dutyFeeTaxRegistration;
/** @type {string} */
entityIdentification;
}
export class CustomerMasterAddress extends Address {
/** @param {{addressType?:string,streetAddressOne?:string,streetAddressTwo?:string,streetAddressThree?:string,city?:string,postalCode?:string,provinceCode?:string,countryCode?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
addressType;
}
export class CustomerRecord {
/** @param {{gln?:string,code?:string,name?:string,buyerAssignedVendorNo?:string,supplierAssignedVendorNo?:string,dutyFeeTaxRegistration?:string,entityIdentification?:string,contact?:Contact[],address?:CustomerMasterAddress,avpList?:AvpList[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
gln;
/** @type {string} */
code;
/** @type {string} */
name;
/** @type {string} */
buyerAssignedVendorNo;
/** @type {string} */
supplierAssignedVendorNo;
/** @type {string} */
dutyFeeTaxRegistration;
/** @type {string} */
entityIdentification;
/** @type {Contact[]} */
contact = [];
/** @type {CustomerMasterAddress} */
address;
/** @type {AvpList[]} */
avpList = [];
}
export class CreditLimit {
/** @param {{limit?:number,balance?:number,available?:number,effectiveDateTime?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
limit;
/** @type {number} */
balance;
/** @type {number} */
available;
/** @type {?string} */
effectiveDateTime;
}
export class CustomerMasterType extends CustomerRecord {
/** @param {{payByCustomer?:CustomerRecord,billToCustomer?:CustomerRecord,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?:CreditLimit,nod?:string[],ndd?:string[],gln?:string,code?:string,name?:string,buyerAssignedVendorNo?:string,supplierAssignedVendorNo?:string,dutyFeeTaxRegistration?:string,entityIdentification?:string,contact?:Contact[],address?:CustomerMasterAddress,avpList?:AvpList[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {CustomerRecord} */
payByCustomer;
/** @type {CustomerRecord} */
billToCustomer;
/** @type {string} */
routingCode;
/** @type {string} */
storeType;
/** @type {string} */
currencyCode;
/** @type {string} */
type;
/** @type {string} */
group;
/** @type {string} */
region;
/** @type {string} */
zoneRate;
/** @type {string} */
taxRule;
/** @type {string} */
paymentTerm;
/** @type {string} */
shipmentSite;
/** @type {string} */
shipmentSiteName;
/** @type {string} */
shipmentSiteGln;
/** @type {string} */
accountingCode;
/** @type {string} */
commercialRepresentative;
/** @type {string} */
commercialTerritory;
/** @type {CreditLimit} */
credit;
/** @type {string[]} */
nod = [];
/** @type {string[]} */
ndd = [];
}
export class CustomerMasterMessage {
/** @param {{dataSource?:TransactionalParty,dataRecipient?:TransactionalParty,customerMasterIdentification?:string,customer?:CustomerMasterType[],documentStatusCode?:string,documentActionCode?:string,creationDateTime?:string,lastUpdateDateTime?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {TransactionalParty} */
dataSource;
/** @type {TransactionalParty} */
dataRecipient;
/** @type {string} */
customerMasterIdentification;
/** @type {CustomerMasterType[]} */
customer = [];
/** @type {string} */
documentStatusCode;
/** @type {string} */
documentActionCode;
/** @type {string} */
creationDateTime;
/** @type {string} */
lastUpdateDateTime;
}
export class GetCustomerMasterByIdentification {
/** @param {{ownerGln?:string,customerMasterIdentification?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Owner GLN */
ownerGln;
/**
* @type {string}
* @description Customer Master Identification */
customerMasterIdentification;
}
JavaScript GetCustomerMasterByIdentification DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CustomerMasterMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.MasterData">
<CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
<Customer>
<CustomerMasterType>
<Address>
<City xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</City>
<CountryCode xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</CountryCode>
<PostalCode xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</PostalCode>
<ProvinceCode xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</ProvinceCode>
<StreetAddressOne xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</StreetAddressOne>
<StreetAddressThree xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</StreetAddressThree>
<StreetAddressTwo xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</StreetAddressTwo>
<AddressType>String</AddressType>
</Address>
<AvpList xmlns:d4p1="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">
<d4p1:AvpList>
<d4p1:Code>String</d4p1:Code>
<d4p1:Value>String</d4p1:Value>
</d4p1:AvpList>
</AvpList>
<BuyerAssignedVendorNo>String</BuyerAssignedVendorNo>
<Code>String</Code>
<Contact xmlns:d4p1="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">
<d4p1:Contact>
<d4p1:CommunicationChannel>
<d4p1:CommunicationChannel>
<d4p1:CommunicationChannelCode>String</d4p1:CommunicationChannelCode>
<d4p1:CommunicationChannelName>String</d4p1:CommunicationChannelName>
<d4p1:CommunicationValue>String</d4p1:CommunicationValue>
</d4p1:CommunicationChannel>
</d4p1:CommunicationChannel>
<d4p1:ContactTypeCode>String</d4p1:ContactTypeCode>
<d4p1:DepartmentName>String</d4p1:DepartmentName>
<d4p1:JobTitle>String</d4p1:JobTitle>
<d4p1:PersonName>String</d4p1:PersonName>
<d4p1:Responsibility>String</d4p1:Responsibility>
</d4p1:Contact>
</Contact>
<DutyFeeTaxRegistration>String</DutyFeeTaxRegistration>
<EntityIdentification>String</EntityIdentification>
<Gln>String</Gln>
<Name>String</Name>
<SupplierAssignedVendorNo>String</SupplierAssignedVendorNo>
<AccountingCode>String</AccountingCode>
<BillToCustomer>
<Address>
<City xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</City>
<CountryCode xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</CountryCode>
<PostalCode xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</PostalCode>
<ProvinceCode xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</ProvinceCode>
<StreetAddressOne xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</StreetAddressOne>
<StreetAddressThree xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</StreetAddressThree>
<StreetAddressTwo xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</StreetAddressTwo>
<AddressType>String</AddressType>
</Address>
<AvpList xmlns:d5p1="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">
<d5p1:AvpList>
<d5p1:Code>String</d5p1:Code>
<d5p1:Value>String</d5p1:Value>
</d5p1:AvpList>
</AvpList>
<BuyerAssignedVendorNo>String</BuyerAssignedVendorNo>
<Code>String</Code>
<Contact xmlns:d5p1="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">
<d5p1:Contact>
<d5p1:CommunicationChannel>
<d5p1:CommunicationChannel>
<d5p1:CommunicationChannelCode>String</d5p1:CommunicationChannelCode>
<d5p1:CommunicationChannelName>String</d5p1:CommunicationChannelName>
<d5p1:CommunicationValue>String</d5p1:CommunicationValue>
</d5p1:CommunicationChannel>
</d5p1:CommunicationChannel>
<d5p1:ContactTypeCode>String</d5p1:ContactTypeCode>
<d5p1:DepartmentName>String</d5p1:DepartmentName>
<d5p1:JobTitle>String</d5p1:JobTitle>
<d5p1:PersonName>String</d5p1:PersonName>
<d5p1:Responsibility>String</d5p1:Responsibility>
</d5p1:Contact>
</Contact>
<DutyFeeTaxRegistration>String</DutyFeeTaxRegistration>
<EntityIdentification>String</EntityIdentification>
<Gln>String</Gln>
<Name>String</Name>
<SupplierAssignedVendorNo>String</SupplierAssignedVendorNo>
</BillToCustomer>
<CommercialRepresentative>String</CommercialRepresentative>
<CommercialTerritory>String</CommercialTerritory>
<Credit>
<Available>0</Available>
<Balance>0</Balance>
<EffectiveDateTime>0001-01-01T00:00:00</EffectiveDateTime>
<Limit>0</Limit>
</Credit>
<CurrencyCode>String</CurrencyCode>
<Group>String</Group>
<NDD xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</NDD>
<NOD xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</NOD>
<PayByCustomer>
<Address>
<City xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</City>
<CountryCode xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</CountryCode>
<PostalCode xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</PostalCode>
<ProvinceCode xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</ProvinceCode>
<StreetAddressOne xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</StreetAddressOne>
<StreetAddressThree xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</StreetAddressThree>
<StreetAddressTwo xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">String</StreetAddressTwo>
<AddressType>String</AddressType>
</Address>
<AvpList xmlns:d5p1="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">
<d5p1:AvpList>
<d5p1:Code>String</d5p1:Code>
<d5p1:Value>String</d5p1:Value>
</d5p1:AvpList>
</AvpList>
<BuyerAssignedVendorNo>String</BuyerAssignedVendorNo>
<Code>String</Code>
<Contact xmlns:d5p1="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">
<d5p1:Contact>
<d5p1:CommunicationChannel>
<d5p1:CommunicationChannel>
<d5p1:CommunicationChannelCode>String</d5p1:CommunicationChannelCode>
<d5p1:CommunicationChannelName>String</d5p1:CommunicationChannelName>
<d5p1:CommunicationValue>String</d5p1:CommunicationValue>
</d5p1:CommunicationChannel>
</d5p1:CommunicationChannel>
<d5p1:ContactTypeCode>String</d5p1:ContactTypeCode>
<d5p1:DepartmentName>String</d5p1:DepartmentName>
<d5p1:JobTitle>String</d5p1:JobTitle>
<d5p1:PersonName>String</d5p1:PersonName>
<d5p1:Responsibility>String</d5p1:Responsibility>
</d5p1:Contact>
</Contact>
<DutyFeeTaxRegistration>String</DutyFeeTaxRegistration>
<EntityIdentification>String</EntityIdentification>
<Gln>String</Gln>
<Name>String</Name>
<SupplierAssignedVendorNo>String</SupplierAssignedVendorNo>
</PayByCustomer>
<PaymentTerm>String</PaymentTerm>
<Region>String</Region>
<RoutingCode>String</RoutingCode>
<ShipmentSite>String</ShipmentSite>
<ShipmentSiteGln>String</ShipmentSiteGln>
<ShipmentSiteName>String</ShipmentSiteName>
<StoreType>String</StoreType>
<TaxRule>String</TaxRule>
<Type>String</Type>
<ZoneRate>String</ZoneRate>
</CustomerMasterType>
</Customer>
<CustomerMasterIdentification>String</CustomerMasterIdentification>
<DataRecipient xmlns:d2p1="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">
<d2p1:AdditionalPartyIdentification>
<d2p1:AvpList>
<d2p1:Code>String</d2p1:Code>
<d2p1:Value>String</d2p1:Value>
</d2p1:AvpList>
</d2p1:AdditionalPartyIdentification>
<d2p1:Gln>String</d2p1:Gln>
<d2p1:Name>String</d2p1:Name>
<d2p1:Address>
<d2p1:City>String</d2p1:City>
<d2p1:CountryCode>String</d2p1:CountryCode>
<d2p1:PostalCode>String</d2p1:PostalCode>
<d2p1:ProvinceCode>String</d2p1:ProvinceCode>
<d2p1:StreetAddressOne>String</d2p1:StreetAddressOne>
<d2p1:StreetAddressThree>String</d2p1:StreetAddressThree>
<d2p1:StreetAddressTwo>String</d2p1:StreetAddressTwo>
</d2p1:Address>
<d2p1:CommunicationChannel>
<d2p1:AvpList>
<d2p1:Code>String</d2p1:Code>
<d2p1:Value>String</d2p1:Value>
</d2p1:AvpList>
</d2p1:CommunicationChannel>
<d2p1:Contact>
<d2p1:Contact>
<d2p1:CommunicationChannel>
<d2p1:CommunicationChannel>
<d2p1:CommunicationChannelCode>String</d2p1:CommunicationChannelCode>
<d2p1:CommunicationChannelName>String</d2p1:CommunicationChannelName>
<d2p1:CommunicationValue>String</d2p1:CommunicationValue>
</d2p1:CommunicationChannel>
</d2p1:CommunicationChannel>
<d2p1:ContactTypeCode>String</d2p1:ContactTypeCode>
<d2p1:DepartmentName>String</d2p1:DepartmentName>
<d2p1:JobTitle>String</d2p1:JobTitle>
<d2p1:PersonName>String</d2p1:PersonName>
<d2p1:Responsibility>String</d2p1:Responsibility>
</d2p1:Contact>
</d2p1:Contact>
<d2p1:DutyFeeTaxRegistration>String</d2p1:DutyFeeTaxRegistration>
<d2p1:EntityIdentification>String</d2p1:EntityIdentification>
<d2p1:FinancialInstitutionInformation>
<d2p1:ExportersCode>String</d2p1:ExportersCode>
<d2p1:FinancialAccount>
<d2p1:Name>String</d2p1:Name>
<d2p1:Number>String</d2p1:Number>
<d2p1:NumberTypeCode>String</d2p1:NumberTypeCode>
</d2p1:FinancialAccount>
<d2p1:FinancialInstitutionBranchName>String</d2p1:FinancialInstitutionBranchName>
<d2p1:FinancialInstitutionName>String</d2p1:FinancialInstitutionName>
<d2p1:FinancialRoutingNumber>
<d2p1:Number>String</d2p1:Number>
<d2p1:NumberTypeCode>String</d2p1:NumberTypeCode>
</d2p1:FinancialRoutingNumber>
<d2p1:SwiftCode>String</d2p1:SwiftCode>
</d2p1:FinancialInstitutionInformation>
</DataRecipient>
<DataSource xmlns:d2p1="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">
<d2p1:AdditionalPartyIdentification>
<d2p1:AvpList>
<d2p1:Code>String</d2p1:Code>
<d2p1:Value>String</d2p1:Value>
</d2p1:AvpList>
</d2p1:AdditionalPartyIdentification>
<d2p1:Gln>String</d2p1:Gln>
<d2p1:Name>String</d2p1:Name>
<d2p1:Address>
<d2p1:City>String</d2p1:City>
<d2p1:CountryCode>String</d2p1:CountryCode>
<d2p1:PostalCode>String</d2p1:PostalCode>
<d2p1:ProvinceCode>String</d2p1:ProvinceCode>
<d2p1:StreetAddressOne>String</d2p1:StreetAddressOne>
<d2p1:StreetAddressThree>String</d2p1:StreetAddressThree>
<d2p1:StreetAddressTwo>String</d2p1:StreetAddressTwo>
</d2p1:Address>
<d2p1:CommunicationChannel>
<d2p1:AvpList>
<d2p1:Code>String</d2p1:Code>
<d2p1:Value>String</d2p1:Value>
</d2p1:AvpList>
</d2p1:CommunicationChannel>
<d2p1:Contact>
<d2p1:Contact>
<d2p1:CommunicationChannel>
<d2p1:CommunicationChannel>
<d2p1:CommunicationChannelCode>String</d2p1:CommunicationChannelCode>
<d2p1:CommunicationChannelName>String</d2p1:CommunicationChannelName>
<d2p1:CommunicationValue>String</d2p1:CommunicationValue>
</d2p1:CommunicationChannel>
</d2p1:CommunicationChannel>
<d2p1:ContactTypeCode>String</d2p1:ContactTypeCode>
<d2p1:DepartmentName>String</d2p1:DepartmentName>
<d2p1:JobTitle>String</d2p1:JobTitle>
<d2p1:PersonName>String</d2p1:PersonName>
<d2p1:Responsibility>String</d2p1:Responsibility>
</d2p1:Contact>
</d2p1:Contact>
<d2p1:DutyFeeTaxRegistration>String</d2p1:DutyFeeTaxRegistration>
<d2p1:EntityIdentification>String</d2p1:EntityIdentification>
<d2p1:FinancialInstitutionInformation>
<d2p1:ExportersCode>String</d2p1:ExportersCode>
<d2p1:FinancialAccount>
<d2p1:Name>String</d2p1:Name>
<d2p1:Number>String</d2p1:Number>
<d2p1:NumberTypeCode>String</d2p1:NumberTypeCode>
</d2p1:FinancialAccount>
<d2p1:FinancialInstitutionBranchName>String</d2p1:FinancialInstitutionBranchName>
<d2p1:FinancialInstitutionName>String</d2p1:FinancialInstitutionName>
<d2p1:FinancialRoutingNumber>
<d2p1:Number>String</d2p1:Number>
<d2p1:NumberTypeCode>String</d2p1:NumberTypeCode>
</d2p1:FinancialRoutingNumber>
<d2p1:SwiftCode>String</d2p1:SwiftCode>
</d2p1:FinancialInstitutionInformation>
</DataSource>
<DocumentActionCode>String</DocumentActionCode>
<DocumentStatusCode>String</DocumentStatusCode>
<LastUpdateDateTime>0001-01-01T00:00:00</LastUpdateDateTime>
</CustomerMasterMessage>