HostFact API versie 3.1
Crediteuren
Crediteuren zijn te beheren via de controller 'creditor'.
list
Middels deze functie kunt u een lijst met crediteuren ophalen. Zo kunt u bijvoorbeeld zoeken, waarbij u zelf meegeeft welke velden bekeken moeten worden, en filteren op een crediteurgroep.
Voorbeeldbestand: /voorbeelden/creditor/creditor.list.php
Invoerparameters:
| Veldnaam | Waarde | Omschrijving |
|---|---|---|
| offset | int | Standaard: 0 |
| limit | int | Standaard: 1000 |
| sort | string | Standaard: CreditorCode (crediteurnummer) |
| order | 'ASC' of 'DESC' | Standaard: ASC |
| searchat | string | Welke velden doorzocht moeten worden. Standaard: CreditorCode|CompanyName|SurName |
| searchfor | string | Zoekterm |
| group | int | Filter op specifieke crediteurgroep ID |
| created | filter_datetime | Filtermogelijkheid op aanmaakdatum |
| modified | filter_datetime | Filtermogelijkheid op wijzigingsdatum |
Voorbeeld invoer:
<?php
require_once("../hostfact_api.php");
$api = new HostFactAPI();
$creditorParams = array(
'searchfor' => 'Meusmann'
);
$response = $api->sendRequest('creditor', 'list', $creditorParams);
print_r_pre($response);
?>Voorbeeld uitvoer:
Array
(
[controller] => creditor
[action] => list
[status] => success
[date] => 2022-11-24T12:00:00+02:00
[totalresults] => 0
[currentresults] => 0
[offset] => 0
[filters] => Array
(
[searchfor] => Meusmann
)
)