WeFact Standard API versie 3.1



Abonnementen

Abonnementen zijn te beheren via de controller 'subscription'.



terminate

Middels deze functie kunt u een overige dienst opzeggen/beeindigen.
Door 'TerminationDate' als lege parameter mee te geven maakt u een opzegging ongedaan. Het aantal keer dat het abonnement gefactureerd is wordt met deze actie gereset naar 0.
Voorbeeldbestand: /voorbeelden/subscription/subscription.terminate.php


Invoerparameters:
Veldnaam Waarde Omschrijving
Identifier int De unieke ID van een overige dienst
Subscription array Abonnementsregel:
- TerminationDate date     De datum waarop het abonnement opgezegd is
- TerminateAfter int     Aantal keer dat het abonnement gefactureerd
    moet worden. 0 = onbepaalde duur.
Verplichte velden: Identifier

Let op: U kunt of de TerminateAfter of de TerminationDate meegeven, niet allebei. De TerminateAfter is inclusief het aantal keer dat het abonnement in het verleden gefactureerd is.

Voorbeeld invoer:
$api->sendRequest('subscription', 'terminate', array(
	'Identifier'		=> '1',
	'Subscription'		=> array(
					'TerminationDate'	=> '2017-01-01'
					)
));

Voorbeeld uitvoer:
Array
(
    [controller] => subscription
    [action] => terminate
    [status] => success
    [date] => 2016-10-01T12:30:00+00:00
    [success] => Array
        (
            [0] => Abonnement 'Service contract' is opgezegd per 01-01-2017
        )

    [subscription] => Array
        (
			[Identifier] => 1
            [Debtor] => 1
            [DebtorCode] => DB0001
            [Number] => 1
            [NumberSuffix] =>
			[ProductCode] => P0002
            [Description] => Service contract
            [PriceExcl] => 75
            [PriceIncl] => 90.75
			[TaxPercentage] => 21
			[DiscountPercentage] => 0
            [Periods] => 1
            [Periodic] => m
            [StartPeriod] => 2014-05-16
            [EndPeriod] => 2014-06-16
            [NextDate] => 2014-05-15
            [Comment] =>
			[TerminateAfter] => 0
            [TerminationDate] => 2017-01-01
			[AmountExcl] => 75
            [AmountIncl] => 90.75
            [Created] => 2016-10-01 12:00:00
			[Modified] => 2016-10-01 12:00:00
        )

)