MKG API Relaties

Getest op API V3 en MKG Versie 005.090.002.

---

Inhoudsopgave Opvragen Relatie zoeken Specifieke relatie Lijst met relaties Debiteur zoeken Specifieke debiteur Lijst met debiteuren Crediteur zoeken Specifieke crediteur Lijst met crediteuren Aanmaken Relatie Adres Contactpersoon Debiteur Crediteur

---

Data dictionary Voor informatie over endpoints, velden en acties, zie dit artikel.

 

Postman Voor voorbeelden van API-aanroepen, zie dit artikel.

 

Opvragen

 

Relatie

Een relatie wordt pas een debiteur (klant) of crediteur (leverancier) op het moment dat er een debiteur of crediteur aan de relatie is gekoppeld.

Let op! Een relatie kan zowel een debiteur als een crediteur zijn. Relaties zijn administratieoverstijgend, maar debiteuren en crediteuren zijn dit niet.

De relatiestructuur is als volgt opgebouwd:

• Rela
  • cprs
  • adrs
  • cred
  • debi

Relatie zoeken

Voor het handmatig zoeken naar een relatie kan de volgende GET request gebruiken om geleidelijk een lijst met mogelijkheden weer te geven. Vul bij 'Search' de te zoeken relatie in.

GET {{restUrl}}/Documents/rela

• Filter: Search = “Search text”
• Fieldlist: rela_num,rela_naam,rela_telefoon,rela_email,rela_www
• NumRows: 10

{{restUrl}}/Documents/rela/?Filter=Search = "Search text"&NumRows=10&FieldList=rela_num,rela_naam,rela_telefoon,rela_email,rela_www

 

Specifieke relatie

Voor het opvragen van een specifieke relatie zijn er twee mogelijkheden, namelijk met de primary key en met de row key. De row key komt bij elke GET request mee en is uniek in combinatie met het endpoint.

GET {{restUrl}}/rela/ {{rela_num}}

GET {{restUrl}}/rela/ {{RowKey}}

• Fieldlist: rela_num,rela_naam,rela_telefoon,rela_email,rela_www

{{restUrl}}/Documents/rela/{{rela_num}}/?FieldList=rela_num,rela_naam,rela_telefoon,rela_email,rela_www

 

Lijst met relaties

Voor het opvragen van een lijst met relaties kun je de volgende aanroep gebruiken. De API maakt gebruik van paginering, waarbij maximaal 1000 regels in één aanroep worden aangeboden.

GET {{restUrl}}/Documents/rela

• Filter: rela_actief = true
• Fieldlist: rela_num,rela_naam,rela_telefoon,rela_email,rela_www
• NumRows: 1000
• Skiprows: 0

{{restUrl}}/Documents/rela/?Filter=rela_actief = true &FieldList=rela_num,rela_naam,rela_telefoon,rela_email,rela_www&NumRows=1000&SkipRows=0

 

Debiteur zoeken

Wanneer een gebruiker handmatig naar een relatie wil zoeken kan de volgende GET request gebruikt worden om geleidelijk een lijst met mogelijkheden weer te geven. Vul bij 'Search' de te zoeken debiteur in.

GET {{restUrl}}/Documents/debi

• Filter: Search = “Search text”
• Fieldlist: debi_num,debi_naam,rela_num,debi_email,debi_kvk_num
• NumRows: 10

{{restUrl}}/Documents/debi/?Filter=Search = "Search text"&NumRows=10&FieldList=debi_num,debi_naam,rela_num,debi_email,debi_kvk_num

 

Specifieke debiteur

Voor het opvragen van een specifieke debiteur zijn er twee mogelijkheden, namelijk met de primary key en met de rowkey. De rowkey komt bij elke GET request mee en is uniek in combinatie met het endpoint.

GET {{restUrl}}/debi/ {{admi_num}}+{{debi_num}}

GET {{restUrl}}/debi/ {{RowKey}}

• Fieldlist: debi_num,debi_naam,rela_num,debi_email,debi_kvk_num

{{restUrl}}/Documents/debi/{{admi_num}}+{{debi_num}}/?FieldList=debi_num,debi_naam,rela_num,debi_email,debi_kvk_num

 

Lijst met debiteuren

Voor het opvragen van een lijst met debiteuren kan de volgende aanroep gebruikt worden. De API maakt gebruik van paginering, er worden maximaal 1000 regels in één aanroep aangeboden.

GET {{restUrl}}/Documents/debi

• Filter: debi_actief = true
• NumRows: 1000
• Skiprows: 0
• Fieldlist: debi_num,debi_naam,rela_num,debi_email,debi_kvk_num

{{restUrl}}/Documents/debi?Filter=debi_actief = true&NumRows=100&SkipRows=0&FieldList=debi_num,debi_naam,rela_num,debi_email,debi_kvk_num

 

Crediteur zoeken

Voor het handmatig zoeken naar een crediteur kan de volgende GET request gebruikt worden om geleidelijk een lijst met mogelijkheden weer te geven. Vul bij 'Search' de te zoeken crediteur in.

GET {{restUrl}}/Documents/cred

• Filter: Search = “Search text”
• Fieldlist: cred_num,cred_naam,rela_num,cred_email,cred_kvk_num
• NumRows: 10

{{restUrl}}/Documents/debi/?Filter=Search = "Search text"&NumRows=10&FieldList=cred_num,cred_naam,rela_num,cred_email,cred_kvk_num

 

Specifieke crediteur

Voor het opvragen van een specifieke crediteur zijn er twee mogelijkheden, namelijk met de primary key en met de rowkey. De rowkey komt bij elke GET request mee en is uniek in combinatie met het endpoint.

GET {{restUrl}}/cred/ {{admi_num}}+{{cred_num}}

GET {{restUrl}}/cred/ {{RowKey}}

• Fieldlist: cred_num,cred_naam,rela_num,cred_email,cred_kvk_num

{{restUrl}}/Documents/cred/{{admi_num}}+{{cred_num}}/?FieldList=cred_num,cred_naam,rela_num,cred_email,cred_kvk_num

 

Lijst met crediteuren

Voor het opvragen van een lijst met crediteuren kan de volgende aanroep gebruikt worden. De API maakt gebruik van paginering, waarbij maximaal 1000 regels in één aanroep worden aangeboden.

GET {{restUrl}}/Documents/cred

• Filter: cred_actief = true
• NumRows: 1000
• Skiprows: 0
• Fieldlist: cred_num,cred_naam,rela_num,cred_email,cred_kvk_num

{{restUrl}}/Documents/cred?Filter=cred_actief = true&NumRows=100&SkipRows=0&FieldList=cred_num,cred_naam,rela_num,cred_email,cred_kvk_num

 

Aanmaken

 

Relatie

POST {{restUrl}}/Documents/rela

{{restUrl}}/Documents/rela

Request body:

{
    "request": {
        "InputData": {
            "rela": [
                {
                    "rela_naam": "Relation name",
                    "rela_telefoon": "Phone number",
                    "rela_email": "Relation e-mail",
                    "rela_www": "Relation website",
                    "rela_actief": true
                }
            ]
        }
    }
}

 

Adres

Voor het toevoegen van een adres moet er eerst een relatie bestaan waar het adres aan gekoppeld kan worden. Dit relatienummer gebruik je vervolgens in de call met de variabel {{rela_num}}.

POST {{restUrl}}/Documents/adrs

{{restUrl}}/Documents/adrs

Request body:

{
    "request": {
        "InputData": {
            "adrs": [
                {
                    "rela_num": {{rela_num}},
                    "adrs_actief": true,
                    "adrs_straat": "Street name",
                    "adrs_nummer": 99, 
                    "adrs_postcode": "ZIP code",
                    "adrs_plaats": "City",
                    "land_code": "NL"
                }
            ]
        }
    }
}

 

Contactpersoon

Voor het aanmaken van een debiteur moet er eerst een relatie bestaan waar de debiteur aan wordt gekoppeld. Dit relatienummer gebruik je vervolgens in de call met de variabel {{rela_num}}.

POST {{restUrl}}/Documents/cprs

{{restUrl}}/Documents/cprs

Request body:

{
    "request": {
        "InputData": {
            "cprs": [
                {
                    "rela_num": {{rela_num}},
                    "cprs_actief": true,
                    "cprs_voorletters": "F.",
                    "cprs_voornaam": "Firstname", 
                    "cprs_tussenvoegsel": "Prepos",
                    "cprs_naam": "Lastname"
                }
            ]
        }
    }
}

 

Debiteur

Voor het aanmaken van een debiteur moet er eerst een relatie bestaan waar de debiteur aan wordt gekoppeld. Dit relatienummer gebruik je vervolgens in de call met de variabel {{rela_num}}.

POST {{restUrl}}/Documents/debi

{{restUrl}}/Documents/debi

Request body:

{
    "request": {
        "InputData": {
            "debi": [
                {
                    "rela_num": {{rela_num}},
                    "debi_actief": true,
                    "debi_btw_num": "VAT number",
                    "debi_kvk_num": "KVK number",
                    "debi_email": "E-mail"
                }
            ]
        }
    }
}

 

Crediteur

Voor het aanmaken van een crediteur moet er eerst een relatie bestaan waar de crediteur aan wordt gekoppeld. Dit relatienummer gebruik je vervolgens in de call met de variabel {{rela_num}}.

POST {{restUrl}}/Documents/cred

{{restUrl}}/Documents/cred

Request body:

{
    "request": {
        "InputData": {
            "cred": [
                {
                    "rela_num": {{rela_num}},
                    "cred_actief": true,
                    "cred_btw_num": "VAT number",
                    "cred_kvk_num": "KVK number",
                    "cred_email": "E-mail"
                }
            ]
        }
    }
}