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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Customer Master
*/
@Api(Description="Customer Master")
@ApiResponse(Description="Customer Master data", IsDefaultResponse=true, StatusCode=200)
// @ApiResponse(Description="No Content", ResponseType=IReturnVoid::class, StatusCode=204)
// @ApiResponse(Description="Specified argument was out of the range of valid values.", ResponseType=ArgumentOutOfRangeException::class, StatusCode=400)
open class GetCustomerMasterByIdentification
{
    /**
    * Owner GLN
    */
    @ApiMember(Description="Owner GLN", ExcludeInSchema=true, ParameterType="path")
    open var ownerGln:String? = null

    /**
    * Customer Master Identification
    */
    @ApiMember(Description="Customer Master Identification", ExcludeInSchema=true, ParameterType="path")
    open var customerMasterIdentification:String? = null
}

open class CustomerMasterMessage
{
    open var dataSource:TransactionalParty? = null
    open var dataRecipient:TransactionalParty? = null
    open var customerMasterIdentification:String? = null
    open var customer:ArrayList<CustomerMasterType> = ArrayList<CustomerMasterType>()
    open var documentStatusCode:String? = null
    open var documentActionCode:String? = null
    open var creationDateTime:Date? = null
    open var lastUpdateDateTime:Date? = null
}

open class TransactionalParty : Ecom_PartyIdentificationType()
{
    open var contact:ArrayList<Contact> = ArrayList<Contact>()
    open var address:Address? = null
    open var communicationChannel:ArrayList<AvpList> = ArrayList<AvpList>()
    open var financialInstitutionInformation:FinancialInstitutionInformation? = null
    open var dutyFeeTaxRegistration:String? = null
    open var entityIdentification:String? = null
}

open class Ecom_PartyIdentificationType
{
    open var gln:String? = null
    open var name:String? = null
    open var additionalPartyIdentification:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class AvpList
{
    open var code:String? = null
    open var value:String? = null
}

open class Contact
{
    open var contactTypeCode:String? = null
    open var personName:String? = null
    open var departmentName:String? = null
    open var jobTitle:String? = null
    open var responsibility:String? = null
    open var communicationChannel:ArrayList<CommunicationChannel> = ArrayList<CommunicationChannel>()
}

open class CommunicationChannel
{
    open var communicationChannelCode:String? = null
    open var communicationChannelName:String? = null
    open var communicationValue:String? = null
}

open class Address
{
    open var streetAddressOne:String? = null
    open var streetAddressTwo:String? = null
    open var streetAddressThree:String? = null
    open var city:String? = null
    open var postalCode:String? = null
    open var provinceCode:String? = null
    open var countryCode:String? = null
}

open class FinancialInstitutionInformation
{
    open var financialInstitutionBranchName:String? = null
    open var financialInstitutionName:String? = null
    open var financialRoutingNumber:FinancialRoutingNumber? = null
    open var financialAccount:FinancialAccount? = null
    open var swiftCode:String? = null
    open var exportersCode:String? = null
}

open class FinancialRoutingNumber
{
    open var number:String? = null
    open var numberTypeCode:String? = null
}

open class FinancialAccount
{
    open var number:String? = null
    open var numberTypeCode:String? = null
    open var name:String? = null
}

open class CustomerMasterType : CustomerRecord()
{
    open var payByCustomer:CustomerRecord? = null
    open var billToCustomer:CustomerRecord? = null
    open var routingCode:String? = null
    open var storeType:String? = null
    open var currencyCode:String? = null
    @SerializedName("type") open var Type:String? = null
    open var group:String? = null
    open var region:String? = null
    open var zoneRate:String? = null
    open var taxRule:String? = null
    open var paymentTerm:String? = null
    open var shipmentSite:String? = null
    open var shipmentSiteName:String? = null
    open var shipmentSiteGln:String? = null
    open var accountingCode:String? = null
    open var commercialRepresentative:String? = null
    open var commercialTerritory:String? = null
    open var credit:CreditLimit? = null
    open var nod:ArrayList<String> = ArrayList<String>()
    open var ndd:ArrayList<String> = ArrayList<String>()
}

open class CustomerRecord
{
    open var gln:String? = null
    open var code:String? = null
    open var name:String? = null
    open var buyerAssignedVendorNo:String? = null
    open var supplierAssignedVendorNo:String? = null
    open var dutyFeeTaxRegistration:String? = null
    open var entityIdentification:String? = null
    open var contact:ArrayList<Contact> = ArrayList<Contact>()
    open var address:CustomerMasterAddress? = null
    open var avpList:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class CustomerMasterAddress : Address()
{
    open var addressType:String? = null
}

open class CreditLimit
{
    open var limit:BigDecimal? = null
    open var balance:BigDecimal? = null
    open var available:BigDecimal? = null
    open var effectiveDateTime:Date? = null
}

Kotlin GetCustomerMasterByIdentification DTOs

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

HTTP + 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>