HostFact API versie 3.1
Debiteuren
Debiteuren zijn te beheren via de controller 'debtor'.
list
Middels deze functie kunt u een lijst met debiteuren ophalen. Zo kunt u bijvoorbeeld zoeken, waarbij u zelf meegeeft welke velden bekeken moeten worden, en filteren op een debiteurgroep.
Voorbeeldbestand: /voorbeelden/debtor/debtor.list.php
Invoerparameters:
Veldnaam | Waarde | Omschrijving |
---|---|---|
offset | int | Standaard: 0 |
limit | int | Standaard: 1000 |
sort | string | Standaard: DebtorCode (debiteurnummer) |
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 debiteurgroep ID |
created | filter_datetime | Filtermogelijkheid op aanmaakdatum |
modified | filter_datetime | Filtermogelijkheid op wijzigingsdatum |
Voorbeeld invoer:
<?php require_once("../hostfact_api.php"); $api = new HostFactAPI(); $debtorParams = array( //'searchat' => 'EmailAddress|Website', //'searchfor' => 'gmail.com' ); $response = $api->sendRequest('debtor', 'list', $debtorParams); print_r_pre($response); ?>
Voorbeeld uitvoer:
Array ( [controller] => debtor [action] => list [status] => success [date] => 2022-11-24T12:00:00+02:00 [totalresults] => 1 [currentresults] => 1 [offset] => 0 [debtors] => Array ( [0] => Array ( [Identifier] => 1 [DebtorCode] => DB0001 [CompanyName] => Company X [Sex] => m [Initials] => John [SurName] => Jackson [EmailAddress] => info@company.com [Modified] => 2022-11-24 11:00:00 ) ) )