CustomerComponents Web Service
Method/GetCustomers
CustomerComponents Web Service > All Operations Resource Group : /GetCustomers (Method)
Description
The GetCustomers function retrieves all customers for the given parameters.
Request (GetCustomersSoapIn)

The request body is of type GetCustomers.

Request Body Parameters

NameDescriptionData Type
filter CustomersFilter
offset xml:int
recordCount xml:int
orderBy xml:string
orderBy Element recordCount Element offset Element RfidCode Element LastModifiedDateTo Element LastModifiedDateFrom Element Street Element CustomerId Element IsExportAllowedOnly Element IsCancelledOnly Element IsSmartSearch Element IsConsignmentSuppliersOnly Element IsSupplierOnly Element IsDebtorOnly Element IsCompanyOnly Element CardNumber Element Telephone Element City Element NumberPart2 Element NumberPart1 Element Email Element ZipCode Element LastName Element CompanyName Element SearchText Element GeneralName Element PriceAgreementId Element DiscountAgreementId Element SaleTypeId Element IsDefaultDebtorOnly Element IsDefaultSupplierOnly Element DebtorId Element SupplierId Element GS1EdiCustomerPartyNumber Element GS1EdiPartyNumber Element ExternalCode Element CustomerNumber Element ExternalId Element LoyaltyProviderId Element CustomerTypeId Element CountryId Element Sequence filter Element Sequence GetCustomers Element

Overview

GetCustomers
Sequence
filter optional CustomersFilter Complex Type
Sequence
CountryId xs:int
CustomerTypeId xs:int
LoyaltyProviderId xs:int
ExternalId xs:int
CustomerNumber xs:long
ExternalCode optional xs:string
GS1EdiPartyNumber xs:long
GS1EdiCustomerPartyNumber xs:long
SupplierId xs:int
DebtorId xs:int
IsDefaultSupplierOnly BooleanFilter Simple Type
IsDefaultDebtorOnly BooleanFilter Simple Type
SaleTypeId xs:int
DiscountAgreementId xs:int
PriceAgreementId xs:int
GeneralName optional xs:string
SearchText optional xs:string
CompanyName optional xs:string
LastName optional xs:string
ZipCode optional xs:string
Email optional xs:string
NumberPart1 xs:int
NumberPart2 optional xs:string
City optional xs:string
Telephone optional xs:string
CardNumber xs:long
IsCompanyOnly BooleanFilter Simple Type
IsDebtorOnly BooleanFilter Simple Type
IsSupplierOnly BooleanFilter Simple Type
IsConsignmentSuppliersOnly BooleanFilter Simple Type
IsSmartSearch xs:boolean
IsCancelledOnly BooleanFilter Simple Type
IsExportAllowedOnly BooleanFilter Simple Type
CustomerId xs:int
Street optional xs:string
LastModifiedDateFrom xs:dateTime
LastModifiedDateTo xs:dateTime
RfidCode optional xs:string
offset xs:int
recordCount xs:int
orderBy optional xs:string
Response (GetCustomersSoapOut)

The response body is of type GetCustomersResponse.

Response Body Parameters

NameDescriptionData Type
GetCustomersResult ArrayOfViewCustomerInfo
LanguageDescription Element LanguageCode Element DefaultEmailAddress Element DeliveryCountryIsoCode Element DeliveryCountry Element DeliveryCountryId Element DeliveryCity Element DeliveryZipCode Element DeliveryAddress Element DeliveryCounty Element DeliveryAddressDescription Element DeliveryNumberPart2 Element DeliveryNumberPart1 Element DeliveryStreet Element DeliveryAttentionOf Element InvoiceCountry Element InvoiceCountryId Element InvoiceCity Element InvoiceZipCode Element InvoiceAddress Element InvoiceCountryIsoCode Element InvoiceCounty Element InvoiceAddressDescription Element InvoiceNumberPart2 Element InvoiceNumberPart1 Element InvoiceStreet Element InvoiceAttentionOf Element PostalCountryIsoCode Element PostalCountry Element PostalCountryId Element PostalCity Element PostalZipCode Element PostalAddress Element PostalCounty Element PostalAddressDescription Element PostalNumberPart2 Element PostalNumberPart1 Element PostalStreet Element PostalAttentionOf Element VisitCountryIsoCode Element VisitCountry Element VisitCountryId Element VisitCity Element VisitZipCode Element VisitAddress Element VisitCounty Element VisitAddressDescription Element VisitNumberPart2 Element VisitNumberPart1 Element VisitStreet Element VisitAttentionOf Element GsmNumber Element FaxNumber Element PhoneNumber Element DebtorName Element DebtorNumber Element SupplierAcceptInvoiceMsgsFrom Element SupplierAcceptShipmentMsgsFrom Element SupplierAcceptMsgsFrom Element SupplierCancelled Element SupplierVatCode Element SupplierIban Element SupplierName Element SupplierNumber Element SaleTypeCode Element SaleTypeDescription Element PriceToApply Element NewsLetterStatus Element SendSaleConfirmation Element SaleConfirmationEmailAddressId Element LanguageId Element Deceased Element Gender Element DateOfBirth Element RfidCode Element IsCancelled Element IsExportAllowed Element Url Element Remarks Element LastName Element MiddleName Element FirstName Element Initials Element SalutationId Element PreviousCompanyName Element CompanyName Element IsCompany Element SearchText Element GeneralName Element SaleOrderClassId Element PriceAgreementId Element DiscountAgreementId Element SaleTypeId Element IsDefaultDebtor Element IsDefaultSupplier Element DebtorId Element SupplierId Element EdiSendOrderResponse Element GS1EdiCustomerPartyNumber Element GS1EdiPartyNumber Element GS1EdiFormat Element ExternalCode Element CustomerNumber Element ExternalId Element LoyaltyProviderId Element CustomerTypeId Element OrganizationId Element CompanyId Element LastModifiedDateTime Element LastModifiedByUserId Element CreatedDateTime Element CreatedByUserId Element ItemId Element Sequence ViewCustomerInfo Element Sequence GetCustomersResult Element Sequence GetCustomersResponse Element

Overview

GetCustomersResponse
Sequence
GetCustomersResult optional ArrayOfViewCustomerInfo Complex Type
Sequence
ViewCustomerInfo 0..∞ ViewCustomerInfo Complex Type
Sequence
ItemId xs:int
CreatedByUserId xs:int
CreatedDateTime xs:dateTime
LastModifiedByUserId xs:int
LastModifiedDateTime xs:dateTime
CompanyId xs:int
OrganizationId xs:int
CustomerTypeId xs:int
LoyaltyProviderId xs:int
ExternalId xs:int
CustomerNumber xs:long
ExternalCode optional xs:string
GS1EdiFormat GS1EdiFormat Simple Type
GS1EdiPartyNumber xs:long
GS1EdiCustomerPartyNumber xs:long
EdiSendOrderResponse xs:boolean
SupplierId xs:int
DebtorId xs:int
IsDefaultSupplier xs:boolean
IsDefaultDebtor xs:boolean
SaleTypeId xs:int
DiscountAgreementId xs:int
PriceAgreementId xs:int
SaleOrderClassId xs:int
GeneralName optional xs:string
SearchText optional xs:string
IsCompany xs:boolean
CompanyName optional xs:string
PreviousCompanyName optional xs:string
SalutationId xs:int
Initials optional xs:string
FirstName optional xs:string
MiddleName optional xs:string
LastName optional xs:string
Remarks optional xs:string
Url optional xs:string
IsExportAllowed xs:boolean
IsCancelled xs:boolean
RfidCode optional xs:string
DateOfBirth xs:dateTime
Gender Gender Simple Type
Deceased xs:boolean
LanguageId xs:int
SaleConfirmationEmailAddressId xs:int
SendSaleConfirmation xs:boolean
NewsLetterStatus NewsLetterStatus Simple Type
PriceToApply CustomerPriceType Simple Type
SaleTypeDescription optional xs:string
SaleTypeCode optional xs:string
SupplierNumber xs:long
SupplierName optional xs:string
SupplierIban optional xs:string
SupplierVatCode optional xs:string
SupplierCancelled xs:boolean
SupplierAcceptMsgsFrom SupplierAcceptMsgsFrom Simple Type
SupplierAcceptShipmentMsgsFrom SupplierAcceptMsgsFrom Simple Type
SupplierAcceptInvoiceMsgsFrom SupplierAcceptMsgsFrom Simple Type
DebtorNumber xs:int
DebtorName optional xs:string
PhoneNumber optional xs:string
FaxNumber optional xs:string
GsmNumber optional xs:string
VisitAttentionOf optional xs:string
VisitStreet optional xs:string
VisitNumberPart1 xs:int
VisitNumberPart2 optional xs:string
VisitAddressDescription optional xs:string
VisitCounty optional xs:string
VisitAddress optional xs:string
VisitZipCode optional xs:string
VisitCity optional xs:string
VisitCountryId xs:int
VisitCountry optional xs:string
VisitCountryIsoCode optional xs:string
PostalAttentionOf optional xs:string
PostalStreet optional xs:string
PostalNumberPart1 xs:int
PostalNumberPart2 optional xs:string
PostalAddressDescription optional xs:string
PostalCounty optional xs:string
PostalAddress optional xs:string
PostalZipCode optional xs:string
PostalCity optional xs:string
PostalCountryId xs:int
PostalCountry optional xs:string
PostalCountryIsoCode optional xs:string
InvoiceAttentionOf optional xs:string
InvoiceStreet optional xs:string
InvoiceNumberPart1 xs:int
InvoiceNumberPart2 optional xs:string
InvoiceAddressDescription optional xs:string
InvoiceCounty optional xs:string
InvoiceCountryIsoCode optional xs:string
InvoiceAddress optional xs:string
InvoiceZipCode optional xs:string
InvoiceCity optional xs:string
InvoiceCountryId xs:int
InvoiceCountry optional xs:string
DeliveryAttentionOf optional xs:string
DeliveryStreet optional xs:string
DeliveryNumberPart1 xs:int
DeliveryNumberPart2 optional xs:string
DeliveryAddressDescription optional xs:string
DeliveryCounty optional xs:string
DeliveryAddress optional xs:string
DeliveryZipCode optional xs:string
DeliveryCity optional xs:string
DeliveryCountryId xs:int
DeliveryCountry optional xs:string
DeliveryCountryIsoCode optional xs:string
DefaultEmailAddress optional xs:string
LanguageCode optional xs:string
LanguageDescription optional xs:string
See Also
All Operations Resource Group | CustomerComponents Web Service

 

 

© 2020 All Rights Reserved.

Send comments on this topic.