Offsys documentatie

Klanten

Lijst

Veld	Waarde	Verplicht	Omschrijving
filter	Tekst	Nee	Zoek klanten met een filter
page	Getal	Nee	Zie pagina's
per_page	Getal	Nee	Zie pagina's

Voorbeeld:

curl "https://api.offsys.nl/customers" \
-G \
-H "Authorization: 37d37675-59cd-431c-8d28-9553de7bae4d" \
--data-urlencode "filter={name*=Jansen}"

Resultaat:

{
    "status": "success",
    "customers": [
        {
            "id": 318,
            "name": "Jansen Evenementen",
            "address": "Dorpsstraat 1",
            "postal": "1234 AB",
            "place": "Utrecht",
            "country": "NL",
            "phone": "0301234567",
            "email": "[email protected]",
            "kvk": "12345678",
            "btw": "NL001234567B01",
            "iban": "",
            "website": "",
            "info": "",
            "contacts": [
                {
                    "id": 2730,
                    "name": "Anna Jansen",
                    "phone": "0612345678",
                    "email": "[email protected]"
                }
            ]
        }
    ],
    "meta": {
        "total": 1,
        "per_page": 100,
        "current_page": 1,
        "last_page": 1
    }
}

Detail

Haal één klant op met het id.

Voorbeeld:

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

Resultaat:

{
    "status": "success",
    "customer": { ... }
}

De klant heeft dezelfde velden als bij Lijst.

Aanmaken

Veld	Waarde	Verplicht	Omschrijving
name	Tekst	Ja	Naam
address	Tekst	Nee	Adres
postal	Tekst	Nee	Postcode
place	Tekst	Nee	Plaats
country	Landcode, zoals NL, BE of DE	Nee	Standaard: NL
phone	Tekst	Nee	Telefoonnummer
email	Tekst	Nee	E-mailadres
kvk	Tekst	Nee	KvK-nummer
btw	Tekst	Nee	Btw-nummer
iban	Tekst	Nee	IBAN
website	Tekst	Nee	Website
info	Tekst	Nee	Interne notitie
contact[name]	Tekst	Nee	Naam van een contactpersoon
contact[phone]	Tekst	Nee	Telefoonnummer van de contactpersoon
contact[email]	Tekst	Nee	E-mailadres van de contactpersoon

Voorbeeld:

curl "https://api.offsys.nl/customer" \
-X POST \
-H "Authorization: 37d37675-59cd-431c-8d28-9553de7bae4d" \
-d "name=Jansen Evenementen" \
-d "address=Dorpsstraat 1" \
-d "postal=1234 AB" \
-d "place=Utrecht" \
-d "contact[name]=Anna Jansen" \
-d "contact[email][email protected]"

Resultaat:

{
    "status": "success",
    "customer": {
        "id": 318,
        "name": "Jansen Evenementen",
        "address": "Dorpsstraat 1",
        "postal": "1234 AB",
        "place": "Utrecht",
        "country": "NL",
        "phone": "",
        "email": "",
        "contact": {
            "id": 2730,
            "name": "Anna Jansen",
            "phone": "",
            "email": "[email protected]"
        }
    }
}

Wijzigen

Stuur alleen de velden mee die je wilt wijzigen. De andere velden blijven zoals ze zijn. Je kunt alle velden van Aanmaken gebruiken, behalve contact.

Contactpersonen wijzig je met contacts. Elke contactpersoon krijgt een eigen nummer: contacts[0], contacts[1] enzovoort. Met een id wijzig je een bestaande contactpersoon, zonder id voeg je een nieuwe toe.

Veld	Waarde	Verplicht	Omschrijving
contacts[0][id]	Getal	Nee	Id van de contactpersoon die je wilt wijzigen
contacts[0][name]	Tekst	Bij een nieuwe contactpersoon	Naam
contacts[0][phone]	Tekst	Nee	Telefoonnummer
contacts[0][email]	Tekst	Nee	E-mailadres

Contactpersonen die je niet meestuurt blijven staan. Verwijderen kan niet.

In het voorbeeld hieronder krijgt de klant een nieuw telefoonnummer, krijgt contactpersoon 2730 een nieuw e-mailadres en wordt Tom de Boer als nieuwe contactpersoon toegevoegd.

Voorbeeld:

curl "https://api.offsys.nl/customer/318" \
-X PUT \
-H "Authorization: 37d37675-59cd-431c-8d28-9553de7bae4d" \
-d "phone=0307654321" \
-d "contacts[0][id]=2730" \
-d "contacts[0][email][email protected]" \
-d "contacts[1][name]=Tom de Boer"

Resultaat:

De gewijzigde klant, met dezelfde velden als bij Lijst.

Offsys documentatie

Klanten

Klanten

Lijst

Detail

Aanmaken

Wijzigen

Beschikbaarheid

Locaties

Onderwerpen