TaxHelper Business API
Denne side introducerer TaxHelper Business API, som gør det muligt for udviklere at integrere momsanalyse direkte i egne løsninger. I din udviklerkonto finder du mere detaljeret dokumentation og kan foretage API-kald baseret på dine egne regnskabsdata – hvis du bruger e-conomic. Bemærk, at TaxHelper Business API ikke er begrænset til e-conomic; du kan anvende API'et med andre systemer, så længe dine data følger den dokumentation, der er angivet nedenfor.
Introduktion
Alle endpoints returnerer et standard JSON-object, eksempelvis:
{
"note": "Køb af kontorartikler, print, tryksager og elektronik har næsten altid moms på",
"rating": 0.95,
"vat_code": "DK-VAT"
}
Parameter |
Type |
Obligatorisk |
Beskrivelse |
note | String? | true | En forklaring på analysens konklusion. |
rating | number? | true | Mellem 0 og 1. Jo højere rating jo mere sikker er konklusionen. |
vat_code | String? | true | Momskode. Se forklaring på momskoder nedenfor. |
Momskode |
Forklaring |
DK-VAT | Dansk moms. |
EU-VAT-GOODS | EU moms for varer. |
EU-VAT-SERVICES | EU moms for tjenesteydelser. |
OTHER-VAT-GOODS | Moms på varer fra tredjelande. |
OTHER-VAT-SERVICES | Moms på tjenesteydelser fra tredjelande. |
NONE | Der er ikke være moms på posteringen. |
null | Analysen kunne ikke identificere en momskode. |
Vær opmærksom på at 'NONE' betyder, at analysen indikerer at der ikke bør være en momskode specificeret på posteringen. Derimod betyder 'null', at analysen ikke kunne foretage en konklusion.
Header
Opret Bearer Token i din TaxHelper Business konto, og tilføj derefter disse headers til dine POST requests.
Header |
Value |
Description |
Authorization | Bearer XXXXXXX | Erstat XXXXXXX med Bearer Token fra din konto. |
Content-Type | application/json | Altid inkludèr denne. |
Momsanalyse af postering (/vat/entry)
Brug dette endpoint til at analysere momsen på en postering, der IKKE har et bilag vedhæftet (f.eks. faktura, kvittering).
POST /api/prediction/vat/entry
Parameter |
Type |
Obligatorisk |
Beskrivelse |
text | String | true | Beskrivelse af posteringen. |
account_name | String? | false | Kontonavn på den primære konto for posteringen. |
contra_account_name | String? | false | Kontonavn på den modkontoen for posteringen. |
contra_account_is_primary | boolean | true | Skal være 'true', hvis modkontoen skal anses som den primære konto i analysen. |
has_yellow_plate_cars | boolean | true | Skal være 'true', hvis virksomheden har gulplade-biler. Sæt til 'false' som default. |
is_restaurant | boolean | true | kal være 'true', hvis virksomheden driver en restaurant. Sæt til 'false' som default. |
Eksempel på Body:
{
"text": "Køb fra elgiganten",
"account_name": "3617 - Mindre anskaffelser",
"contra_account_name": "5820 - Danske Bank",
"contra_account_is_primary": false,
"has_yellow_plate_cars": false,
"is_restaurant": false,
}
cURL vil se således ud, hvor du erstatter Bearer Token med din egen token:
curl -X POST https://business.taxhelper.dk/api/prediction/vat/entry -H 'Authorization: Bearer XXXXXXX' -H 'Content-Type: application/json' -d '{"text":"Køb fra elgiganten","account_name":"3617 - Mindre anskaffelser","contra_account_name":"5820 - Danske Bank","contra_account_is_primary":false,"has_yellow_plate_cars":false,"is_restaurant":false,"file":null}'
Returneret fra endpoint:
{
"note": "Køb af kontorartikler, print, tryksager og elektronik har næsten altid moms på",
"rating": 0.95,
"vat_code": "DK-VAT"
}
HTTP koder
Kode |
Beskrivelse |
200 | JSON returneres |
400 | Data er ugyldigt. POST request body skal indeholde 'text', 'contra_account_is_primary', 'has_yellow_plate_cars' og 'is_restaurant'. |
400 | Data er ugyldigt. Request body mangler. |
401 | Mangler Bearer token i header. {Authorization: 'Bearer XXXXXXXX'}. |
403 | Token matcher ikke din developer kontos token. |
405 | Request method ikke tilladt. Skal være POST. |
Momsanalyse af postering og bilag (/vat)
Brug dette endpoint til at analysere momsen når du både har posteringsdata og vedhæftet bilag/dokument. Dette endpoint giver det mest komplette resultat, da vi både analyserer posteringen og dens vedhæftede bilag.
POST /api/prediction/vat
Parameter |
Type |
Obligatorisk |
Beskrivelse |
text | String | true | Beskrivelse af posteringen. |
account_name | String? | false | Kontonavn på den primære konto for posteringen. |
contra_account_name | String? | false | Kontonavn på den modkontoen for posteringen. |
contra_account_is_primary | boolean | true | Skal være 'true', hvis modkontoen skal anses som den primære konto i analysen. |
has_yellow_plate_cars | boolean | true | Skal være 'true', hvis virksomheden har gulplade-biler. Sæt til 'false' som default. |
is_restaurant | boolean | true | kal være 'true', hvis virksomheden driver en restaurant. Sæt til 'false' som default. |
file | String | true | Filen repræsenteret i et base64 tekstformat. |
Eksempel på Body:
{
"text": "Køb fra elgiganten",
"account_name": "3617 - Mindre anskaffelser",
"contra_account_name": "5820 - Danske Bank",
"contra_account_is_primary": false,
"has_yellow_plate_cars": false,
"is_restaurant": false,
"file": "JVBERi0yLjAKJeTjz9IKNiAwIG9iag..."
}
cURL vil se således ud, hvor du erstatter Bearer Token med din egen token:
curl -X POST https://business.taxhelper.dk/api/prediction/vat/entry -H 'Authorization: Bearer XXXXXXX' -H 'Content-Type: application/json' -d '{"text":"Køb fra elgiganten","account_name":"3617 - Mindre anskaffelser","contra_account_name":"5820 - Danske Bank","contra_account_is_primary":false,"has_yellow_plate_cars":false,"is_restaurant":false,"file": "JVBERi0yLjAKJeTjz9IKNiAwIG9iag..."}'
Returneret fra endpoint:
{
"note": "Køb af kontorartikler, print, tryksager og elektronik har næsten altid moms på",
"rating": 0.95,
"vat_code": "DK-VAT"
}
HTTP koder
Kode |
Beskrivelse |
200 | JSON returneres |
400 | Data er ugyldigt. POST request body skal indeholde 'text', 'contra_account_is_primary', 'has_yellow_plate_cars', 'is_restaurant' og 'file'. |
400 | Data er ugyldigt. Request body mangler. |
401 | Mangler Bearer token i header. {Authorization: 'Bearer XXXXXXXX'}. |
403 | Token matcher ikke din developer kontos token. |
405 | Request method ikke tilladt. Skal være POST. |
Contact us
Hvis du har spørgsmål vedrørende API'et, er du velkommen til at kontakte os på dg@taxhelper.dk.