| GET | /api/customerMaster/{OwnerGln}/{CustomerMasterIdentification} | Get specific customer by customerMasterIdentification Id |
|---|
export class AvpList
{
public code: string;
public value: string;
public constructor(init?: Partial<AvpList>) { (Object as any).assign(this, init); }
}
export class Ecom_PartyIdentificationType
{
public gln: string;
public name: string;
public additionalPartyIdentification: AvpList[] = [];
public constructor(init?: Partial<Ecom_PartyIdentificationType>) { (Object as any).assign(this, init); }
}
export class CommunicationChannel
{
public communicationChannelCode: string;
public communicationChannelName: string;
public communicationValue: string;
public constructor(init?: Partial<CommunicationChannel>) { (Object as any).assign(this, init); }
}
export class Contact
{
public contactTypeCode: string;
public personName: string;
public departmentName: string;
public jobTitle: string;
public responsibility: string;
public communicationChannel: CommunicationChannel[] = [];
public constructor(init?: Partial<Contact>) { (Object as any).assign(this, init); }
}
export class Address
{
public streetAddressOne: string;
public streetAddressTwo: string;
public streetAddressThree: string;
public city: string;
public postalCode: string;
public provinceCode: string;
public countryCode: string;
public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}
export class FinancialRoutingNumber
{
public number: string;
public numberTypeCode: string;
public constructor(init?: Partial<FinancialRoutingNumber>) { (Object as any).assign(this, init); }
}
export class FinancialAccount
{
public number: string;
public numberTypeCode: string;
public name: string;
public constructor(init?: Partial<FinancialAccount>) { (Object as any).assign(this, init); }
}
export class FinancialInstitutionInformation
{
public financialInstitutionBranchName: string;
public financialInstitutionName: string;
public financialRoutingNumber: FinancialRoutingNumber;
public financialAccount: FinancialAccount;
public swiftCode: string;
public exportersCode: string;
public constructor(init?: Partial<FinancialInstitutionInformation>) { (Object as any).assign(this, init); }
}
export class TransactionalParty extends Ecom_PartyIdentificationType
{
public contact: Contact[] = [];
public address: Address;
public communicationChannel: AvpList[] = [];
public financialInstitutionInformation: FinancialInstitutionInformation;
public dutyFeeTaxRegistration: string;
public entityIdentification: string;
public constructor(init?: Partial<TransactionalParty>) { super(init); (Object as any).assign(this, init); }
}
export class CustomerMasterAddress extends Address
{
public addressType: string;
public constructor(init?: Partial<CustomerMasterAddress>) { super(init); (Object as any).assign(this, init); }
}
export class CustomerRecord
{
public gln: string;
public code: string;
public name: string;
public buyerAssignedVendorNo: string;
public supplierAssignedVendorNo: string;
public dutyFeeTaxRegistration: string;
public entityIdentification: string;
public contact: Contact[] = [];
public address: CustomerMasterAddress;
public avpList: AvpList[] = [];
public constructor(init?: Partial<CustomerRecord>) { (Object as any).assign(this, init); }
}
export class CreditLimit
{
public limit: number;
public balance: number;
public available: number;
public effectiveDateTime?: string;
public constructor(init?: Partial<CreditLimit>) { (Object as any).assign(this, init); }
}
export class CustomerMasterType extends CustomerRecord
{
public payByCustomer: CustomerRecord;
public billToCustomer: CustomerRecord;
public routingCode: string;
public storeType: string;
public currencyCode: string;
public type: string;
public group: string;
public region: string;
public zoneRate: string;
public taxRule: string;
public paymentTerm: string;
public shipmentSite: string;
public shipmentSiteName: string;
public shipmentSiteGln: string;
public accountingCode: string;
public commercialRepresentative: string;
public commercialTerritory: string;
public credit: CreditLimit;
public nod: string[] = [];
public ndd: string[] = [];
public constructor(init?: Partial<CustomerMasterType>) { super(init); (Object as any).assign(this, init); }
}
export class CustomerMasterMessage
{
public dataSource: TransactionalParty;
public dataRecipient: TransactionalParty;
public customerMasterIdentification: string;
public customer: CustomerMasterType[] = [];
public documentStatusCode: string;
public documentActionCode: string;
public creationDateTime: string;
public lastUpdateDateTime: string;
public constructor(init?: Partial<CustomerMasterMessage>) { (Object as any).assign(this, init); }
}
/** @description Customer Master */
// @Api(Description="Customer Master")
// @ApiResponse(Description="Customer Master data", IsDefaultResponse=true, StatusCode=200)
// @ApiResponse(Description="No Content", ResponseType="typeof(ServiceStack.IReturnVoid)", StatusCode=204)
// @ApiResponse(Description="Specified argument was out of the range of valid values.", ResponseType="typeof(System.ArgumentOutOfRangeException)", StatusCode=400)
export class GetCustomerMasterByIdentification
{
/** @description Owner GLN */
// @ApiMember(Description="Owner GLN", ExcludeInSchema=true, ParameterType="path")
public ownerGln: string;
/** @description Customer Master Identification */
// @ApiMember(Description="Customer Master Identification", ExcludeInSchema=true, ParameterType="path")
public customerMasterIdentification: string;
public constructor(init?: Partial<GetCustomerMasterByIdentification>) { (Object as any).assign(this, init); }
}
TypeScript GetCustomerMasterByIdentification DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}