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



Offertes

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



getPriceQuoteID

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


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
PriceQuoteCode Ja String Het offertenummer van een offerte

Voorbeeld invoer:
$client->getPriceQuoteID('beveiligingscode','OF0001');

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



getPriceQuote

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


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
PriceQuote ID Ja Int De unieke ID van een offerte, op te halen via de listPriceQuote functie of getPriceQuoteID functie

Voorbeeld invoer:
$client->getPriceQuote('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
        (
            [PriceQuote] => stdClass Object
                (
              	   [Identifier] => 1
                   [Debtor] => 1
                   [DebtorCode] => DB0001
                   [PriceQuoteCode] => F0001
        	   [Date] => 2011-01-01
                   [Description] =>
                   [Term] => 14
                   [Discount] => 0
                   [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
                   [PriceQuoteMethod] => 0
                   [SentDate] => 0000-00-00 00:00:00
                   [Sent] => 0
                   [Status] => 4
              	   [AmountExcl] => 100.00
              	   [AmountIncl] => 119.00
                   [PriceQuoteLines] => Array
                        (
                            [0] => stdClass Object
                                (
                                  [Debtor] => 1
           			  [PriceQuoteCode] => F0001
                    		  [Date] =>2011-01-01
                                  [Number] => 1
        			  [ProductCode] => P0001
                                  [Description] =>Omschrijving
               			  [PriceExcl] => 100
                                  [TaxPercentage] => 0.21
                                  [Periods] => 1
                                  [Periodic] =>
                                  [PeriodicID] => 0
                                  [StartPeriod] =>
                                  [EndPeriod] =>
    			       )
                        )
                )
 	)
)



listPriceQuotes

Middels deze functie kunt u een lijst met offertes ophalen.
Voorbeeldbestand: /voorbeelden/listpricequotes.php


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

Voorbeeld invoer:
$client->listPriceQuotes('beveiligingscode',array(
'Sort'		=> 'PriceQuoteCode',
'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] => PriceQuoteCode
            [Order] => ASC
            [Search] => wefact
        )

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



addPriceQuote

Voeg een offerte toe in WeFact. Indien de offerte de status concept krijgt, dient er geen offertenummer meegegeven te worden.
Voorbeeldbestand: /voorbeelden/addpricequote.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
PriceQuoteCode 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 Geldigheidstermijn
Discount Nee String Korting in percentage over totale factuurbedrag
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
PriceQuoteMethod Nee Int Zie variabelen-lijst, standaard is per e-mail
Status Ja Int Zie variabelen-lijst
Description Nee Text
PriceQuoteLines 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

Voorbeeld invoer:
$client->addPriceQuote('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',
	'PriceQuoteMethod'	=> 1,
	'Authorisation'		=> 'yes',
	'PriceQuoteLines'	=> array(
		array(
			'Number'		=> 1,
			'ProductCode'		=> 'P0001'
		),
		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
        (
            [PriceQuote] => Array
                (
                    [Debtor] => 1
                    [DebtorCode] => DB0001
                    [PriceQuoteCode] => 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
                    [PriceQuoteMethod] => 1
                    [PriceQuoteLines] => 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
                                )

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



changePriceQuoteStatus

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


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
PriceQuote ID Nee Int ID van de offerte
Accept Ja String 'true' of 'false' voor accepteren of weigeren.
MakeInvoice Nee String 'true' of 'false' voor het aanmaken van een factuur voor de offerte.

Voorbeeld invoer:
$client->changePriceQuoteStatus('beveiligingscode', 'true', 'true');

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



downloadPriceQuote

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


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
PriceQuote ID Nee Int ID van de offerte

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

Voorbeeld uitvoer:
Offerte in PDF formaat.


sendPriceQuoteByEmail

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


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
PriceQuote ID Nee Int ID van de offerte

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

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