HostFact API

HostFact API versie 3.1

Bestelling

Bestellingen zijn te beheren via de controller 'order'.

edit

Met behulp van deze functie is het mogelijk om een bestelling te bewerken.
Alleen ingevoerde parameters worden gewijzigd.
Voorbeeldbestand: /voorbeelden/order/order.edit.php

Invoerparameters:

Veldnaam	Waarde	Omschrijving
Identifier	int	De unieke ID van een bestelling
OrderCode	string	Het bestelnummer Geef deze parameter niet mee wanneer het bestelnummer automatisch bepaald mag worden.
Debtor	int	De unieke ID van een debiteur
DebtorCode	string	Het debiteurnummer
Date	datetime	De datum van de bestelling
Term	int	Betaaltermijn in dagen
Discount	float	Korting (totale factuur): percentage 0 - 100
IgnoreDiscount	'0' of '1'	Kortingsmodule negeren (0 = nee en 1 = ja) Standaard: 0
Coupon	string	Kortings actiecode/coupon
VatCalcMethod	'excl' of 'incl'	BTW rekenen op basis van exclusief of inclusief BTW? Standaard: gebruikt administratie instelling
CompanyName	string	Debiteur: bedrijfsnaam
Sex	'm', 'f', 'd' of 'u'	Debiteur: geslacht. Standaard: 'm'
Initials	string	Debiteur: voornaam
SurName	string	Debiteur: achternaam
Address	string	Debiteur: adres
ZipCode	string	Debiteur: postcode
City	string	Debiteur: plaats
Country	string	Debiteur: land, zie variabelen-lijst
EmailAddress	string	Debiteur: e-mailadres
InvoiceMethod	int	Factuur verzendmethode, zie variabelen-lijst. Standaard: voorkeur debiteur
Template	int	Factuur template ID. Standaard: debiteur instelling
Authorisation	'yes' of 'no'	Automatische incasso, standaard: voorkeur debiteur
Paid	'0' of '1'	Is de bestelling betaald (0 = nee en 1 = ja) Standaard: 0
PaymentMethod	string	Betaalmethode hoe de bestelling is betaald, zie variabelen-lijst
TransactionID	string	Transactie ID van (online) betaling
IPAddress	string	IP-adres van debiteur
Comment	text	Opmerking
Status	int	Bestelstatus, zie variabelen-lijst. Standaard: 0 (Ontvangen)
OrderLines	array	Bestelregel:
- Identifier	int	De unieke ID van een regel
- Date	date	Datum. Standaard: vandaag
- Number	float	Aantal. Standaard: 1
- ProductCode	string	Productnummer
- Description	text	Omschrijving
- PriceExcl	float	Prijs per stuk (excl. BTW)
- DiscountPercentage	float	Korting bestelregel, percentage: 0 - 100
- DiscountPercentageType	'line' of 'subscription'	Type korting (enkel bestelregel of later ook voor abonnement)
- TaxPercentage	float	BTW percentage: 0 - 100
- PeriodicType	'once' of 'period'	Periodiek factureren? Standaard: 'once' (eenmalig)
- Periods	int	Factureer iedere: aantal periodes
- Periodic	string	Factureer iedere: eenheid, zie variabelen-lijst
- ProductType	string	Gekoppelde dienst: domain, hosting of ssl. Standaard: leeg
- Reference	int	Het kenmerk van de gekoppelde dienst

Verplichte velden: Identifier of OrderCode en TransactionID (alleen bij een betaalde bestelling)

* Debiteurgegevens worden automatisch ingevuld door de variabele 'Debtor' of 'DebtorCode'.
** Factuurregel: Indien 'ProductCode' wordt meegegeven worden automatisch de 'Description', 'PriceExcl', 'TaxPercentage', 'PeriodicType', 'Periods', 'Periodic' en 'StartPeriod' ingevuld.

Voorbeeld invoer:

<?php

require_once("../hostfact_api.php");

$api = new HostFactAPI();

$orderParams = array(
				'Identifier' 		=> 1,
				
				'OrderLines' 		=> array(
					array(
						'Identifier'	=> 1,
						'Description'	=> 'Free domain example.com',
						'PriceExcl' 	=> 0
					)
				)
);

$response = $api->sendRequest('order', 'edit', $orderParams);

print_r_pre($response);

?>

Voorbeeld uitvoer: