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



Debiteuren

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



Let op: vanaf WeFact Hosting versie 3.2 is het veld 'AccountIban' samengevoegd met 'AccountNumber' en is het veld 'AccountSwift' hernoemd naar 'AccountBIC'.



getDebtorID

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


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
DebtorCode Ja String Het debiteurnummer van een debiteur

Voorbeeld invoer:
$client->getDebtorID('beveiligingscode','DB0001');

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



getDebtor

Middels deze functie kunt u meer informatie over een debiteur ophalen. Het is vooralsnog nog niet mogelijk via de API een lijst met facturen, offertes en abonnementen van een debiteur op te halen.
Voorbeeldbestand: /voorbeelden/getdebtor.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
DebtorID Ja Int De unieke ID van een debiteur, op te halen via de listDebtors functie of getDebtorID functie

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

Voorbeeld uitvoer:
Array
(
    [Status] => success
    [Time] => 2010-01-01 10:00:00
    [IP] => 11.111.111.11
    [Count] => 1
    [Result] => Array
        (
            [Debtor] => Array
                (
                   [Identifier] => 1
                   [DebtorCode] => DB0001
		   [Status] => actief
                   [CompanyName] => Bedrijfsnaam
                   [CompanyNumber] => 123456789
		   [TaxNumber] => NL123456789
                   [LegalForm] => Besloten Vennootschap
                   [Sex] => m
		   [Initials] => ABC
                   [SurName] => de Vries
                   [Address] => Nieuwstraat 1
		   [ZipCode] => 1111 AA
                   [City] => Amsterdam
		   [Country] =>NL
		   [CountryLong] => Nederland
                   [EmailAddress] => info@wefact.nl
                   [SecondEmailAddress] => info@wefact.nl
                   [PhoneNumber] => 010-1111111
                   [FaxNumber] => 010-2222222
                   [Comment] =>
                   [InvoiceMethod] => Per email
                   [InvoiceInitials] => ABC
		   [InvoiceSurName] => de Vries
                   [InvoiceAddress] => Nieuwstraat 1
		   [InvoiceZipCode] => 1111 AA
                   [InvoiceCity] => Amsterdam
                   [InvoiceCountry] =>NL
                   [InvoiceCountryLong] =>Nederland
                   [InvoiceEmailAddress] => info@wefact.nl
     		   [InvoiceAuthorisation] => nee
                   [AccountNumber] =>
                   [AccountBIC] =>
                   [AccountName] =>
                   [AccountBank] =>
                   [AccountCity] =>
                   [Username] =>
                )
        )
)



listDebtors

Middels deze functie kunt u een lijst met debiteuren ophalen.
Voorbeeldbestand: /voorbeelden/listdebtors.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

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

    [Result] => Array
        (
            [Debtors] => Array
                (
                    [0] => Array
                        (
                            [Identifier] => 1
                            [DebtorCode] => DB0001
                            [CompanyName] => 
                            [Sex] => m
                            [Initials] => ABC
                            [SurName] => de Vries
                            [EmailAddress] => info@wefact.nl
                        )
                )
        )
)



addDebtor

Middels deze functie is het mogelijk een debiteur toe te voegen.
Voorbeeldbestand: /voorbeelden/adddebtor.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
DebtorCode Nee String Indien leeg, wordt deze automatisch bepaald
CompanyName Nee String Bedrijfsnaam of achternaam is verplicht
CompanyNumber Nee String KvK-nummer
TaxNumber Nee String BTW-nummer
LegalForm Nee String Zie variabelen-lijst
Sex Nee String 'm' of 'f', standaard waarde is 'm'
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
SecondEmailAddress Nee String
PhoneNumber Nee String
FaxNumber Nee String
Comment Nee String
InvoiceMethod Nee Int Zie variabelen-lijst, standaard is per e-mail
InvoiceInitials Nee String
InvoiceSurName Nee String
InvoiceAddress Nee String
InvoiceZipCode Nee String
InvoiceCity Nee String
InvoiceCountry Nee String Zie variabelen-lijst
InvoiceEmailAddress Nee String
InvoiceAuthorisation Nee String 'yes' of 'no', standaard waarde is 'no'
AccountNumber Nee String Bankrekeningnummer
AccountBIC Nee String
AccountName Nee String
AccountBank Nee String
AccountCity Nee String
Username Nee String
Password Nee String

Voorbeeld invoer:
$client->addDebtor('beveiligingscode',array(
	'DebtorCode'			=> 'DB0001',
	'CompanyName'			=> 'WeFact',
	'CompanyNumber'			=> '123456789',
	'TaxNumber'			=> 'NL123456789',
	'LegalForm'			=> 'BV',
	'Sex'				=> 'm',
	'Initials'			=> 'ABC',
	'SurName'			=> 'de Vries',
	'Address'			=> 'Nieuwstraat 1',
	'ZipCode'			=> '1111 AA',
	'City'				=> 'Amsterdam',
	'Country'			=> 'NL',
	'EmailAddress'			=> 'info@wefact.nl',
	'SecondEmailAddress'		=> '',
	'PhoneNumber'			=> '010-1111111',
	'FaxNumber'			=> '010-2222222',
	'Comment'			=> '',
	'InvoiceMethod'			=> 0,
	'InvoiceInitials'		=> 'ABC',
	'InvoiceSurName'		=> 'de Vries',
	'InvoiceAddress'		=> 'Nieuwstraat 1',
	'InvoiceZipCode'		=> '1111 AA',
	'InvoiceCity'			=> 'Amsterdam',
	'InvoiceCountry'		=> 'NL',
	'InvoiceEmailAddress'		=> 'info@wefact.nl',
	'InvoiceAuthorisation'		=> 'yes',
	'AccountNumber'			=> '123456789',
	'AccountBIC'			=> '123456789',
	'AccountName'			=> 'ABC de Vries',
	'AccountBank'			=> 'Regionale bank',
	'AccountCity'			=> 'Amsterdam'
));

Voorbeeld uitvoer:
Array
(
    [Status] => success
    [Time] => 2010-01-01 10:00:00
    [IP] => 11.111.111.11
    [Count] => 1
    [Result] => Array
        (
            [Debtor] => Array
                (
		   [Identifier] => 1
                   [DebtorCode] => DB0001
                   [CompanyName] => WeFact
                   [CompanyNumber] => 123456789
                   [TaxNumber] => NL123456789
                   [LegalForm] => BV
                   [Sex] => m
                   [Initials] => ABC
                   [SurName] => de Vries
                   [Address] => Nieuwstraat 1
                   [ZipCode] => 1111 AA
                   [City] => Amsterdam
                   [Country] => NL
                   [EmailAddress] => info@wefact.nl
                   [SecondEmailAddress] => 
                   [PhoneNumber] => 010-1111111
                   [FaxNumber] => 010-2222222
                   [Comment] => 
                   [InvoiceMethod] => 0
                   [InvoiceInitials] => ABC
                   [InvoiceSurName] => de Vries
                   [InvoiceAddress] => Nieuwstraat 1
                   [InvoiceZipCode] => 1111 AA
                   [InvoiceCity] => Amsterdam
                   [InvoiceCountry] => NL
                   [InvoiceEmailAddress] => info@wefact.nl
                   [InvoiceAuthorisation] => yes
                   [AccountNumber] => 123456789
                   [AccountBIC] => 123456789
                   [AccountName] => ABC de Vries
                   [AccountBank] => Regionale bank
                   [AccountCity] => Amsterdam
                )
        )
)



editDebtor

Met behulp van deze functie is het mogelijk om een debiteur te bewerken. Alleen de parameters die ingevoerd worden zullen gewijzigd worden.
Voorbeeldbestand: /voorbeelden/editdebtor.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
DebtorCode Nee String Indien leeg, wordt deze automatisch bepaald
CompanyName Nee String Bedrijfsnaam of achternaam is verplicht
CompanyNumber Nee String KvK-nummer
TaxNumber Nee String BTW-nummer
LegalForm Nee String Zie variabelen-lijst
Sex Nee String 'm' of 'f', standaard waarde is 'm'
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
SecondEmailAddress Nee String
PhoneNumber Nee String
FaxNumber Nee String
Comment Nee String
InvoiceMethod Nee Int Zie variabelen-lijst, standaard is per e-mail
InvoiceInitials Nee String
InvoiceSurName Nee String
InvoiceAddress Nee String
InvoiceZipCode Nee String
InvoiceCity Nee String
InvoiceCountry Nee String Zie variabelen-lijst
InvoiceEmailAddress Nee String
InvoiceAuthorisation Nee String 'yes' of 'no', standaard waarde is 'no'
AccountNumber Nee String Bankrekeningnummer
AccountBIC Nee String
AccountName Nee String
AccountBank Nee String
AccountCity Nee String
Username Nee String
Password Nee String

Voorbeeld invoer:
$client->editDebtor('beveiligingscode', 1, array(
	'DebtorCode'			=> 'DB0001',
	'CompanyName'			=> 'WeFact',
	'CompanyNumber'			=> '123456789',
	'TaxNumber'			=> 'NL123456789',
	'LegalForm'			=> 'BV',
	'Sex'				=> 'm',
	'Initials'			=> 'ABC',
	'SurName'			=> 'de Vries',
	'Address'			=> 'Nieuwstraat 1',
	'ZipCode'			=> '1111 AA',
	'City'				=> 'Amsterdam',
	'Country'			=> 'NL',
	'EmailAddress'			=> 'info@wefact.nl',
	'SecondEmailAddress'		=> '',
	'PhoneNumber'			=> '010-1111111',
	'FaxNumber'			=> '010-2222222',
	'Comment'			=> '',
	'InvoiceMethod'			=> 0,
	'InvoiceInitials'		=> 'ABC',
	'InvoiceSurName'		=> 'de Vries',
	'InvoiceAddress'		=> 'Nieuwstraat 1',
	'InvoiceZipCode'		=> '1111 AA',
	'InvoiceCity'			=> 'Amsterdam',
	'InvoiceCountry'		=> 'NL',
	'InvoiceEmailAddress'		=> 'info@wefact.nl',
	'InvoiceAuthorisation'		=> 'yes',
	'AccountNumber'			=> '123456789',
	'AccountBIC'			=> '123456789',
	'AccountName'			=> 'ABC de Vries',
	'AccountBank'			=> 'Regionale bank',
	'AccountCity'			=> 'Amsterdam'
));

Voorbeeld uitvoer:
Array
(
    [Status] => success
    [Time] => 2010-01-01 10:00:00
    [IP] => 11.111.111.11
    [Count] => 1
    [Result] => Array
        (
            [Debtor] => Array
                (
			[DebtorCode] => DB0001
			[CompanyName] => WeFact
			[CompanyNumber] => 123456789
			[TaxNumber] => NL123456789
			[LegalForm] =>BV
			[Sex] => m
			[Initials] => ABC
			[SurName] => de Vries
			[Address] => Nieuwstraat 1
			[ZipCode] => 1111 AA
			[City] => Amsterdam
			[Country] => NL
			[EmailAddress] => info@wefact.nl
			[SecondEmailAddress] =>
			[PhoneNumber] => 010-1111111
			[FaxNumber] => 010-2222222
			[Comment] =>
			[InvoiceMethod] => 0
			[InvoiceInitials] => ABC
			[InvoiceSurName] => de Vries
			[InvoiceAddress] => Nieuwstraat 1
			[InvoiceZipCode] => 1111 AA
			[InvoiceCity] => Amsterdam
			[InvoiceCountry] => NL
			[InvoiceEmailAddress] => info@wefact.nl
			[InvoiceAuthorisation] =>yes
			[AccountNumber] => 123456789
			[AccountBIC] => 123456789
			[AccountName] => ABC de Vries
			[AccountBank] => Regionale bank
			[AccountCity] => Amsterdam
                )
	)
)



deleteDebtor

Middels deze functie kunt u een debiteur verwijderen uit WeFact. U kunt hierbij aangeven of eventuele actieve abonnementen ook direct gestopt moeten worden.
Let op: Domeinnamen en hostingpakketten worden niet verwijderd via dit commando.
Voorbeeldbestand: /voorbeelden/deletedebtor.php


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
DebtorID Ja Int De unieke ID van een debiteur, op te halen via de listDebtors functie of getDebtorID functie
RemoveSubscription Nee Boolean Standaard: false
Hiermee kan aangegeven worden of actieve abonnementen automatisch verwijderd moeten worden.

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

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



checkLoginDebtor

Met deze functie kunt u controleren of gebruikersnaam en wachtwoord correct zijn om in te loggen op uw klantenpaneel.


Invoerparameters:
Veldnaam Verplicht Waarde Omschrijving
Username Ja String Gebruikersnaam tot klantenpaneel
Password Ja String Wachtwoord tot klantenpaneel

Voorbeeld invoer:
$client->checkLoginDebtor('beveiligingscode', 'username', 'password');

Voorbeeld uitvoer:
Array
(
    [Status] => success
    [Time] => 2011-01-01 10:00:00
    [IP] => 11.111.111.11
    [Count] => 1
    [Result] => Array
        (
            [Debtor] => Array
                (
                    [Identifier] => 1
                    [DebtorCode] => DB0001
                )
        )
)