Get all of yours clients
GET/account/client/
Get all of yours clients
Request
Query Parameters
- eq : égalité
- ne : différent (!=)
- lk : like. Pour les chaine de caractères, correspond au sql %valeur%
- lt : plus petit que (<)
- le : plus petit ou égal (<=)
- gt : plus grand que (>)
- ge : plus grand ou égal (>=)
The pagination you want to get, default 1,10 (page = 1; nb_elements = 10)
The filter you want to get, {champ}:{op}:{valeur},{champ_2}:{op_2}:{valeur_2}
The field names are specified in the web service documentation.
where {op} to be :
The orderby you want to get, {champ},{-champ_2}
The field names are specified in the web service documentation.
Sorting is ascending by default, for sorting descending the field must be preceded by the “-” sign.
Several filters can be combined by separating them with commas
Responses
- 200
- 204
- 400
- 500
Return a list of client
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
clientId
exUnId
firstName
lastName
fullName
gender
siret
rcs
vat
phone
mobile
fax
birthDayDate
active
isCompany
isMaster
typePayer
typeBeneficiary
supplierId
supplierName
supplierCodeShop
addressId
zip
city
country
address1
address2
address3
creationToken
freqVirementAuto
properties
iban
nameOfAccount
bankAccountId
[
{
"id": "9053",
"exUnId": "ID_EXTERNAL_SYSTEM_MAJ7",
"firstName": "firstName",
"lastName": "lastName",
"fullName": "lastName firstName",
"gender": "MR",
"siret": "Siret",
"rcs": "RCS",
"vat": "VAT",
"email": "test@olky.eu",
"phone": "+33382123456",
"mobile": "+33612345678",
"fax": "+33612345678",
"birthDayDate": "2023-01-22",
"active": "true",
"isCompany": "true",
"isMaster": "true",
"typePayer": "true",
"typeBeneficiary": "true",
"supplierId": "224",
"supplierName": "HOMOLOGATION OLKY PR",
"supplierCodeShop": "OU66AZ3712L",
"addressId": "null",
"zip": "12345",
"city": "city",
"country": "FR",
"address1": "address1",
"address2": "address2",
"address3": "address3",
"creationToken": "Unknown",
"freqVirementAuto": "null",
"properties": "null",
"iban": "FR701973300001OU66AZ3712L83",
"nameOfAccount": "Nom titulaire compte",
"bankAccountId": "6323"
}
]
No client list data found with this codeShop
We need a codeShop to found the client list data or use the '/' endpoint
ERROR Request