Recordindeling CASH Leden
Uitleg over de recordindelingen en API-velden voor de ledenmodule
Wil je ledengegevens importeren of een slimme koppeling bouwen via onze API (versie drie of vier)? Dan is het belangrijk om te weten hoe de data in het systeem is opgebouwd. In dit artikel leggen we de recordindelingen uit die specifiek relevant zijn voor de module CASH Leden. Hiermee weet je exact welke velden en formaten er vereist zijn.
1. De opbouw en het ophalen van records
Wanneer je met de API communiceert, maak je gebruik van specifieke codes om de juiste gegevens op te halen of weg te schrijven.
- Records ophalen: Een record vraag je op door het recordnummer te gebruiken. Als je een record ophaalt via de API, start het nummer altijd met de letter R.
- Zoeken via een index: Wil je specifieker zoeken in de database? Gebruik dan de hoofdletter I (Index) gevolgd door het indexnummer.
- Velden herkennen: Een los veldnummer binnen een record start altijd met de letter F.
2. Verplichte velden en veldsoorten
In de technische documentatie van het pakket heeft elk veld een specifiek type en een maximale lengte. Zie je een sterretje (*) achter een veld staan? Dan is dit een verplicht gegeven dat altijd ingevuld moet zijn. Hieronder vind je de betekenis van de letters die de veldsoorten aangeven:
- S (Sleutelveld): Een veld waarin je uitsluitend hoofdletters mag gebruiken.
- L (Stringveld): Een tekstveld waarin zowel hoofdletters als kleine letters zijn toegestaan.
- N (Numeriek): Een numeriek getal, automatisch aangevuld met voorloopnullen.
- I (Rekenwaarde): Een bedrag of rekenwaarde met decimalen. Deze mag een minteken bevatten (voor of na de waarde).
- D (Datum): Een datum in de volgorde jaar-maand-dag (JJMMDD).
3. De recordindelingen voor de ledenmodule
Hieronder vind je de exacte overzichten van de belangrijkste records voor de ledenadministratie, waaronder de algemene relatiegegevens, de incassomachtigingen en de factuurregels. Klik op een onderwerp om de bijbehorende API-velden uit te klappen!
1. Relatie (Record 0101)
Voor het importeren of ophalen van relatiegegevens, zoals naam, adres en financiële instellingen.
| Code | Naam | Type |
|---|---|---|
| 0101 | Relatienr | S6 * |
| 0102 | Zoeknaam | S10 |
| 0103 | Naam | L35 * |
| 0104 | Tav | L35 |
| 0105 | Adres | L35 |
| 0106 | Faxnummer | S35 |
| 0107 | Pc+plaats | S35 * |
| 0108 | Telefoonnr | S35 |
| 0109 | Invoerdatum | D6 |
| 0110 | Bank/IBAN | S34 |
| 0111 | Betaaldagen | I3 |
| 0112 | Eigenschap | S12 |
| 0113 | Selectie 1 | I6 |
| 0114 | Selectie 2 | I6 |
| 0115 | Opmerking | L35 |
| 0116 | OB-nummer | S16 |
| 0117 | Aant kopie | I2 |
| 0118 | Kortings% | I5,2 |
| 0120 | E-mailadres | L72 |
| 0121 | Krbep | S1 |
| 0122 | OB verkoop | S1 |
| 0123 | Postadres | L35 |
| 0124 | PC+plaats | S35 |
| 0125 | Landsnaam | S35 |
| 0126 | Kred limiet | I10,2 |
| 0127 | Aanhef | L35 |
| 0128 | Betaaltekst | L35 |
| 0129 | Code plaats | S1 |
| 0130 | Code land | S2 |
| 0131 | Opmerking 2 | L35 |
| 0132 | Opmerking 3 | L35 |
| 0133 | Opmerking 4 | L35 |
| 0134 | Opmerking 5 | L35 |
| 0135 | Opmerking 6 | L35 |
| 0136 | Opmerking 7 | L35 |
| 0137 | Opmerking 8 | L35 |
| 0138 | Zoekveld 1 | S12 |
| 0139 | Zoekveld 2 | S12 |
| 0141 | Actiedatum | D6 |
| 0142 | Pers.code | S6 |
| 0143 | Welke actie | L12 |
| 0151 | Trefwoord | S10 |
| 0152 | Trefwoord 2 | S10 |
| 0153 | Trefwoord 3 | S10 |
| 0154 | Trefwoord 4 | S10 |
| 0155 | Trefwoord 5 | S10 |
| 0156 | Trefwoord 6 | S10 |
| 0157 | Trefwoord 7 | S10 |
| 0158 | Trefwoord 8 | S10 |
| 0159 | Trefwoord 9 | S10 |
| 0160 | Trefwoord 10 | S10 |
| 0171 | Bet kort dg | I3 |
| 0172 | krbep % | I4,1 |
| 0173 | Bet kort % | I4,1 |
| 0174 | Gbrek verk. | S6 |
| 0329 | Bank rekeningnr | S34 |
| 0350 | BIC-code | S11 |
| 0356 | Bank naam | S35 |
| 0357 | Bank adres | S35 |
| 0358 | Bank woonplaats | S35 |
| 0438 | Postcode | S7 |
| 0441 | XML Form | S6 |
| 0450 | Automat. aanhef | L35 |
| 0671 | Website | L35 |
| 0715 | Factuur srt | S1 |
| 0720 | Zoeknamen | S63 |
| 0730 | Naam-2 | L35 |
| 0732 | Opmerking 9 | L35 |
| 0733 | Opmerking 10 | L35 |
| 0797 | Gbrek ink. | S6 |
| 0906 | OB inkoop | S1 |
| 0947 | Bank/IBAN | S34 |
| 0971 | Landcode ISO | S2 |
| 0981 | Taalcode | S3 |
| 0983 | Valutacode | S3 |
| 1197 | Mobielnr | N10 |
| 1267 | G-bedrag | I5,2 |
| 1321 | land ISO | S2 |
2. Mandaatgegevens incasso (Record 0109)
Voor het beheren van de instellingen rondom de automatische SEPA-incasso's voor je leden.
| Code | Naam | Type |
|---|---|---|
| 0101 | Relatienr | S6 |
| 1841 | Machtiging | N2 |
| 1842 | Kenmerk | L35 |
| 0110 | Bank/IBAN | S35 |
| 1843 | Datum van ondertekening | D |
| 1844 | Soort incasso | S1 |
| 1845 | Frequentie | S1 |
| 1846 | Gewijzigd deb | S1 |
| 1847 | Oude kenmerk | L35 |
| 1848 | Oude IBAN | S35 |
| 1850 | Type incasso | N1 |
| 1838 | Bedrijfsnaam | L70 |
| 1840 | Incassant ID | S19 |
| 1852 | Gewijzigd cred | S1 |
| 1854 | Vorige incassodatum | D |
| 1855 | Actief | S1 |
| 0350 | BIC-code | S11 |
Voor de inhoud en de regels van de facturatie (zoals het factureren van de contributie van een lid).
| Code | Naam | Type |
|---|---|---|
| 0101 | Relatienr | N6 * |
| 0425 | Orderreferentie | S6 * |
| 1490 | Volgnummer | N3 * |
| 0451 | Artikelcode | S13 |
| 0452 | Omschrijving | L40 |
| 0421 | Aantal (2 decimalen) | I9,2 * |
| 0455 | Prijs | I9,2 * |
| 0442 | Code OB-tarief | S1 |
| 0443 | Code soort prijs | S1 |
| 0118 | Korting % (2 decimalen) | I5,2 |
| 0201 | Grootboekrekening | S6 |
| 0911 | Kostenplaats | S3 |
| 0422 | Periodecode | S1 |
| 1919 | Aantal maanden | N2 |
| 0423 | Vervaldatum | D6 |
| 0426 | Einddatum | D6 |
| 0427 | Datum | D6 |
| 0436 | Vrije veld (vervallen) | L60 |
| 0440 | ABC-levering | S1 |
| 1341 | B2B-diensten | S1 |
Tip van de Helpdesk: Test je API-koppeling altijd eerst goed uit met een klein aantal records. Loop je vast op een specifieke foutmelding of zoek je meer uitleg over de velden? Neem dan gerust contact op met de helpdesk via ons telefoonnummer of stuur een e-mail naar helpdesk@cash.nl. Wij helpen je graag op weg!