Supported Formats

json

GET /api/clients.json?token=API_TOKEN
Een lijst van alle klanten opvragen (100 klanten per query)

Supported Formats

json

Params

Param name Description
page
optional

Pagina indien er meer dan 100 klanten zijn

Validations:

  • Must be a number.


GET /api/clients.json?token=API_TOKEN
Zoek in alle klanten (100 klanten per query)


GET /api/clients/:id.json?token=API_TOKEN
Informatie van specifieke klant opvragen

Supported Formats

json

Params

Param name Description
id
required

De Cashaca ID van de klant

Validations:

  • Must be a number.


POST /api/clients.json?token=API_TOKEN
Nieuwe klant aanmaken

Supported Formats

json

Params

Param name Description
client
required

Klanteninformation

Validations:

  • Must be a Hash

client[type_id]
required

Type klant ID => Belgische particulier (of instelling zonder BTW nummer): 0, Belgisch bedrijf: 1, Particulier binnen EU (of instelling zonder BTW nummer): 4, Bedrijf binnen EU:2, Klant buiten EU: 3

Validations:

  • Must be one of: 0, 1, 2, 3.

client[name]
optional , nil allowed

Naam

Validations:

  • Must be a String

client[btw_number]
optional , nil allowed

BTW nummer

Validations:

  • Must be a String

client[street]
optional , nil allowed

Straatnaam en nummer

Validations:

  • Must be a String

client[postcode]
optional , nil allowed

Postcode

Validations:

  • Must be a String

client[city]
optional , nil allowed

Gemeente

Validations:

  • Must be a String

client[email]
optional , nil allowed

E-mailadres

Validations:

  • Must be a String

client[country]
optional , nil allowed

Land

Validations:

  • Must be a String

client[contact]
optional , nil allowed

Contactpersoon

Validations:

  • Must be a String

client[tel]
optional , nil allowed

Telefoonnummer

Validations:

  • Must be a String

client[reference]
optional , nil allowed

Eigen referentie / klantennummer

Validations:

  • Must be a String

client[website]
optional , nil allowed

Website

Validations:

  • Must be a String

client[language]
optional , nil allowed

Taal van factuur

Validations:

  • Must be one of: nl, fr, en.


PUT /api/clients/:id.json?token=API_TOKEN
Klanteninformatie aanpassen

Supported Formats

json

Params

Param name Description
client
required

Klanteninformation

Validations:

  • Must be a Hash

client[type_id]
optional

Type klant ID => Belgische particulier (of instelling zonder BTW nummer): 0, Belgisch bedrijf: 1, Particulier binnen EU (of instelling zonder BTW nummer): 4, Bedrijf binnen EU:2, Klant buiten EU: 3

Validations:

  • Must be one of: 0, 1, 2, 3.

client[name]
optional , nil allowed

Naam

Validations:

  • Must be a String

client[btw_number]
optional , nil allowed

BTW nummer

Validations:

  • Must be a String

client[street]
optional , nil allowed

Straatnaam en nummer

Validations:

  • Must be a String

client[postcode]
optional , nil allowed

Postcode

Validations:

  • Must be a String

client[city]
optional , nil allowed

Gemeente

Validations:

  • Must be a String

client[email]
optional , nil allowed

E-mailadres

Validations:

  • Must be a String

client[country]
optional , nil allowed

Land

Validations:

  • Must be a String

client[contact]
optional , nil allowed

Contactpersoon

Validations:

  • Must be a String

client[tel]
optional , nil allowed

Telefoonnummer

Validations:

  • Must be a String

client[reference]
optional , nil allowed

Eigen referentie / klantennummer

Validations:

  • Must be a String

client[website]
optional , nil allowed

Website

Validations:

  • Must be a String

client[language]
optional , nil allowed

Taal van factuur

Validations:

  • Must be one of: nl, fr, en.


GET /api/clients/valid_be_vat_number.json?token=API_TOKEN
Ga na of het doorgestuurde BTW nummer een geldig Belgisch nummer is

Supported Formats

json

Params

Param name Description
vat_number
optional

Het BTW nummer

Validations:

  • Must be a String