Supported Formats

json

Params

Param name Description
client
required

Klanteninformatie

Validations:

  • Must be a Hash

client[type_id]
required

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

Validations:

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

client[name]
required

Naam

Validations:

  • Must be a String

client[vat_number]
optional

BTW nummer

Validations:

  • Must be a String

client[contact]
optional

Contactpersoon

Validations:

  • Must be a String

client[street]
required

Straatnaam en nummer

Validations:

  • Must be a String

client[postcode]
required

Postcode

Validations:

  • Must be a String

client[city]
required

Gemeente

Validations:

  • Must be a String

client[country]
optional

Land

Validations:

  • Must be a String

client[reference]
optional

Eigen klantennummer

Validations:

  • Must be a String

client[language]
optional

Taal van factuur

Validations:

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

credit_note
required

Creditnota informatie

Validations:

  • Must be a Hash

credit_note[serial_number]
required

Creditnota nummer

Validations:

  • Must be a String

credit_note[date]
required

Datum creditnota

Validations:

  • Must be a String

credit_note[reference]
optional

Factuurnummer van factuur die gecorrigeerd wordt (optioneel)

Validations:

  • Must be a String

credit_note[internal_description]
optional

Omschrijving voor intern gebruik

Validations:

  • Must be a String

credit_note[vat_percentage]
optional

Globaal BTW % van toepassing op heel de factuur. Niet door te sturen indien elke lijn een ander percentage heeft.

Validations:

  • Must be one of: 0, 6, 12, 21.

credit_note[custom_text_top]
optional

Optionele tekst

Validations:

  • Must be a String

credit_note[custom_text_bottom]
optional

Optionele tekst

Validations:

  • Must be a String

credit_note[sales_category_id]
optional

Cashaca ID van de inkomstencategorie waaraan de verkoop gekoppeld wordt. Zie ook api/v2/sales_categories/

Validations:

  • Must be a Integer

credit_note[discount_style_id]
optional

Type korting. Geen korting => 0, Vaste korting => 1, % korting => 2, Korting snelle betaling =>3

Validations:

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

credit_note[discount_amount]
optional

De toegekende korting in euro

Validations:

  • Must be a String

credit_note[discount_percentage]
optional

De toegekene korting in %

Validations:

  • Must be a String

credit_note[commercial_document_lines_attributes]
optional

Lijst van de lijnen op creditnota

Validations:

  • Must be an Array of nested elements

credit_note[commercial_document_lines_attributes][0,1,2,3,...etc]
optional

Informatie van een lijn op de creditnota

Validations:

  • Must be a Hash

credit_note[commercial_document_lines_attributes][0,1,2,3,...etc][description]
optional

Omschrijving

Validations:

  • Must be a String

credit_note[commercial_document_lines_attributes][0,1,2,3,...etc][number_skus]
optional

Aantal

Validations:

  • Must be a String

credit_note[commercial_document_lines_attributes][0,1,2,3,...etc][unit_price]
optional

Eenheidsprijs

Validations:

  • Must be a String

credit_note[commercial_document_lines_attributes][0,1,2,3,...etc][unit_id]
optional

Cashaca ID van de eenheid

Validations:

  • Must be a Integer

credit_note[commercial_document_lines_attributes][0,1,2,3,...etc][vat_percentage]
optional

BTW percentage, enkel nodig om door te sturen indien er geen globaal percentage voor de hele creditnota wordt doorgestuurd

Validations:

  • Must be one of: 0, 6, 12, 21.

credit_note[uploaded_attachments_attributes]
optional

Optionele bijlages die u aan de creditnota toevoegt

Validations:

  • Must be an Array of nested elements

credit_note[uploaded_attachments_attributes][0,1,2,3,...etc]
optional

Informatie van een bijlage van de creditnota

Validations:

  • Must be a Hash

credit_note[uploaded_attachments_attributes][0,1,2,3,...etc][description]
optional

Omschrijving

Validations:

  • Must be a String

credit_note[uploaded_attachments_attributes][0,1,2,3,...etc][file_base64]
optional

Het bestand als een base64 string in volgend formaat: data:image/jpeg;base64,(base64 encoded data)

Validations:

  • Must be a String

sale
required

Bijkomende informatie om creditnota als verkoop in te boeken

Validations:

  • Must be a Hash

sale[sales_type_id]
required

Product type ID => Goederen: 1, Diensten: 2, MOSS Diensten: 3

Validations:

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

sale[reallocation_of_vat]
optional

Wordt de BTW verlegd naar Belgische klant? Enkel te gebruiken bij verkopen aan Belgische klanten

Validations:

  • Must be one of: 0, 1.

sale[abc_sale]
optional

Driehoeksverkeer? Enkel in te vullen bij verkoop van goederen naar klant in ander EU land. => Transport van verkoper (=jij) naar klant:0, Transport van jouw leverancier direct naar klant (driehoeksverkeer): 1

Validations:

  • Must be one of: 0, 1.