/v23.1/Customers

05 Jun 2024
4 Minutes to read
Contributors

Print
Share
Twitter
Linkedin
Facebook
Email
Dark
Light
PDF

/v23.1/Customers

Updated on 05 Jun 2024
4 Minutes to read
Contributors

Print
Share
Twitter
Linkedin
Facebook
Email
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/v23.1/Customers

Security

HTTP

Type Bearer

Please enter a valid token

Query parameters

CountryId

integer (int32)

CustomerTypeId

integer (int32)

LoyaltyProviderId

integer (int32)

ExternalId

integer (int32)

CustomerNumber

integer (int64)

ExternalCode

string

GS1EdiPartyNumber

integer (int64)

GS1EdiCustomerPartyNumber

integer (int64)

SupplierId

integer (int32)

DebtorId

integer (int32)

IsDefaultSupplierOnly

string

Valid values[ "All", "Yes", "No" ]

IsDefaultDebtorOnly

string

Valid values[ "All", "Yes", "No" ]

SaleTypeId

integer (int32)

DiscountAgreementId

integer (int32)

PriceAgreementId

integer (int32)

GeneralName

string

SearchText

string

CompanyName

string

LastName

string

Address

string

ZipCode

string

Street

string

NumberPart1

integer (int32)

NumberPart2

string

City

string

Telephone

string

CardNumber

integer (int64)

LastModifiedDateFrom

string (date-time)

LastModifiedDateTo

string (date-time)

IsCompanyOnly

string

Valid values[ "All", "Yes", "No" ]

IsDebtorOnly

string

Valid values[ "All", "Yes", "No" ]

IsSupplierOnly

string

Valid values[ "All", "Yes", "No" ]

IsConsignmentSuppliersOnly

string

Valid values[ "All", "Yes", "No" ]

IsSmartSearch

boolean

IsExportAllowedOnly

string

Valid values[ "All", "Yes", "No" ]

IsCancelledOnly

string

Valid values[ "All", "Yes", "No" ]

RfidCode

string

RfmSegmentAssigned

string

Valid values[ "All", "Yes", "No" ]

RfmExcluded

string

Valid values[ "All", "Yes", "No" ]

RfmSegmentId

integer (int32)

RfmChangedSinceDate

string (date-time)

ItemIds

array of integer

ItemId

integer (int32)

IncludeItemId

integer (int32)

ExcludeItemId

integer (int32)

ModifiedSinceDateTime

string (date-time)

Responses

200

Success

Array of object

object

itemId

integer (int32)

createdByUserId

integer (int32)

createdDateTime

string (date-time)

lastModifiedByUserId

integer (int32)

lastModifiedDateTime

string (date-time)

organizationId

integer (int32)

companyId

integer (int32)

customerTypeId

integer (int32)

loyaltyProviderId

integer (int32)

externalId

integer (int32)

customerNumber

integer (int64)

externalCode

string

gS1EdiFormat

string

Valid values[ "NotSpecified", "EanCom", "EdiXml", "Codanet", "NedFox", "NearSt" ]

gS1EdiPartyNumber

integer (int64)

gS1EdiCustomerPartyNumber

integer (int64)

supplierId

integer (int32)

debtorId

integer (int32)

isDefaultSupplier

boolean

Default"False"

isDefaultDebtor

boolean

Default"False"

saleTypeId

integer (int32)

discountAgreementId

integer (int32)

priceAgreementId

integer (int32)

saleOrderClassId

integer (int32)

dropshipmentSaleOrderClassId

integer (int32)

generalName

string

searchText

string

isCompany

boolean

Default"False"

companyName

string

previousCompanyName

string

salutationId

integer (int32)

initials

string

firstName

string

middleName

string

lastName

string

remarks

string

url

string

isExportAllowed

boolean

Default"False"

isCancelled

boolean

Default"False"

rfidCode

string

dateOfBirth

string (date-time)

gender

string

Valid values[ "NotSpecified", "Male", "Female" ]

deceased

boolean

Default"False"

languageId

integer (int32)

saleConfirmationEmailAddressId

integer (int32)

sendSaleConfirmation

boolean

Default"False"

newsLetterStatus

string

Valid values[ "Unknown", "Accepted", "Denied" ]

priceToApply

string

Valid values[ "NotSpecified", "InclVat", "ExclVat" ]

rfmExclude

boolean

Default"False"

rfmRecency

integer (int32)

rfmFrequency

integer (int32)

rfmMonetary

number (double)

rfmRecencyRank

integer (int32)

rfmFrequencyRank

integer (int32)

rfmMonetaryRank

integer (int32)

rfmMonetaryFrequencyRank

integer (int32)

rfmAverageRank

number (double)

rfmSegmentId

integer (int32)

rfmChangedDateTime

string (date-time)

supplierNumber

integer (int64)

supplierName

string

supplierAcceptMsgsFrom

string

Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]

supplierAcceptShipmentMsgsFrom

string

Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]

supplierAcceptInvoiceMsgsFrom

string

Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]

supplierIban

string

supplierVatCode

string

supplierCancelled

boolean

Default"False"

debtorNumber

integer (int64)

debtorName

string

saleTypeCode

string

saleTypeDescription

string

rfmSegmentDescription

string

phoneNumber

string

faxNumber

string

gsmNumber

string

defaultEmailAddress

string

languageCode

string

languageDescription

string

visitAttentionOf

string

visitStreet

string

visitNumberPart1

integer (int32)

visitNumberPart2

string

visitAddress

string

visitAddressDescription

string

visitZipCode

string

visitCounty

string

visitCity

string

visitCountryId

integer (int32)

visitCountry

string

visitCountryIsoCode

string

postalAttentionOf

string

postalStreet

string

postalNumberPart1

integer (int32)

postalNumberPart2

string

postalAddress

string

postalAddressDescription

string

postalZipCode

string

postalCounty

string

postalCity

string

postalCountryId

integer (int32)

postalCountry

string

postalCountryIsoCode

string

invoiceAttentionOf

string

invoiceStreet

string

invoiceNumberPart1

integer (int32)

invoiceNumberPart2

string

invoiceAddress

string

invoiceAddressDescription

string

invoiceZipCode

string

invoiceCounty

string

invoiceCity

string

invoiceCountryId

integer (int32)

invoiceCountry

string

invoiceCountryIsoCode

string

deliveryAttentionOf

string

deliveryStreet

string

deliveryNumberPart1

integer (int32)

deliveryNumberPart2

string

deliveryAddress

string

deliveryAddressDescription

string

deliveryZipCode

string

deliveryCounty

string

deliveryCity

string

deliveryCountryId

integer (int32)

deliveryCountry

string

deliveryCountryIsoCode

string

Array of object

object

itemId

integer (int32)

createdByUserId

integer (int32)

createdDateTime

string (date-time)

lastModifiedByUserId

integer (int32)

lastModifiedDateTime

string (date-time)

organizationId

integer (int32)

companyId

integer (int32)

customerTypeId

integer (int32)

loyaltyProviderId

integer (int32)

externalId

integer (int32)

customerNumber

integer (int64)

externalCode

string

gS1EdiFormat

string

Valid values[ "NotSpecified", "EanCom", "EdiXml", "Codanet", "NedFox", "NearSt" ]

gS1EdiPartyNumber

integer (int64)

gS1EdiCustomerPartyNumber

integer (int64)

supplierId

integer (int32)

debtorId

integer (int32)

isDefaultSupplier

boolean

Default"False"

isDefaultDebtor

boolean

Default"False"

saleTypeId

integer (int32)

discountAgreementId

integer (int32)

priceAgreementId

integer (int32)

saleOrderClassId

integer (int32)

dropshipmentSaleOrderClassId

integer (int32)

generalName

string

searchText

string

isCompany

boolean

Default"False"

companyName

string

previousCompanyName

string

salutationId

integer (int32)

initials

string

firstName

string

middleName

string

lastName

string

remarks

string

url

string

isExportAllowed

boolean

Default"False"

isCancelled

boolean

Default"False"

rfidCode

string

dateOfBirth

string (date-time)

gender

string

Valid values[ "NotSpecified", "Male", "Female" ]

deceased

boolean

Default"False"

languageId

integer (int32)

saleConfirmationEmailAddressId

integer (int32)

sendSaleConfirmation

boolean

Default"False"

newsLetterStatus

string

Valid values[ "Unknown", "Accepted", "Denied" ]

priceToApply

string

Valid values[ "NotSpecified", "InclVat", "ExclVat" ]

rfmExclude

boolean

Default"False"

rfmRecency

integer (int32)

rfmFrequency

integer (int32)

rfmMonetary

number (double)

rfmRecencyRank

integer (int32)

rfmFrequencyRank

integer (int32)

rfmMonetaryRank

integer (int32)

rfmMonetaryFrequencyRank

integer (int32)

rfmAverageRank

number (double)

rfmSegmentId

integer (int32)

rfmChangedDateTime

string (date-time)

supplierNumber

integer (int64)

supplierName

string

supplierAcceptMsgsFrom

string

Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]

supplierAcceptShipmentMsgsFrom

string

Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]

supplierAcceptInvoiceMsgsFrom

string

Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]

supplierIban

string

supplierVatCode

string

supplierCancelled

boolean

Default"False"

debtorNumber

integer (int64)

debtorName

string

saleTypeCode

string

saleTypeDescription

string

rfmSegmentDescription

string

phoneNumber

string

faxNumber

string

gsmNumber

string

defaultEmailAddress

string

languageCode

string

languageDescription

string

visitAttentionOf

string

visitStreet

string

visitNumberPart1

integer (int32)

visitNumberPart2

string

visitAddress

string

visitAddressDescription

string

visitZipCode

string

visitCounty

string

visitCity

string

visitCountryId

integer (int32)

visitCountry

string

visitCountryIsoCode

string

postalAttentionOf

string

postalStreet

string

postalNumberPart1

integer (int32)

postalNumberPart2

string

postalAddress

string

postalAddressDescription

string

postalZipCode

string

postalCounty

string

postalCity

string

postalCountryId

integer (int32)

postalCountry

string

postalCountryIsoCode

string

invoiceAttentionOf

string

invoiceStreet

string

invoiceNumberPart1

integer (int32)

invoiceNumberPart2

string

invoiceAddress

string

invoiceAddressDescription

string

invoiceZipCode

string

invoiceCounty

string

invoiceCity

string

invoiceCountryId

integer (int32)

invoiceCountry

string

invoiceCountryIsoCode

string

deliveryAttentionOf

string

deliveryStreet

string

deliveryNumberPart1

integer (int32)

deliveryNumberPart2

string

deliveryAddress

string

deliveryAddressDescription

string

deliveryZipCode

string

deliveryCounty

string

deliveryCity

string

deliveryCountryId

integer (int32)

deliveryCountry

string

deliveryCountryIsoCode

string

Array of object

object

itemId

integer (int32)

createdByUserId

integer (int32)

createdDateTime

string (date-time)

lastModifiedByUserId

integer (int32)

lastModifiedDateTime

string (date-time)

organizationId

integer (int32)

companyId

integer (int32)

customerTypeId

integer (int32)

loyaltyProviderId

integer (int32)

externalId

integer (int32)

customerNumber

integer (int64)

externalCode

string

gS1EdiFormat

string

Valid values[ "NotSpecified", "EanCom", "EdiXml", "Codanet", "NedFox", "NearSt" ]

gS1EdiPartyNumber

integer (int64)

gS1EdiCustomerPartyNumber

integer (int64)

supplierId

integer (int32)

debtorId

integer (int32)

isDefaultSupplier

boolean

Default"False"

isDefaultDebtor

boolean

Default"False"

saleTypeId

integer (int32)

discountAgreementId

integer (int32)

priceAgreementId

integer (int32)

saleOrderClassId

integer (int32)

dropshipmentSaleOrderClassId

integer (int32)

generalName

string

searchText

string

isCompany

boolean

Default"False"

companyName

string

previousCompanyName

string

salutationId

integer (int32)

initials

string

firstName

string

middleName

string

lastName

string

remarks

string

url

string

isExportAllowed

boolean

Default"False"

isCancelled

boolean

Default"False"

rfidCode

string

dateOfBirth

string (date-time)

gender

string

Valid values[ "NotSpecified", "Male", "Female" ]

deceased

boolean

Default"False"

languageId

integer (int32)

saleConfirmationEmailAddressId

integer (int32)

sendSaleConfirmation

boolean

Default"False"

newsLetterStatus

string

Valid values[ "Unknown", "Accepted", "Denied" ]

priceToApply

string

Valid values[ "NotSpecified", "InclVat", "ExclVat" ]

rfmExclude

boolean

Default"False"

rfmRecency

integer (int32)

rfmFrequency

integer (int32)

rfmMonetary

number (double)

rfmRecencyRank

integer (int32)

rfmFrequencyRank

integer (int32)

rfmMonetaryRank

integer (int32)

rfmMonetaryFrequencyRank

integer (int32)

rfmAverageRank

number (double)

rfmSegmentId

integer (int32)

rfmChangedDateTime

string (date-time)

supplierNumber

integer (int64)

supplierName

string

supplierAcceptMsgsFrom

string

Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]

supplierAcceptShipmentMsgsFrom

string

Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]

supplierAcceptInvoiceMsgsFrom

string

Valid values[ "NotSpecified", "None", "EDI", "Abbyy" ]

supplierIban

string

supplierVatCode

string

supplierCancelled

boolean

Default"False"

debtorNumber

integer (int64)

debtorName

string

saleTypeCode

string

saleTypeDescription

string

rfmSegmentDescription

string

phoneNumber

string

faxNumber

string

gsmNumber

string

defaultEmailAddress

string

languageCode

string

languageDescription

string

visitAttentionOf

string

visitStreet

string

visitNumberPart1

integer (int32)

visitNumberPart2

string

visitAddress

string

visitAddressDescription

string

visitZipCode

string

visitCounty

string

visitCity

string

visitCountryId

integer (int32)

visitCountry

string

visitCountryIsoCode

string

postalAttentionOf

string

postalStreet

string

postalNumberPart1

integer (int32)

postalNumberPart2

string

postalAddress

string

postalAddressDescription

string

postalZipCode

string

postalCounty

string

postalCity

string

postalCountryId

integer (int32)

postalCountry

string

postalCountryIsoCode

string

invoiceAttentionOf

string

invoiceStreet

string

invoiceNumberPart1

integer (int32)

invoiceNumberPart2

string

invoiceAddress

string

invoiceAddressDescription

string

invoiceZipCode

string

invoiceCounty

string

invoiceCity

string

invoiceCountryId

integer (int32)

invoiceCountry

string

invoiceCountryIsoCode

string

deliveryAttentionOf

string

deliveryStreet

string

deliveryNumberPart1

integer (int32)

deliveryNumberPart2

string

deliveryAddress

string

deliveryAddressDescription

string

deliveryZipCode

string

deliveryCounty

string

deliveryCity

string

deliveryCountryId

integer (int32)

deliveryCountry

string

deliveryCountryIsoCode

string

401

Unauthorized

object

type

string

message

string

stackTrace

string

403

Forbidden

object

type

string

message

string

stackTrace

string

404

Not Found

object

type

string

message

string

stackTrace

string

Was this article helpful?