Offsys documentatie

Klanten

Klanten

Haal klantinformatie op of voeg een nieuwe klant toe.

List

VeldStandaardVerplichtOmschrijving
filter-NeeZoek klanten op basis van bepaalde filters

Voorbeeld:

curl "https://api.offsys.nl/customers" \
-X GET \
-H "Authorization: 37d37675-59cd-431c-8d28-9553de7bae4d"

Resultaat:

{
"status": "success",
"customers": [
{
"id": 1,
"name": "",
"address": "",
"zipcode": "",
"city": "",
"country": "",
"phone": "",
"email": "",
"contacts": [
{
"id": 1,
"name": "",
"phone": "",
"email": ""
},
{
"id": 2,
"name": "",
"phone": "",
"email": ""
}
]
},
{
"id": 2,
"name": "",
"address": "",
"zipcode": "",
"city": "",
"country": "",
"phone": "",
"email": "",
"contacts": []
}
]
}

Create

VeldWaardeVerplichtOmschrijving
nameStringJa
addressStringNee
zipcodeStringNee
cityStringNee
countryISO 3166-1 alpha-2 landcode, bijv. 'NL', 'BE', 'DE' of 'GB'NeeStandaardwaarde: NL
phoneStringNee
emailStringNee
kvkStringNee
btwStringNee
ibanStringNee
websiteStringNee
infoTextNee
contactArrayNee
- nameStringJa
- phoneStringNee
- emailStringNee

Voorbeeld:

curl "https://api.offsys.nl/customer" \
-X POST \
-H "Authorization: 37d37675-59cd-431c-8d28-9553de7bae4d" \
-d "name=Bedrijfsnaam" \
-d "address=Adres 1" \
-d "zipcode=1234 AB" \
-d "city=Amsterdam" \
-d "country=NL"

Resultaat:

{
"status": "success",
"customer": {
"id": 1,
"name": "",
"address": "",
"zipcode": "",
"city": "",
"country": "",
"phone": "",
"email": "",
"contact": [
{
"id": 1,
"name": "",
"phone": "",
"email": ""
}
]
}
}

Onderwerpen