/Prospects
Description
Reads a list of prospects. The number of prospects, as well as other filtering options can be specified on the URL.
Request
URI Parameters
OnlyFavorites
boolean
Show only favourites.
OnlyMyProspects
boolean
If true, only "my prospects" are displayed, i.e. prospects who have an employee or representative who in turn is assigned to a SelectLine Merchandise Management user who is assigned to the SelectLine Mobile user
ProspectGroupNumber
string
Filter by interested persons group
IncludeInactive
boolean
If true, all inactive prospective customers are also shown.
Page
integer
Page number for paging | Default: 0
Items
integer
Sets the number of entries per page | Default: 10 | All: 0
SearchTerm
string
Filter for words
SearchIn
string
Properties in which to search. The separator between these properties is "|".
OrderBy
string
Properties to be sorted by. An exclamation mark ! at the end indicates downward sorting. To sort by several properties, they must be separated by a "|".
Filter
string
A filter can be defined to limit the result set. For example: (Property EQ Value OR Property2 GT Value2) AND (Property3 CT 'String') See the description for the FilterQueryLanguage for more information.
Body Parameters
None.
Response
Resource Description
Es wird ein vereinfachtes Interessentenmodel zurückgeliefert.
Payment
Payment data of interested persons.
Document
The document data of the prospective customer.
DefaultContactPersonId
integer
The abbreviation for the BusinessPerson's default contact person. Customer = [DEBITORS.DefaultContactPerson = CRM_ADDRESSEN.Id] Prospect = [WAWIINTERESS.DefaultContactPerson = CRM_ADDRESSEN.Id] Supplier = [CREDITORS.DefaultContactPerson = CRM_ADDRESSEN.Id]
DefaultContactPersonLabel
string
Nur lesen
The designation for the standard contact person of BusinessPerson.
GroupNumber
string
Länge: einschließlich zwischen 0 und 6
The number for the group of the BusinessPerson. Customer = [DEBITORS.Group = GROUP.Number (KG)] Prospect = [WAWIINTERESS.Group = GROUP.Number (LG)] Supplier = [CREDITORS.Group = GROUP.Number (LG)]
GroupLabel
string
Nur lesen
The designation for the group of BusinessPerson.
InternationalLocationNumber
string
Länge: einschließlich zwischen 0 und 35
The Global Location Number (GLN) is used to uniquely identify companies worldwide. It used to be called the International Location Number (ILN).
EmployeeNumber
string
Länge: einschließlich zwischen 0 und 6
The abbreviation for the employee of the BusinessPerson. Customer = [DEBITORS.Employee = EMPLOYEEW.Nr] Interested party = [WAWIINTERESS.Employee = EMPLOYEE.NO] Supplier = [CREDITORS.Employee = EMPLOYEEW.NO]
EmployeeLabel
string
Nur lesen
The designation for the employee of BusinessPerson.
SalesmanNumber
string
Länge: einschließlich zwischen 0 und 6
The abbreviation for the representative of the BusinessPerson. Customer = [DEBITORS.Representative = EMPLOYEEW.No] Interested party = [WAWIINTERESS.Representative = EMPLOYEEW.No] Supplier = [CREDITORS.Representative = EMPLOYEEW.No]
SalesmanLabel
string
Nur lesen
The designation for the representatives of BusinessPerson.
OwnNumber
string
Länge: einschließlich zwischen 0 und 15
The own delivery or customer number. Customer = [DEBITOREN.OwnNumber] Interested party = [WAWIINTERESS.OwnNumber] Supplier = [CREDITORS.OwnNumber]
AccountGroupNumber
string
Länge: einschließlich zwischen 0 und 6
The abbreviation for the BusinessPerson's account group. Customer = [DEBITORS.AccountGroup = GROUP.Number AND Group.Id = 'CK] Prospect = [WAWIINTERESS.AccountGroup = GROUP.Number AND Group.Id = 'CK'/'CL'] Supplier = [CREDITORS.AccountGroup = GROUP.Number AND Group.Id = 'CL']
AccountGroupLabel
string
Nur lesen
The designation for the account group of BusinessPerson.
IsInactive
boolean
Indicates whether the BusinessPerson is inactive. [DEBITORS.Inactive]
LanguageId
string
Länge: einschließlich zwischen 0 und 6
The abbreviation for the language of the BusinessPerson. [DEBITORS.Language = SL_Data.DGRUPPEN.Number (SP)]
LanguageLabel
string
Nur lesen
The designation for the language of BusinessPerson.
IsFavorite
boolean
Nur lesen
Indicates whether BusinessPerson is a favorite.
CountryOfEurope
string
Gibt das EU-Land an
Number
string
Länge: einschließlich zwischen 0 und 13
The number of the record.
Salutation
string
Länge: einschließlich zwischen 0 und 30
The salutation of business partner.[CRM-Addresses.Salutation]
LetterSalutation
string
Länge: einschließlich zwischen 0 und 50
The salutation of business partner.[CRM_Addresses.LetterSalutation]
Title
string
Länge: einschließlich zwischen 0 und 30
The title of the business partner.[CRM_Addresses.Title]
FirstName
string
Länge: einschließlich zwischen 0 und 40
The first name of the business partner.[CRM_Addresses.FirstName]
LastName
string
Länge: einschließlich zwischen 0 und 80
The surname of the business partner. [CRM_Addresses.Name]
Company
string
Länge: einschließlich zwischen 0 und 80
The firm name of the business partner.[CRM_Addresses.Firm]
Department
string
Länge: einschließlich zwischen 0 und 80
The department of the business partner. [CRM_Addresss.Department]
Function
string
Länge: einschließlich zwischen 0 und 80
The function of the business partner.[CRM_Addresses.Function]
BirthDay
date
The birthday of the business partner. [CRM_Adressen.Birthday]
TrafficRouteKind
string
The type of transport mode of the customer.
TrafficRouteKindLabel
string
The name of the customer´s mode of transport.
Address
The address data of business partner.
PostOfficeBox
The mailbox data of business partners.
Contact
The contact data of business partners.
CustomField
The 'free fields' of customers.
MetaData
Creation / processing data of the business partner
Response Formats
application/json
Example:
[
{
"Payment": {
"CreditLimitAmount": 1.1,
"IsReminderLock": true,
"IsPaymentLock": true,
"SpecialDiscountPercent": 4.1,
"MinimumOrderAmount": 5.1,
"FinancialAccountId": "sample string 6",
"FinancialAccountLabel": "sample string 7",
"PaymentConditionId": "sample string 8",
"PaymentConditionsLabel": "sample string 9",
"AutomaticPaymentFlag": "sample string 10",
"AutomaticPaymentLabel": "sample string 11",
"CostCentreNumber": "sample string 12",
"CostCentreLabel": "sample string 13",
"CurrencyId": "sample string 14",
"CurrencyLabel": "sample string 15",
"TaxNumber": "sample string 16",
"TaxIdentifierNumber": "sample string 17",
"PriceGroupNumber": "sample string 18",
"PriceGroupLabel": "sample string 19",
"PriceTypeFlag": "sample string 20",
"DiscountGroupNumber": "sample string 21",
"DiscountGroupLabel": "sample string 22",
"InvoiceRecipientProspectNumber": "sample string 23",
"InvoiceRecipientProspectLabel": "sample string 24",
"PriceReferenceProspectNumber": "sample string 25",
"PriceReferenceProspectLabel": "sample string 26"
},
"Document": {
"IsDocumentLock": true,
"DefaultDeliveryAddressId": 1,
"DefaultDeliveryAddressLabel": "sample string 2",
"WarehouseLocationId": "sample string 3",
"WarehouseLocationLabel": "sample string 4",
"WarehouseId": "sample string 5",
"WarehouseLabel": "sample string 6",
"DeliveryConditionId": "sample string 7",
"DeliveryConditionLabel": "sample string 8",
"DocumentChargeArticleId": "sample string 9",
"DocumentChargeArticleLabel": "sample string 10"
},
"DefaultContactPersonId": 1,
"DefaultContactPersonLabel": "sample string 1",
"GroupNumber": "sample string 2",
"GroupLabel": "sample string 3",
"InternationalLocationNumber": "sample string 4",
"EmployeeNumber": "sample string 5",
"EmployeeLabel": "sample string 6",
"SalesmanNumber": "sample string 7",
"SalesmanLabel": "sample string 8",
"OwnNumber": "sample string 9",
"AccountGroupNumber": "sample string 10",
"AccountGroupLabel": "sample string 11",
"IsInactive": true,
"LanguageId": "sample string 13",
"LanguageLabel": "sample string 14",
"IsFavorite": true,
"CountryOfEurope": "sample string 16",
"Number": "sample string 17",
"Salutation": "sample string 18",
"LetterSalutation": "sample string 19",
"Title": "sample string 20",
"FirstName": "sample string 21",
"LastName": "sample string 22",
"Company": "sample string 23",
"Department": "sample string 24",
"Function": "sample string 25",
"BirthDay": "2024-04-25T03:54:01.1198745+02:00",
"TrafficRouteKind": "sample string 26",
"TrafficRouteKindLabel": "sample string 27",
"Address": {
"Street": "sample string 1",
"City": "sample string 2",
"ZipCode": "sample string 3",
"CountryId": "sample string 4",
"AdditionalInformation1": "sample string 5",
"AdditionalInformation2": "sample string 6",
"AdditionalInformation3": "sample string 7",
"MetaData": {
"CreationDate": "2024-04-25T03:54:01.1198745+02:00",
"CreationUserToken": "sample string 1",
"ModificationDate": "2024-04-25T03:54:01.1198745+02:00",
"ModificationUserToken": "sample string 2"
}
},
"PostOfficeBox": {
"Number": "sample string 1",
"ZipCode": "sample string 2",
"City": "sample string 3",
"CountryId": "sample string 4"
},
"Contact": {
"FaxNumber": "sample string 1",
"TelephoneNumber1": "sample string 2",
"TelephoneNumber2": "sample string 3",
"TelephoneNumber3": "sample string 4",
"TelephoneNumber4": "sample string 5",
"EMail1": "sample string 6",
"EMail2": "sample string 7",
"HomePageUrl": "sample string 8"
},
"CustomField": {
"Text1": "sample string 1",
"Text2": "sample string 2",
"Number1": 1.1,
"Number2": 1.1,
"Number3": 1,
"Number4": 1,
"Date1": "2024-04-25T03:54:01.1198745+02:00",
"Date2": "2024-04-25T03:54:01.1198745+02:00",
"Flag1": true,
"Flag2": true,
"Flag3": true,
"Flag4": true
},
"MetaData": {
"CreationDate": "2024-04-25T03:54:01.1198745+02:00",
"CreationUserToken": "sample string 1",
"ModificationDate": "2024-04-25T03:54:01.1198745+02:00",
"ModificationUserToken": "sample string 2"
}
},
{
"Payment": {
"CreditLimitAmount": 1.1,
"IsReminderLock": true,
"IsPaymentLock": true,
"SpecialDiscountPercent": 4.1,
"MinimumOrderAmount": 5.1,
"FinancialAccountId": "sample string 6",
"FinancialAccountLabel": "sample string 7",
"PaymentConditionId": "sample string 8",
"PaymentConditionsLabel": "sample string 9",
"AutomaticPaymentFlag": "sample string 10",
"AutomaticPaymentLabel": "sample string 11",
"CostCentreNumber": "sample string 12",
"CostCentreLabel": "sample string 13",
"CurrencyId": "sample string 14",
"CurrencyLabel": "sample string 15",
"TaxNumber": "sample string 16",
"TaxIdentifierNumber": "sample string 17",
"PriceGroupNumber": "sample string 18",
"PriceGroupLabel": "sample string 19",
"PriceTypeFlag": "sample string 20",
"DiscountGroupNumber": "sample string 21",
"DiscountGroupLabel": "sample string 22",
"InvoiceRecipientProspectNumber": "sample string 23",
"InvoiceRecipientProspectLabel": "sample string 24",
"PriceReferenceProspectNumber": "sample string 25",
"PriceReferenceProspectLabel": "sample string 26"
},
"Document": {
"IsDocumentLock": true,
"DefaultDeliveryAddressId": 1,
"DefaultDeliveryAddressLabel": "sample string 2",
"WarehouseLocationId": "sample string 3",
"WarehouseLocationLabel": "sample string 4",
"WarehouseId": "sample string 5",
"WarehouseLabel": "sample string 6",
"DeliveryConditionId": "sample string 7",
"DeliveryConditionLabel": "sample string 8",
"DocumentChargeArticleId": "sample string 9",
"DocumentChargeArticleLabel": "sample string 10"
},
"DefaultContactPersonId": 1,
"DefaultContactPersonLabel": "sample string 1",
"GroupNumber": "sample string 2",
"GroupLabel": "sample string 3",
"InternationalLocationNumber": "sample string 4",
"EmployeeNumber": "sample string 5",
"EmployeeLabel": "sample string 6",
"SalesmanNumber": "sample string 7",
"SalesmanLabel": "sample string 8",
"OwnNumber": "sample string 9",
"AccountGroupNumber": "sample string 10",
"AccountGroupLabel": "sample string 11",
"IsInactive": true,
"LanguageId": "sample string 13",
"LanguageLabel": "sample string 14",
"IsFavorite": true,
"CountryOfEurope": "sample string 16",
"Number": "sample string 17",
"Salutation": "sample string 18",
"LetterSalutation": "sample string 19",
"Title": "sample string 20",
"FirstName": "sample string 21",
"LastName": "sample string 22",
"Company": "sample string 23",
"Department": "sample string 24",
"Function": "sample string 25",
"BirthDay": "2024-04-25T03:54:01.1198745+02:00",
"TrafficRouteKind": "sample string 26",
"TrafficRouteKindLabel": "sample string 27",
"Address": {
"Street": "sample string 1",
"City": "sample string 2",
"ZipCode": "sample string 3",
"CountryId": "sample string 4",
"AdditionalInformation1": "sample string 5",
"AdditionalInformation2": "sample string 6",
"AdditionalInformation3": "sample string 7",
"MetaData": {
"CreationDate": "2024-04-25T03:54:01.1198745+02:00",
"CreationUserToken": "sample string 1",
"ModificationDate": "2024-04-25T03:54:01.1198745+02:00",
"ModificationUserToken": "sample string 2"
}
},
"PostOfficeBox": {
"Number": "sample string 1",
"ZipCode": "sample string 2",
"City": "sample string 3",
"CountryId": "sample string 4"
},
"Contact": {
"FaxNumber": "sample string 1",
"TelephoneNumber1": "sample string 2",
"TelephoneNumber2": "sample string 3",
"TelephoneNumber3": "sample string 4",
"TelephoneNumber4": "sample string 5",
"EMail1": "sample string 6",
"EMail2": "sample string 7",
"HomePageUrl": "sample string 8"
},
"CustomField": {
"Text1": "sample string 1",
"Text2": "sample string 2",
"Number1": 1.1,
"Number2": 1.1,
"Number3": 1,
"Number4": 1,
"Date1": "2024-04-25T03:54:01.1198745+02:00",
"Date2": "2024-04-25T03:54:01.1198745+02:00",
"Flag1": true,
"Flag2": true,
"Flag3": true,
"Flag4": true
},
"MetaData": {
"CreationDate": "2024-04-25T03:54:01.1198745+02:00",
"CreationUserToken": "sample string 1",
"ModificationDate": "2024-04-25T03:54:01.1198745+02:00",
"ModificationUserToken": "sample string 2"
}
}
]