Klanten

Klanten zijn te beheren via de controller 'debtor'.


list

Middels deze functie kunt u een lijst met klanten ophalen. Zo kunt u bijvoorbeeld zoeken, waarbij u zelf meegeeft welke velden bekeken moeten worden, en filteren op een klantgroep.


Invoerparameters:


Veldnaam Waarde Omschrijving
offset int Standaard: 0
limit int Standaard: 1000
sort string Standaard: DebtorCode (klantnummer]
order 'ASC' of 'DESC' Standaard: ASC
searchat string Welke velden doorzocht moeten worden.
Standaard: DebtorCode|CompanyName|SurName
searchfor string Zoekterm
group int Filter op specifieke klantgroep ID
created filter_datetime Filtermogelijkheid op aanmaakdatum
modified filter_datetime Filtermogelijkheid op wijzigingsdatum

Voorbeeld invoer:


$parameters = [
    "searchat" => "EmailAddress",
    "searchfor" => "info@example.com"
];

$api->sendRequest('debtor', 'list', $parameters);

Voorbeeld uitvoer:


Array
(
    [controller] => debtor
    [action] => list
    [status] => success
    [date] => 2024-01-21T12:00:00+02:00
    [totalresults] => 1
    [currentresults] => 1
    [offset] => 0
    [filters] => Array
        (
            [searchat] => EmailAddress
            [searchfor] => info@example.com
        )

    [debtors] => Array
        (
            [0] => Array
                (
                    [Identifier] => 1
                    [DebtorCode] => DB10000
                    [CompanyName] => Jan Janssen B.V.
                    [Sex] => m
                    [Initials] => Jan
                    [SurName] => Janssen
                    [EmailAddress] => info@example.com
                    [Modified] => 2024-01-21 11:00:00
                )

        )

)