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



Facturen

Hieronder vindt u alle commando's die beschikbaar zijn voor het onderdeel facturen.



getInvoiceID

Met deze functie kan het ID van een factuur opgevraagd worden.
Voorbeeldbestand: /voorbeelden/getinvoiceid.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
InvoiceCode Ja String Het factuurnummer van een factuur

Voorbeeld invoer:
$client->getInvoiceID('beveiligingscode','F0001');

Voorbeeld uitvoer:
stdClass Object
(
    [Status] => success
    [Time] => 2010-01-01 10:00:00
    [IP] => 11.111.111.11
    [Count] => 1
    [Result] => Array
        (
            [Value] =>1
	)
)



getInvoice

Middels deze functie kunt u meer informatie over een factuur ophalen.
Voorbeeldbestand: /voorbeelden/getinvoice.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
Invoice ID Ja Int De unieke ID van een factuur, op te halen via de listInvoice functie of getInvoiceID functie

Voorbeeld invoer:
$client->getInvoice('beveiligingscode',1);

Voorbeeld uitvoer:
stdClass Object
(
    [Status] => success
    [Time] => 2010-01-01 10:00:00
    [IP] => 11.111.111.11
    [Count] => 1
    [Result] => stdClass Object
        (
            [Invoice] => stdClass Object
                (
              	   [Identifier] => 1
                   [Debtor] => 1
                   [DebtorCode] => DB0001
                   [InvoiceCode] => F0001
        	   [Date] => 2011-01-01
                   [Description] =>
                   [Term] => 14
                   [Discount] => 0
                   [ReferenceNumber] =>
                   [CompanyName] =>WeFact B.V.
		   [Initials] => A.B.C.
                   [SurName] => de Vries
                   [Address] => Nieuwstraat 1
                   [ZipCode] => 1111 AA
                   [City] => Amsterdam
		   [Country] => NL
            	   [EmailAddress] => info@wefact.nl
                   [Authorisation] => Nee
                   [InvoiceMethod] => 0
                   [SentDate] => 0000-00-00 00:00:00
                   [Sent] => 0
                   [Reminders] => 1
                   [RemiderDate] => 2011-01-01
                   [Summations] => 0
                   [SummationDate] => 0000-00-00
                   [PaymentMethod] => ideal
                   [PaymentLink] =>
                   [Paid] => 1
            	   [TransactionID] => 123456
                   [Status] => 4
              	   [AmountExcl] => 100.00
              	   [AmountIncl] => 119.00
                   [InvoiceLines] => Array
                        (
                            [0] => stdClass Object
                                (
                                    [Debtor] => 1
           			    [InvoiceCode] => F0001
                    		    [Date] =>2011-01-01
                                    [Number] => 1
        			    [ProductCode] => P0001
                                    [Description] =>Omschrijving
               			    [PriceExcl] => 100
                                    [TaxPercentage] => 0.21
                                    [Periods] => 1
                                    [Periodic] =>
                                    [PeriodicID] => 0
                                    [StartPeriod] =>
                                    [EndPeriod] =>
    			       )
                        )
                )
 	)
)



listInvoices

Middels deze functie kunt u een lijst met facturen ophalen.
Voorbeeldbestand: /voorbeelden/listinvoices.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
Sort Nee String Te sorteren kolom
Order Nee String ASC of DESC
Search Nee String Zoeken op factuurnummer, bedrijfsnaam en achternaam
Debtor Nee Int ID van de debiteur voor ophalen facturen van één specifieke debiteur
DebtorCode Nee String Ophalen facturen van een debiteur aan de hand van debiteurnummer
StartDate Nee String Filter resultaten op factuurdatum
Formaat: jjjj-mm-dd
EndDate Nee String Filter resultaten op factuurdatum
Formaat: jjjj-mm-dd
Status Nee String Filter resultaten op status

Voorbeeld invoer:
$client->listInvoices('beveiligingscode',array(
'Sort'		=> 'InvoiceCode',
'Order'		=> 'ASC',
'Search'	=> 'wefact'
));

Voorbeeld uitvoer:
Array
(
    [Status] => success
    [Time] => 2010-01-01 10:00:00
    [IP] => 11.111.111.11
    [Count] => 1
    [Filter] => Array
        (
            [Sort] =>InvoiceCode
            [Order] => ASC
            [Search] =>wefact
        )

    [Result] => Array
        (
            [Debtors] => Array
                (
                    [0] => Array
                        (
                            [Identifier] => 1
                            [InvoiceCode] => F0001
                            [Debtor] => 1
                            [DebtorCode] => DB0001
                            [CompanyName] =>
                            [Initials] =>ABC
                            [SurName] =>de Vries
                            [AmountExcl] =>100.00
                            [AmountIncl] =>119.00
                            [Date] =>2011-01-01
                            [Status] => 0
		       )
                )
        )
)



addInvoice

Voeg een factuur toe in WeFact. Indien de factuur de status concept krijgt, dient er geen factuurnummer meegegeven te worden.
Voorbeeldbestand: /voorbeelden/addinvoice.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
InvoiceCode Nee String Indien leeg, wordt deze automatisch bepaald
Debtor Ja Int Debtor of DebtorCode verplicht
DebtorCode Ja String Debtor of DebtorCode verplicht
Date Nee String jjjj-mm-dd
Term Nee Int Betaaltermijn
Discount Nee String Korting in percentage over totale factuurbedrag
ReferenceNumber Nee String Referentie
CompanyName Nee String Bedrijfsnaam of achternaam is verplicht
Initials Nee String
SurName Nee String Bedrijfsnaam of achternaam is verplicht
Address Nee String
ZipCode Nee String
City Nee String
Country Ja String Zie variabelen-lijst
EmailAddress Nee String
InvoiceMethod Nee Int Zie variabelen-lijst, standaard is per e-mail
Authorisation Nee String 'yes' of 'no', standaard waarde is 'no'
ReminderDate Nee String Formaat: jjjj-mm-dd
SummationDate Nee String Formaat: jjjj-mm-dd
Status Ja Int Zie variabelen-lijst
InvoiceLines Ja Array
  - Date Nee String Formaat: jjjj-mm-dd
  - Number Ja Float
  - ProductCode Nee String
  - Description Nee * String
  - PriceExcl Nee * Float
  - TaxPercentage Nee Float
  - Periods Nee Float
  - Periodic Nee String Zie variabelen-lijst
  - StartPeriod Nee String Formaat: jjjj-mm-dd
  - Account Nee String Accountnaam indien het een hostingpakket betreft
  - Domain Nee String Domeinnaam indien het een domeinnaam betreft

* Omschrijving en prijs worden automatisch ingevuld wanneer ProductCode wordt meegegeven.

Voorbeeld invoer:
$client->addInvoice('beveiligingscode',array(
	'DebtorCode'		=> 'DB0001',
	'Date'			=> '2010-01-31',
	'Term'			=> '30',
	'Discount'		=> '10',
	'ReferenceNumber'	=> 'AA-111',
	'CompanyName'		=> 'WeFact',
	'Initials'		=> 'ABC',
	'SurName'		=> 'de Vries',
	'Address'		=> 'Nieuwstraat 1',
	'ZipCode'		=> '1111 AA',
	'City'			=> 'Amsterdam',
	'Country'		=> 'NL',
	'EmailAddress'		=> 'info@wefact.nl',
	'InvoiceMethod'		=> 1,
	'Authorisation'		=> 'yes',
	'Status'		=> 0,
	'InvoiceLines'		=> array(
		array(
			'Number'		=> 1,
			'ProductCode'		=> 'P0001',
			'Domain'		=> 'uwdomein.nl'
		),
		array(
			'Date'			=> '2010-12-01',
			'Number'		=> 1,
			'ProductCode'		=> '',
			'Description'		=> 'Maatwerk website',
			'PriceExcl'		=> 50,
			'TaxPercentage'		=> 0.21
		)
	)
));

Voorbeeld uitvoer:
Array
(
    [Status] => success
    [Time] => 2010-01-01 10:00:00
    [IP] => 11.111.111.11
    [Count] => 1
    [Result] => Array
        (
            [Invoice] => Array
                (
                    [Debtor] => 1
                    [DebtorCode] => DB0001
                    [InvoiceCode] => F2010-0012
                    [Date] => 2010-01-31
                    [Term] => 30
                    [Discount] => 10
                    [ReferenceNumber] => AA-111
                    [CompanyName] => WeFact
                    [Initials] => ABC
                    [Address] => Nieuwstraat 1
                    [ZipCode] => 1111 AA
                    [City] => Amsterdam
                    [Country] => NL
                    [EmailAddress] => info@wefact.nl
                    [Authorisation] => yes
                    [InvoiceMethod] => 1
                    [InvoiceLines] => Array
                        (
                            [0] => Array
                                (
                                    [Identifier] => 239
                                    [Date] => 2010-12-01
                                    [Number] => 1
                                    [ProductCode] => P0001
                                    [Description] => Domeinnaam
                                    [PriceExcl] => 7.5
                                    [TaxPercentage] => 0.21
                                    [Periods] => 1
                                    [Periodic] => j
                                    [PeriodicID] => 26
                                    [StartPeriod] => 2010-12-10
                                    [EndPeriod] => 2011-12-10
                                    [Domain] => uwdomein.nl
                                )

                            [1] => Array
                                (
                                    [Identifier] => 240
                                    [Date] => 2010-12-01
                                    [Number] => 1
                                    [ProductCode] => 
                                    [Description] => Maatwerk website
                                    [PriceExcl] => 50
                                    [TaxPercentage] => 0.21
                                    [Periods] => 1
                                    [Periodic] => 
                                    [PeriodicID] => 26
                                )
                        )
                )
        )
)



addInvoiceLine

Voeg een factuurregel toe aan een bestaande factuur.
Voorbeeldbestand: /voorbeelden/addinvoiceline.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
Invoice ID Nee Int ID van de factuur
InvoiceLine Ja Array
  - Date Nee String Formaat: jjjj-mm-dd
  - Number Nee Float
  - ProductCode Nee String
  - Description Ja String
  - PriceExcl Ja Float
  - TaxPercentage Nee Float
  - Periods Nee Float
  - Periodic Nee String Zie variabelen-lijst
  - StartPeriod 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->addInvoiceLine('beveiligingscode',$invoice_id, array(
	'Date'			=> '2010-12-01',
	'Number'		=> 1,
	'ProductCode'		=> '',
	'Description'		=> 'Maatwerk website',
	'PriceExcl'		=> 50,
	'TaxPercentage'		=> 0.21
	)
);

Voorbeeld uitvoer:
De hele factuur zal teruggegeven worden (resultaat gelijk aan die van functie getInvoice).



changeInvoiceStatus

Met deze functie kan een factuur op betaald of niet betaald worden gezet.
Voorbeeldbestand: /voorbeelden/changeinvoicestatus.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
Invoice ID Nee Int ID van de factuur
Paid Ja String 'true' of 'false' voor betaald of niet betaald
PayDate Nee String Formaat: jjjj-mm-dd

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

Voorbeeld uitvoer:
stdClass Object
(
    [Status] => success
    [Time] => 2010-01-01 10:00:00
    [IP] => 11.111.111.11
)



downloadInvoice

Gebruik deze functie om een factuur in PDF formaat te downloaden.
Voorbeeldbestand: /voorbeelden/downloadinvoice.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
Invoice ID Nee Int ID van de factuur

Voorbeeld invoer:
$client->downloadInvoice('beveiligingscode',1);

Voorbeeld uitvoer:
Factuur in PDF formaat.


sendInvoiceByEmail

Gebruik deze functie om een factuur per e-mail te verzenden.
Voorbeeldbestand: /voorbeelden/sendinvoicebyemail.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
Invoice ID Nee Int ID van de factuur

Voorbeeld invoer:
$client->sendInvoiceByEmail('beveiligingscode',1);

Voorbeeld uitvoer:
stdClass Object
(
    [Status] => success
    [Time] => 2010-01-01 10:00:00
    [IP] => 11.111.111.11
)