Nieuwe API v2
Er is een nieuwe API versie 2 beschikbaar, klik hier om naar de documentatie te gaan.

WeFact Hosting API versie 1.08



Abonnementen

Hieronder vindt u alle commando's die beschikbaar zijn voor de abonnementen.



listSubscriptions

Middels deze functie kunt u een lijst met abonnementen ophalen.
Voorbeeldbestand: /voorbeelden/listsubscriptions.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
Sort Nee String Te sorteren kolom
Order Nee String ASC of DESC
Search Nee String Zoeken op debiteurnummer, bedrijfsnaam en achternaam
DebtorID Nee Int Abonnementen van een specifieke debiteur ophalen

Voorbeeld invoer:
$client->listSubscriptions('beveiligingscode', array(
	"Sort" 		=> "NextDate",
	"Order" 	=> "ASC",
	"Search" 	=> "",
	"Debtor"	=> ""
	)
);

Voorbeeld uitvoer:
stdClass Object
(
    [Status] => success
    [Time] => 2011-01-01 10:00:00
    [IP] => 11.111.111.11
    [Count] => 1
    [Filter] => stdClass Object
        (
            [Sort] => NextDate
            [Order] => ASC
            [Search] => wefact
            [Debtor] => 
        )

    [Result] => stdClass Object
        (
            [Subscriptions] => Array
                (
                    [0] => stdClass Object
                        (
                            [Identifier] => 1
                            [Debtor] => 1
                            [ProductCode] => DOM_NL
                            [Description] => wefact.nl
                            [StartPeriod] => 01-01-2011
                            [EndPeriod] => 01-01-2012
                            [Periods] => 1
                            [Periodic] => j
                            [NextDate] => 01-01-2012
                            [PriceExcl] => 5.72
                            [TaxPercentage] => 0.21
                            [Number] => 1
                            [TerminationDate] => 
                        )
                )
        )
)



addSubscription

Met deze functie kunt u buiten WeFact een abonnement aanmaken. Indien de volgende facturatiedatum bereikt is, zal automatisch een factuur worden aangemaakt door WeFact Standard.
Indien er bij het aanmaken van een abonnement een product wordt opgegeven, zal automatisch ontbrekende informatie worden aangevuld met informatie van dit product. Zo is het niet nodig om de productprijs mee te geven, als deze niet afwijkt van de productprijs.
Voorbeeldbestand: /voorbeelden/addsubscription.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
Debtor Ja String
ProductCode Nee String
Description Ja String
StartPeriod Ja String Formaat: jjjj-mm-dd
NextDate Ja String Formaat: jjjj-mm-dd
Periods Ja Int Standaard: 1
Periodic Ja String Zie variabelen-lijst
PriceExcl Ja Float
TaxPercentage Ja Float
Number Ja Float
TerminationDate Nee String Formaat: jjjj-mm-dd
Account Nee String Accountnaam indien het een hostingpakket betreft
Domain Nee String Domeinnaam indien het een domeinnaam betreft

Voorbeeld invoer:
$client->addSubscription('beveiligingscode',array(
	'Debtor' 			=> 1,
	'ProductCode' 			=> 'P0001',
	'Description' 			=> 'Domeinnaam uwdomein.nl',
	'StartPeriod' 			=> '2010-01-31',
	'NextDate' 			=> '2010-01-31', 
	'Periods' 			=> 1,
	'Periodic' 			=> 'j',
	'PriceExcl' 			=> 7.5,
	'TaxPercentage' 		=> 0.21,
	'Number' 			=> 1,
	'TerminationDate' 		=> '2011-01-31',
	'Domain'			=> 'uwdomein.nl'
));

Voorbeeld uitvoer:
Array
(
    [Status] => success
    [Time] => 2010-01-01 10:00:00
    [IP] => 11.111.111.11
    [Count] => 1
    [Result] => Array
        (
            [Subscription] => Array
                (
		   [Identifier] => 1
                   [Debtor] => 1
                   [ProductCode] => P0001
                   [Description] => Domeinnaam uwdomein.nl
                   [StartPeriod] => 2010-01-31
                   [EndPeriod] => 2011-01-31
                   [Periods] => 1
                   [Periodic] => j
                   [NextDate] => 2010-01-31
		   [PriceExcl] => 7.5
                   [TaxPercentage] =>0.21
                   [Number] => 1
                   [TerminationDate] => 2011-01-31
		   [Domain] => uwdomein.nl
	       )
        )
)



terminateSubscription

Met deze functie kan een abonnement opgezegd worden, zodat het abonnement niet meer gefactureerd wordt na de opzegdatum.
Let op: deze functie zorgt er niet voor dat een domeinnaam automatisch wordt opgezegd bij de registrar, of dat een hostingpakket van de server wordt verwijderd.
Voorbeeldbestand: /voorbeelden/terminatesubscription.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
SubscriptionID Ja Int Het ID nummer van het abonnement, welke retour wordt gegeven bij het aanmaken van een abonnement.
TerminationDate Nee String De opzegdatum. Na deze datum worden geen facturen meer gemaakt. Indien leeggelaten, wordt de datum van vandaag gebruikt.
Formaat: jjjj-mm-dd
AgendaItem Nee Boolean Geef aan of er in WeFact een agenda-item aangemaakt moet worden en daardoor ook een bijbehorende e-mailnotifcatie op de opzegdatum.

Voorbeeld invoer:
$client->terminateSubscription('beveiligingscode', 1, '2012-01-01', true);

Voorbeeld uitvoer:
stdClass Object
(
    [Status] => success
    [Time] => 2010-01-01 10:00:00
    [IP] => 11.111.111.11
    [Count] => 1
    [Result] => Array
        (
            [Value] =>U dient eventuele domeinnamen of hostingaccounts nog handmatig te verwijderen
	)
)