Alle genoemde API-requests kunnen uitgeprobeerd in de CASH Rest API Swagger UI.
- Export cURL GET voorbeeld
- cURL GET response body
- Import cURL POST voorbeeld
- Administrations cURL Get voorbeeld
- cURL GET response body
Export cURL GET voorbeeld
Toelichting query parameters
- admin - de 4 tekens van de administratiecode, bijvoorbeeld: demo
- format - n.v.t. / gereserveerde parameter
- params - voor het meegeven van extra parameters bij de opgevraagde index
zie ook: Index Referentie.
Meerdere parameters scheid je door het pipe-teken ( | / URL encoding: %7C ):
2201|2202 - admdir - het opgeven van een submap indien de administratie niet in de root staat
- index - met de index geef je aan welke gegevens uit de database opgevraagd moeten worden, bijvoorbeeld voor relaties gebruik je index: 101
zie ook: Index Referentie.
Met onderstaande voorbeeld vraag je alle grootboekmutaties op volgorde van grootboek uit administratiecode ‘demo’ binnen boekperiode 2201 t/m 2202 (JJMM) op:
curl -X 'GET' \
'https://www.cashweb.nl/api/4.0/get/index/301T?admin=demo¶ms=2201%7C2202' \
-H 'accept: application/json' \
-H 'Cache-Control: no-cache' \
-H 'Sec-Fetch-Mode: cors' \
-H 'Authorization: MTIzNDU2X2V4YW1wbGVrZXlleGFtcGxla2V5ZXhhbXBsZWtleV85OTk5OQ=='
cURL GET response body
Toelichting response body:
- “R0301” - record 301 grootboekmutatie
- "0": - response index nummer
- "F0201": "0200"- veld 201 grootboekrekening 0200
- "F0302": "05-01-2022" veld 302 boekdatum 05-01-2022 (DD-MM-JJJJ)
Response body:
{
"R0301": {
"0": {
"F0201": "0200",
"F0301": "2201",
"F0302": "05-01-2022",
"F0303": "000005",
"F0306": "HOEKSTRA / showroominr.",
"F0307": "6000,00",
"F0310": "2201",
"F0318": "1",
"F0440": "N",
"F0901": "INK",
"F0903": "I",
"F1016": "J",
"F1341": "N",
"F3325": "000002"
},
"1": {
"F0201": "0205",
"F0301": "2201",
"F0302": "31-01-2022",
"F0303": "000001",
"F0306": "Autom afschrijving",
"F0307": "-100,00",
"F0310": "2201",
"F0318": "1",
"F0440": "N",
"F0901": "AFSCHR",
"F0903": "M",
"F1016": "J",
"F1341": "N",
"F3325": "000001"
},
"2": {
"F0201": "0305",
"F0301": "2201",
"F0302": "31-01-2022",
"F0303": "000001",
"F0306": "Autom afschrijving",
"F0307": "-55,00",
"F0310": "2201",
"F0318": "1",
"F0440": "N",
"F0901": "AFSCHR",
"F0903": "M",
"F1016": "J",
"F1341": "N",
"F3325": "000002"
}
}
}
Import cURL POST voorbeeld
Toelichting query parameters
- "admin": "demo" - de 4 tekens van de administratiecode, bijvoorbeeld: demo
- "admin": "loontest/loon" - indien de administratie in een submap staat dan start de code met de naam van de submap
- "format": 0 - gereserveerd voor specifieke imports, standaardwaarde: 0
- "content": { "cash": [ - start van de gegevens import
- "R101": [ - record 101 - relatie
- "F0101": "001101" - veld 101 relatienummer: 001101
- "F0103": "Naam 1" - veld 103 naam: Naam 1
Met het onderstaande voorbeeld worden er 2 relatie records geïmporteerd in administratiecode ‘demo’, voor relatienummer 001101 en relatienummer 01102
curl -X 'POST' \
'https://www.cashweb.nl/api/4.0/import' \
-H 'accept: application/json' \
-H 'Cache-Control: no-cache' \
-H 'Sec-Fetch-Mode: cors' \
-H 'Authorization: MTIzNDU2X2V4YW1wbGVrZXlleGFtcGxla2V5ZXhhbXBsZWtleV85OTk5OQ==' \
-H 'Content-Type: application/json' \
-d '{
"admin": "demo",
"format": 0,
"content": {
"cash": [
{
"R101": [
{
"F0101": "001101",
"F0103": "Naam 1"
}
]
},
{
"R101": [
{
"F0101": "001102",
"F0103": "Naam 2"
}
]
}
]
}
}'
Administrations cURL Get voorbeeld
Met het onderstaande voorbeeld wordt een overzicht van de via API beschikbare administraties opgevraagd.
curl -X 'GET' \
'https://www.cashweb.nl/api/4.0/administrations' \
-H 'accept: application/json' \
-H 'Cache-Control: no-cache' \
-H 'Sec-Fetch-Mode: cors' \
-H 'Authorization: MTIzNDU2X2V4YW1wbGVrZXlleGFtcGxla2V5ZXhhbXBsZWtleV85OTk5OQ=='
cURL GET response body
Toelichting response body:
- "Dir": { "Name": "123456" - relatienummer van betreffende CASHWeb relatie: 123456
- "Adms": { - begin administratie overzicht
- "Code": "demo" - de 4 tekens van de administratiecode, bijvoorbeeld: demo
- "Code": "loontest/loon" indien de administratie in een submap staat dan start de code met de naam van de submap
- "Name": "Demo CASH" - de bedrijfsnaam van de administratie
- "ReadOnly": "N" - de read-only status van de database
- "dirname": "loontest/" - de submap “loontest”, alleen van toepassing indien de administratie niet in de root staat
- "basename": "loon" - de 4 tekens van de administratiecode, bijvoorbeeld: loon
Response body:
{
"Dir": {
"Name": "123456",
"Adms": {
"Adm": {
"0": {
"Code": "demo",
"Name": "Demo CASH",
"Status": "0",
"ReadOnly": "N",
"dirname": {},
"displaydirname": {},
"basename": "demo"
},
"1": {
"Code": "demv",
"Name": "Demo CASH",
"Status": "0",
"ReadOnly": "N",
"dirname": {},
"displaydirname": {},
"basename": "demv"
},
"2": {
"Code": "loontest/loon",
"Name": "Loonportal",
"Status": "0",
"ReadOnly": "N",
"dirname": "loontest/",
"displaydirname": "loontest / ",
"basename": "loon"
}
}
},
"Relnm": "Example bv"
}
}