DX STF Client API

<back to all web services

GetCustomerMasterByIdentification

Customer Master Requests

Customer Master

Requires Authentication
The following routes are available for this service:
GET/api/customerMaster/{OwnerGln}/{CustomerMasterIdentification}Get specific customer by customerMasterIdentification Id
namespace DX.STF.Application.ClientApi.Messages.CustomerMaster

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type AvpList() = 
        member val Code:String = null with get,set
        member val Value:String = null with get,set

    [<AllowNullLiteral>]
    type Ecom_PartyIdentificationType() = 
        member val Gln:String = null with get,set
        member val Name:String = null with get,set
        member val AdditionalPartyIdentification:ResizeArray<AvpList> = null with get,set

    [<AllowNullLiteral>]
    type CommunicationChannel() = 
        member val CommunicationChannelCode:String = null with get,set
        member val CommunicationChannelName:String = null with get,set
        member val CommunicationValue:String = null with get,set

    [<AllowNullLiteral>]
    type Contact() = 
        member val ContactTypeCode:String = null with get,set
        member val PersonName:String = null with get,set
        member val DepartmentName:String = null with get,set
        member val JobTitle:String = null with get,set
        member val Responsibility:String = null with get,set
        member val CommunicationChannel:ResizeArray<CommunicationChannel> = null with get,set

    [<AllowNullLiteral>]
    type Address() = 
        member val StreetAddressOne:String = null with get,set
        member val StreetAddressTwo:String = null with get,set
        member val StreetAddressThree:String = null with get,set
        member val City:String = null with get,set
        member val PostalCode:String = null with get,set
        member val ProvinceCode:String = null with get,set
        member val CountryCode:String = null with get,set

    [<AllowNullLiteral>]
    type FinancialRoutingNumber() = 
        member val Number:String = null with get,set
        member val NumberTypeCode:String = null with get,set

    [<AllowNullLiteral>]
    type FinancialAccount() = 
        member val Number:String = null with get,set
        member val NumberTypeCode:String = null with get,set
        member val Name:String = null with get,set

    [<AllowNullLiteral>]
    type FinancialInstitutionInformation() = 
        member val FinancialInstitutionBranchName:String = null with get,set
        member val FinancialInstitutionName:String = null with get,set
        member val FinancialRoutingNumber:FinancialRoutingNumber = null with get,set
        member val FinancialAccount:FinancialAccount = null with get,set
        member val SwiftCode:String = null with get,set
        member val ExportersCode:String = null with get,set

    [<AllowNullLiteral>]
    type TransactionalParty() = 
        inherit Ecom_PartyIdentificationType()
        member val Contact:ResizeArray<Contact> = null with get,set
        member val Address:Address = null with get,set
        member val CommunicationChannel:ResizeArray<AvpList> = null with get,set
        member val FinancialInstitutionInformation:FinancialInstitutionInformation = null with get,set
        member val DutyFeeTaxRegistration:String = null with get,set
        member val EntityIdentification:String = null with get,set

    [<AllowNullLiteral>]
    type CustomerMasterAddress() = 
        inherit Address()
        member val AddressType:String = null with get,set

    [<AllowNullLiteral>]
    type CustomerRecord() = 
        member val Gln:String = null with get,set
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val BuyerAssignedVendorNo:String = null with get,set
        member val SupplierAssignedVendorNo:String = null with get,set
        member val DutyFeeTaxRegistration:String = null with get,set
        member val EntityIdentification:String = null with get,set
        member val Contact:ResizeArray<Contact> = null with get,set
        member val Address:CustomerMasterAddress = null with get,set
        member val AvpList:ResizeArray<AvpList> = null with get,set

    [<AllowNullLiteral>]
    type CreditLimit() = 
        member val Limit:Decimal = new Decimal() with get,set
        member val Balance:Decimal = new Decimal() with get,set
        member val Available:Decimal = new Decimal() with get,set
        member val EffectiveDateTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type CustomerMasterType() = 
        inherit CustomerRecord()
        member val PayByCustomer:CustomerRecord = null with get,set
        member val BillToCustomer:CustomerRecord = null with get,set
        member val RoutingCode:String = null with get,set
        member val StoreType:String = null with get,set
        member val CurrencyCode:String = null with get,set
        member val Type:String = null with get,set
        member val Group:String = null with get,set
        member val Region:String = null with get,set
        member val ZoneRate:String = null with get,set
        member val TaxRule:String = null with get,set
        member val PaymentTerm:String = null with get,set
        member val ShipmentSite:String = null with get,set
        member val ShipmentSiteName:String = null with get,set
        member val ShipmentSiteGln:String = null with get,set
        member val AccountingCode:String = null with get,set
        member val CommercialRepresentative:String = null with get,set
        member val CommercialTerritory:String = null with get,set
        member val Credit:CreditLimit = null with get,set
        member val NOD:ResizeArray<String> = null with get,set
        member val NDD:ResizeArray<String> = null with get,set

    [<AllowNullLiteral>]
    type CustomerMasterMessage() = 
        member val DataSource:TransactionalParty = null with get,set
        member val DataRecipient:TransactionalParty = null with get,set
        member val CustomerMasterIdentification:String = null with get,set
        member val Customer:ResizeArray<CustomerMasterType> = null with get,set
        member val DocumentStatusCode:String = null with get,set
        member val DocumentActionCode:String = null with get,set
        member val CreationDateTime:DateTime = new DateTime() with get,set
        member val LastUpdateDateTime:DateTime = new DateTime() with get,set

    ///<summary>
    ///Customer Master
    ///</summary>
    [<Api(Description="Customer Master")>]
    [<ApiResponse(Description="Customer Master data", IsDefaultResponse=true, StatusCode=200)>]
    [<ApiResponse(Description="No Content", ResponseType=typeof<IReturnVoid>, StatusCode=204)>]
    [<ApiResponse(Description="Specified argument was out of the range of valid values.", ResponseType=typeof<ArgumentOutOfRangeException>, StatusCode=400)>]
    [<AllowNullLiteral>]
    type GetCustomerMasterByIdentification() = 
        ///<summary>
        ///Owner GLN
        ///</summary>
        [<ApiMember(Description="Owner GLN", ExcludeInSchema=true, ParameterType="path")>]
        member val OwnerGln:String = null with get,set

        ///<summary>
        ///Customer Master Identification
        ///</summary>
        [<ApiMember(Description="Customer Master Identification", ExcludeInSchema=true, ParameterType="path")>]
        member val CustomerMasterIdentification:String = null with get,set

F# 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>