Relation

Detail

GET api/v1/relation/{ID}

Requires authentication

Omschrijving:
Ophalen van een specifiek relatie object, met daarbij aanvullende relatie details.

Query parameters

Parameter	Status	Description
RelationID	required

Example request

curl -X GET -G "/api/v1/relation/1" \
    -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjE3ZjRkN2Y4YjI1NWVmMWFmMWY5MDFiOTcyODY1MDkyOTdlZjhmOGE4ZGJlZTNmZWFkYmRiODM0YjZkN2NhZjQ4YzZlODk4ZDE5YWFlNjdmIn0.eyJhdWQiOiIxIiwianRpIjoiMTdmNGQ3ZjhiMjU1ZWYxYWYxZjkwMWI5NzI4NjUwOTI5N2VmOGY4YThkYmVlM2ZlYWRiZGI4MzRiNmQ3Y2FmNDhjNmU4OThkMTlhYWU2N2YiLCJpYXQiOjE2NzA0OTY2NTUsIm5iZiI6MTY3MDQ5NjY1NSwiZXhwIjoxNzAyMDMyNjU1LCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.Nz6o13kbkhxqTwiE_7sXqC34tEXLDPubMCV19Fqhe38yAdue38dYe3TcASionN6bletxN0cPfxwjF7Pn4dWx8F-6b-NO8SWCJTMzyZDpLf8mITwzrFFvCNquk1JJ-haMay81pUUlcSHaOZNHjP0JCOE-gr35dvx9-BpaLUulwkMqSiDXuiw2ex0prA8UIt1IKJw54baI9mHb5ThU5Eonzdyyk2BLqEXoIuXmkWGrh2GTagVg-SE1r-uS1xHpsJYCtRnAc5sbqQDl8gnYb4gSwuiik6vpFOL7SOiluPj-mDl6okBgNBdoU5KiBjgF4RcOWBKFHMKl0IHidy4ewbJad47riWHIseNdeIod0VPFB7D4vJCzbbZHHb6soY57kLIHwmaf-ugr_QGUT7XqvFY-OPhu5PbfVwR-O6yItnYhW4NGERgVMKVwo1UYpOkhLrWJzE6X9vSLj8yOPUILyrkgzBRCcjE98Wah25bA5ERWP-Ocu2zVSXQ3t7clgcNUae-K-4-Z7YQ8ef8CpdcLdT65b4ZpFpDYSJ-WoHux5HH6hVWa_ZJfphZr-I4PiUvA210Lzqk81DiKD8Qby5_JsCPJLV1dNSLSbZGKsZDThXmw9E7vHoteMKSCoOIo2BoQX8rNEz0lFSbqdr3GgEvS20A546leNGtwGBnIRlsPAvT1J9I"

Example response (200):

[
    {
        "RelatieID": 871,
        "DebiteurNummer": 10866,
        "CrediteurNummer": 50178,
        "Bedrijfsnaam": "KJ Software",
        "Telefoon": "0413-747474",
        "Fax": "",
        "Email": "",
        "Website": "www.kj.nu",
        "BTWNummer": "",
        "Opmerking": "",
        "TypeRelatieID": 1,
        "BetalingsTermijn": 14,
        "DEL": false,
        "TAVStijl": null,
        "DigitaleFactuur": true,
        "KvKnummer": null,
        "BedrijfsvormWaardeID": null,
        "Broncode": null,
        "Kredietbeperking": false,
        "BankNr": "",
        "IbanNr": "NL16ABNA0526715995",
        "BicNr": "",
        "Boekhoudkoppeling_Forceren": false,
        "BetalingsTermijn_Crediteur": 14,
        "ExternalID": null,
        "MandaatID": null,
        "EvenementOpmerking": null,
        "EersteBoekingJaar": 2019,
        "EersteBoekingDagMaand": "04-10",
        "KredietCheck": false,
        "KredietWaardigheid": null,
        "KredietCheckDatum": null,
        "TypeGebruikerWaardeID": null,
        "IncassoRekeninghouder": null,
        "IncassoOndertekenDatum": null,
        "IncassoMachtigingAkkoord": null,
        "TAVHandmatig": null,
        "LocatienummersTonen": null,
        "OprichtingsDatum": null,
        "BusinessUnit": "Test",
        "contacts": [
            {
                "ContactpersoonID": 601,
                "RelatieID": 871,
                "Geslacht": "Man",
                "Voornaam": "Peter",
                "Tussenvoegsel": "",
                "Achternaam": "Joustra",
                "Telefoon": "0413-747400",
                "TelefoonPrive": null,
                "Mobiel": "",
                "Fax": "",
                "Email": "peter@kj.nu",
                "EmailPrive": null,
                "FinancieelContact": false,
                "Opmerking": null,
                "DEL": false,
                "AfdelingWaardeID": null,
                "FunctieID": 4,
                "Straat": "",
                "Huisnummer": "",
                "Postcode": "",
                "Plaats": "",
                "Provincie": null,
                "Land": "",
                "Voorletters": "P.",
                "TitelID": null,
                "MailingOntvangen": true,
                "Twitter": null,
                "LinkedIn": null,
                "ContactpersoonTypeWaardeID": null,
                "Geachte": "heer \/ mevrouw Joustra"
            },
            {
                "ContactpersoonID": 3992,
                "RelatieID": 871,
                "Geslacht": "Man",
                "Voornaam": "Tim",
                "Tussenvoegsel": null,
                "Achternaam": "Huijbers",
                "Telefoon": null,
                "TelefoonPrive": null,
                "Mobiel": null,
                "Fax": null,
                "Email": "tim@kj.nu",
                "EmailPrive": null,
                "FinancieelContact": false,
                "Opmerking": null,
                "DEL": false,
                "AfdelingWaardeID": null,
                "FunctieID": null,
                "Straat": null,
                "Huisnummer": null,
                "Postcode": null,
                "Plaats": null,
                "Provincie": null,
                "Land": null,
                "Voorletters": null,
                "TitelID": null,
                "MailingOntvangen": false,
                "Twitter": null,
                "LinkedIn": null,
                "ContactpersoonTypeWaardeID": null,
                "Geachte": "heer \/ mevrouw Huijbers"
            },
            {
                "ContactpersoonID": 4982,
                "RelatieID": 871,
                "Geslacht": "n.v.t.",
                "Voornaam": "EasyParty",
                "Tussenvoegsel": null,
                "Achternaam": "Support",
                "Telefoon": null,
                "TelefoonPrive": null,
                "Mobiel": null,
                "Fax": null,
                "Email": "support@easyparty.nl",
                "EmailPrive": null,
                "FinancieelContact": false,
                "Opmerking": null,
                "DEL": false,
                "AfdelingWaardeID": null,
                "FunctieID": null,
                "Straat": null,
                "Huisnummer": null,
                "Postcode": null,
                "Plaats": null,
                "Provincie": null,
                "Land": null,
                "Voorletters": null,
                "TitelID": null,
                "MailingOntvangen": false,
                "Twitter": null,
                "LinkedIn": null,
                "ContactpersoonTypeWaardeID": null,
                "Geachte": "heer \/ mevrouw Support"
            },
            {
                "ContactpersoonID": 600,
                "RelatieID": 871,
                "Geslacht": "Man",
                "Voornaam": "Bart",
                "Tussenvoegsel": "",
                "Achternaam": "Kablau",
                "Telefoon": "0413-747474",
                "TelefoonPrive": null,
                "Mobiel": "",
                "Fax": "",
                "Email": "Bart@kj.nu",
                "EmailPrive": null,
                "FinancieelContact": true,
                "Opmerking": null,
                "DEL": false,
                "AfdelingWaardeID": null,
                "FunctieID": 4,
                "Straat": "",
                "Huisnummer": "",
                "Postcode": "",
                "Plaats": "",
                "Provincie": null,
                "Land": "",
                "Voorletters": "B.",
                "TitelID": null,
                "MailingOntvangen": true,
                "Twitter": null,
                "LinkedIn": null,
                "ContactpersoonTypeWaardeID": null,
                "Geachte": "heer \/ mevrouw Kablau"
            }
        ],
        "addresses": [
            {
                "RelatieAdresID": 2607,
                "RelatieID": 871,
                "AdresID": 2608,
                "TypeAdres": 1,
                "DEL": true,
                "address": {
                    "AdresID": 2607,
                    "Straat": "Lorbaan",
                    "Huisnummer": "27",
                    "Postcode": "5985 NX",
                    "Plaats": "Grashoek",
                    "Provincie": null,
                    "LandID": 999
                }
            },
            {
                "RelatieAdresID": 2608,
                "RelatieID": 871,
                "AdresID": 2609,
                "TypeAdres": 2,
                "DEL": null,
                "address": {
                    "AdresID": 2608,
                    "Straat": "N.C.B.-Laan",
                    "Huisnummer": "52,5",
                    "Postcode": "5462 GE",
                    "Plaats": "Veghel",
                    "Provincie": null,
                    "LandID": 999
                }
            },
            {
                "RelatieAdresID": 2609,
                "RelatieID": 871,
                "AdresID": 2610,
                "TypeAdres": 3,
                "DEL": null,
                "address": {
                    "AdresID": 2609,
                    "Straat": "Postbus",
                    "Huisnummer": "33",
                    "Postcode": "5460 AA",
                    "Plaats": "Veghel",
                    "Provincie": null,
                    "LandID": 999
                }
            }
        ],
        "type": {
            "TypeRelatieID": 1,
            "Omschrijving": "Klant - Zakelijk"
        },
        "potentiele_omzet": {
            "WaardeID": 1601,
            "TypeID": 1,
            "Omschrijving": "€ 0 - € 1000",
            "Code": null
        },
        "branche": {
            "WaardeID": 162,
            "TypeID": 2,
            "Omschrijving": "ICT en aanverwanten",
            "Code": null
        },
        "aantal_medewerkers": {
            "WaardeID": 199,
            "TypeID": 3,
            "Omschrijving": "0-20 medewerkers",
            "Code": null
        },
        "relatie_status": {
            "WaardeID": 1617,
            "TypeID": 5,
            "Omschrijving": "Afas crediteur",
            "Code": null
        },
        "broncode": {
            "WaardeID": 193,
            "TypeID": 6,
            "Omschrijving": "Import oude systeem",
            "Code": null
        },
        "vestigingsland": null,
        "keyaccountmanager": null,
        "verzamelfacturen": null,
        "rechtsvorm": null,
        "moederbedrijf": null,
        "relation_types": [
            {
                "WaardeLinkID": 6323,
                "WaardeID": 1152,
                "RelatieID": 871,
                "ZaalID": null,
                "TypeID": 25,
                "Omschrijving": "AFAS Crediteur",
                "dropdownwaarde": {
                    "WaardeID": 1152,
                    "TypeID": 25,
                    "Omschrijving": "AFAS Crediteur",
                    "Code": null
                }
            }
        ],
        "relation_description": [],
        "relation_discount": [],
        "relation_commission": []
    }
]

Detail external

GET api/v1/relation/detailExternal/{ID}

Requires authentication

Omschrijving:
Ophalen van een specifiek relatie object, met daarbij aanvullende relatie details.

Query parameters

Parameter	Status	Description
ExternalID	required	string

Example request

curl -X GET -G "/api/v1/relation/detailExternal/1" \
    -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjE3ZjRkN2Y4YjI1NWVmMWFmMWY5MDFiOTcyODY1MDkyOTdlZjhmOGE4ZGJlZTNmZWFkYmRiODM0YjZkN2NhZjQ4YzZlODk4ZDE5YWFlNjdmIn0.eyJhdWQiOiIxIiwianRpIjoiMTdmNGQ3ZjhiMjU1ZWYxYWYxZjkwMWI5NzI4NjUwOTI5N2VmOGY4YThkYmVlM2ZlYWRiZGI4MzRiNmQ3Y2FmNDhjNmU4OThkMTlhYWU2N2YiLCJpYXQiOjE2NzA0OTY2NTUsIm5iZiI6MTY3MDQ5NjY1NSwiZXhwIjoxNzAyMDMyNjU1LCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.Nz6o13kbkhxqTwiE_7sXqC34tEXLDPubMCV19Fqhe38yAdue38dYe3TcASionN6bletxN0cPfxwjF7Pn4dWx8F-6b-NO8SWCJTMzyZDpLf8mITwzrFFvCNquk1JJ-haMay81pUUlcSHaOZNHjP0JCOE-gr35dvx9-BpaLUulwkMqSiDXuiw2ex0prA8UIt1IKJw54baI9mHb5ThU5Eonzdyyk2BLqEXoIuXmkWGrh2GTagVg-SE1r-uS1xHpsJYCtRnAc5sbqQDl8gnYb4gSwuiik6vpFOL7SOiluPj-mDl6okBgNBdoU5KiBjgF4RcOWBKFHMKl0IHidy4ewbJad47riWHIseNdeIod0VPFB7D4vJCzbbZHHb6soY57kLIHwmaf-ugr_QGUT7XqvFY-OPhu5PbfVwR-O6yItnYhW4NGERgVMKVwo1UYpOkhLrWJzE6X9vSLj8yOPUILyrkgzBRCcjE98Wah25bA5ERWP-Ocu2zVSXQ3t7clgcNUae-K-4-Z7YQ8ef8CpdcLdT65b4ZpFpDYSJ-WoHux5HH6hVWa_ZJfphZr-I4PiUvA210Lzqk81DiKD8Qby5_JsCPJLV1dNSLSbZGKsZDThXmw9E7vHoteMKSCoOIo2BoQX8rNEz0lFSbqdr3GgEvS20A546leNGtwGBnIRlsPAvT1J9I"

Example response (200):

[
    {
        "RelatieID": 871,
        "DebiteurNummer": 10866,
        "CrediteurNummer": 50178,
        "Bedrijfsnaam": "KJ Software",
        "Telefoon": "0413-747474",
        "Fax": "",
        "Email": "",
        "Website": "www.kj.nu",
        "BTWNummer": "",
        "Opmerking": "",
        "TypeRelatieID": 1,
        "BetalingsTermijn": 14,
        "DEL": false,
        "TAVStijl": null,
        "DigitaleFactuur": true,
        "KvKnummer": null,
        "BedrijfsvormWaardeID": null,
        "Broncode": null,
        "Kredietbeperking": false,
        "BankNr": "",
        "IbanNr": "NL16ABNA0526715995",
        "BicNr": "",
        "Boekhoudkoppeling_Forceren": false,
        "BetalingsTermijn_Crediteur": 14,
        "ExternalID": null,
        "MandaatID": null,
        "EvenementOpmerking": null,
        "EersteBoekingJaar": 2019,
        "EersteBoekingDagMaand": "04-10",
        "KredietCheck": false,
        "KredietWaardigheid": null,
        "KredietCheckDatum": null,
        "TypeGebruikerWaardeID": null,
        "IncassoRekeninghouder": null,
        "IncassoOndertekenDatum": null,
        "IncassoMachtigingAkkoord": null,
        "TAVHandmatig": null,
        "LocatienummersTonen": null,
        "OprichtingsDatum": null,
        "BusinessUnit": "Test",
        "contacts": [
            {
                "ContactpersoonID": 601,
                "RelatieID": 871,
                "Geslacht": "Man",
                "Voornaam": "Peter",
                "Tussenvoegsel": "",
                "Achternaam": "Joustra",
                "Telefoon": "0413-747400",
                "TelefoonPrive": null,
                "Mobiel": "",
                "Fax": "",
                "Email": "peter@kj.nu",
                "EmailPrive": null,
                "FinancieelContact": false,
                "Opmerking": null,
                "DEL": false,
                "AfdelingWaardeID": null,
                "FunctieID": 4,
                "Straat": "",
                "Huisnummer": "",
                "Postcode": "",
                "Plaats": "",
                "Provincie": null,
                "Land": "",
                "Voorletters": "P.",
                "TitelID": null,
                "MailingOntvangen": true,
                "Twitter": null,
                "LinkedIn": null,
                "ContactpersoonTypeWaardeID": null,
                "Geachte": "heer \/ mevrouw Joustra"
            },
            {
                "ContactpersoonID": 3992,
                "RelatieID": 871,
                "Geslacht": "Man",
                "Voornaam": "Tim",
                "Tussenvoegsel": null,
                "Achternaam": "Huijbers",
                "Telefoon": null,
                "TelefoonPrive": null,
                "Mobiel": null,
                "Fax": null,
                "Email": "tim@kj.nu",
                "EmailPrive": null,
                "FinancieelContact": false,
                "Opmerking": null,
                "DEL": false,
                "AfdelingWaardeID": null,
                "FunctieID": null,
                "Straat": null,
                "Huisnummer": null,
                "Postcode": null,
                "Plaats": null,
                "Provincie": null,
                "Land": null,
                "Voorletters": null,
                "TitelID": null,
                "MailingOntvangen": false,
                "Twitter": null,
                "LinkedIn": null,
                "ContactpersoonTypeWaardeID": null,
                "Geachte": "heer \/ mevrouw Huijbers"
            },
            {
                "ContactpersoonID": 4982,
                "RelatieID": 871,
                "Geslacht": "n.v.t.",
                "Voornaam": "EasyParty",
                "Tussenvoegsel": null,
                "Achternaam": "Support",
                "Telefoon": null,
                "TelefoonPrive": null,
                "Mobiel": null,
                "Fax": null,
                "Email": "support@easyparty.nl",
                "EmailPrive": null,
                "FinancieelContact": false,
                "Opmerking": null,
                "DEL": false,
                "AfdelingWaardeID": null,
                "FunctieID": null,
                "Straat": null,
                "Huisnummer": null,
                "Postcode": null,
                "Plaats": null,
                "Provincie": null,
                "Land": null,
                "Voorletters": null,
                "TitelID": null,
                "MailingOntvangen": false,
                "Twitter": null,
                "LinkedIn": null,
                "ContactpersoonTypeWaardeID": null,
                "Geachte": "heer \/ mevrouw Support"
            },
            {
                "ContactpersoonID": 600,
                "RelatieID": 871,
                "Geslacht": "Man",
                "Voornaam": "Bart",
                "Tussenvoegsel": "",
                "Achternaam": "Kablau",
                "Telefoon": "0413-747474",
                "TelefoonPrive": null,
                "Mobiel": "",
                "Fax": "",
                "Email": "Bart@kj.nu",
                "EmailPrive": null,
                "FinancieelContact": true,
                "Opmerking": null,
                "DEL": false,
                "AfdelingWaardeID": null,
                "FunctieID": 4,
                "Straat": "",
                "Huisnummer": "",
                "Postcode": "",
                "Plaats": "",
                "Provincie": null,
                "Land": "",
                "Voorletters": "B.",
                "TitelID": null,
                "MailingOntvangen": true,
                "Twitter": null,
                "LinkedIn": null,
                "ContactpersoonTypeWaardeID": null,
                "Geachte": "heer \/ mevrouw Kablau"
            }
        ],
        "addresses": [
            {
                "RelatieAdresID": 2607,
                "RelatieID": 871,
                "AdresID": 2608,
                "TypeAdres": 1,
                "DEL": true,
                "address": {
                    "AdresID": 2607,
                    "Straat": "Lorbaan",
                    "Huisnummer": "27",
                    "Postcode": "5985 NX",
                    "Plaats": "Grashoek",
                    "Provincie": null,
                    "LandID": 999
                }
            },
            {
                "RelatieAdresID": 2608,
                "RelatieID": 871,
                "AdresID": 2609,
                "TypeAdres": 2,
                "DEL": null,
                "address": {
                    "AdresID": 2608,
                    "Straat": "N.C.B.-Laan",
                    "Huisnummer": "52,5",
                    "Postcode": "5462 GE",
                    "Plaats": "Veghel",
                    "Provincie": null,
                    "LandID": 999
                }
            },
            {
                "RelatieAdresID": 2609,
                "RelatieID": 871,
                "AdresID": 2610,
                "TypeAdres": 3,
                "DEL": null,
                "address": {
                    "AdresID": 2609,
                    "Straat": "Postbus",
                    "Huisnummer": "33",
                    "Postcode": "5460 AA",
                    "Plaats": "Veghel",
                    "Provincie": null,
                    "LandID": 999
                }
            }
        ],
        "type": {
            "TypeRelatieID": 1,
            "Omschrijving": "Klant - Zakelijk"
        },
        "potentiele_omzet": {
            "WaardeID": 1601,
            "TypeID": 1,
            "Omschrijving": "€ 0 - € 1000",
            "Code": null
        },
        "branche": {
            "WaardeID": 162,
            "TypeID": 2,
            "Omschrijving": "ICT en aanverwanten",
            "Code": null
        },
        "aantal_medewerkers": {
            "WaardeID": 199,
            "TypeID": 3,
            "Omschrijving": "0-20 medewerkers",
            "Code": null
        },
        "relatie_status": {
            "WaardeID": 1617,
            "TypeID": 5,
            "Omschrijving": "Afas crediteur",
            "Code": null
        },
        "broncode": {
            "WaardeID": 193,
            "TypeID": 6,
            "Omschrijving": "Import oude systeem",
            "Code": null
        },
        "vestigingsland": null,
        "keyaccountmanager": null,
        "verzamelfacturen": null,
        "rechtsvorm": null,
        "moederbedrijf": null,
        "relation_types": [
            {
                "WaardeLinkID": 6323,
                "WaardeID": 1152,
                "RelatieID": 871,
                "ZaalID": null,
                "TypeID": 25,
                "Omschrijving": "AFAS Crediteur",
                "dropdownwaarde": {
                    "WaardeID": 1152,
                    "TypeID": 25,
                    "Omschrijving": "AFAS Crediteur",
                    "Code": null
                }
            }
        ],
        "relation_description": [],
        "relation_discount": [],
        "relation_commission": []
    }
]

Create

PUT api/v1/relation

Requires authentication

Omschrijving:
Invoeren van een nieuwe relatie in het systeem

Body parameters

Parameter	Type	Status	Description
TypeRelatieID	integer	required	1 = Klant - Zakelijk, 2 = Klant - Particulier, 3 = Leverancier
Bedrijfsnaam	string	required	Naam van het bedrijf
Telefoon	required	optional	string
Email	email	required
TAVStijl	integer	optional
TAVHandmatig	string	optional
Fax	string	optional
RelatieVerantwoordelijkeID	integer	optional
EersteBoekingDagMaand	string	optional	format: "DD-MM"
EersteBoekingJaar	string	optional	format: "YYYY"
VestigingslandID	integer,	optional	endpoint: api/v1/country/all
BedrijfsvormWaardeID	integer,	optional	endpoint: api/v1/dropdownvalue/{id}
BrancheWaardeID	integer,	optional	endpoint: api/v1/dropdownvalue/{id}
AantalMedewerkersWaardeID	integer,	optional	endpoint: api/v1/dropdownvalue/{id}
RelatieStatusWaardeID	integer,	optional	endpoint: api/v1/dropdownvalue/{id}
BronWaardeID	integer,	optional	endpoint: api/v1/dropdownvalue/{id}
Broncode	string/integer	optional
BetalingsTermijn	integer	optional
BetalingsTermijn_Crediteur	integer	optional	0 of 1
BTWNummer	string	optional
DigitaleFactuur	integer	optional	0 of 1
Kredietbeperking	integer	optional	0 of 1
LocatienummersTonen	integer	optional	0 of 1
KredietCheck	integer	optional	0 of 1
KredietWaardigheid	integer	optional	0 of 1
KredietCheckDatum	date	optional	format: YYYY-mm-dd HH:mm:ss
Boekhoudkoppeling_Forceren	integer	optional	0 of 1
KvKnummer	string	optional
VerzamelfacturenWaardeID	integer,	optional	endpoint: api/v1/dropdownvalue/{id}
IncassoRekeninghouder	integer	optional	0 of 1
BankNr	string	optional
IbanNr	string	optional
BicNr	string	optional
IncassoMachtigingAkkoord	integer	optional	0 of 1
MandaatID	integer	optional
IncassoOndertekenDatum	integer	optional	format: YYYY-mm-dd
Opmerking	string	optional
MoederID	integer	optional
CrediteurNummer	null	optional
DebiteurNummer	null	optional
BusinessUnit	string	optional

Example request

curl -X PUT "/api/v1/relation" \
    -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjE3ZjRkN2Y4YjI1NWVmMWFmMWY5MDFiOTcyODY1MDkyOTdlZjhmOGE4ZGJlZTNmZWFkYmRiODM0YjZkN2NhZjQ4YzZlODk4ZDE5YWFlNjdmIn0.eyJhdWQiOiIxIiwianRpIjoiMTdmNGQ3ZjhiMjU1ZWYxYWYxZjkwMWI5NzI4NjUwOTI5N2VmOGY4YThkYmVlM2ZlYWRiZGI4MzRiNmQ3Y2FmNDhjNmU4OThkMTlhYWU2N2YiLCJpYXQiOjE2NzA0OTY2NTUsIm5iZiI6MTY3MDQ5NjY1NSwiZXhwIjoxNzAyMDMyNjU1LCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.Nz6o13kbkhxqTwiE_7sXqC34tEXLDPubMCV19Fqhe38yAdue38dYe3TcASionN6bletxN0cPfxwjF7Pn4dWx8F-6b-NO8SWCJTMzyZDpLf8mITwzrFFvCNquk1JJ-haMay81pUUlcSHaOZNHjP0JCOE-gr35dvx9-BpaLUulwkMqSiDXuiw2ex0prA8UIt1IKJw54baI9mHb5ThU5Eonzdyyk2BLqEXoIuXmkWGrh2GTagVg-SE1r-uS1xHpsJYCtRnAc5sbqQDl8gnYb4gSwuiik6vpFOL7SOiluPj-mDl6okBgNBdoU5KiBjgF4RcOWBKFHMKl0IHidy4ewbJad47riWHIseNdeIod0VPFB7D4vJCzbbZHHb6soY57kLIHwmaf-ugr_QGUT7XqvFY-OPhu5PbfVwR-O6yItnYhW4NGERgVMKVwo1UYpOkhLrWJzE6X9vSLj8yOPUILyrkgzBRCcjE98Wah25bA5ERWP-Ocu2zVSXQ3t7clgcNUae-K-4-Z7YQ8ef8CpdcLdT65b4ZpFpDYSJ-WoHux5HH6hVWa_ZJfphZr-I4PiUvA210Lzqk81DiKD8Qby5_JsCPJLV1dNSLSbZGKsZDThXmw9E7vHoteMKSCoOIo2BoQX8rNEz0lFSbqdr3GgEvS20A546leNGtwGBnIRlsPAvT1J9I" \
    -H "Content-Type: application/json" \
    -d '{"TypeRelatieID":2,"Bedrijfsnaam":"temporibus","Telefoon":"sunt","Email":"sed","TAVStijl":5,"TAVHandmatig":"et","Fax":"aut","RelatieVerantwoordelijkeID":15,"EersteBoekingDagMaand":"facere","EersteBoekingJaar":"tempore","VestigingslandID":"aut","BedrijfsvormWaardeID":"quaerat","BrancheWaardeID":"assumenda","AantalMedewerkersWaardeID":"accusantium","RelatieStatusWaardeID":"iusto","BronWaardeID":"et","Broncode":"sint","BetalingsTermijn":2,"BetalingsTermijn_Crediteur":16,"BTWNummer":"aut","DigitaleFactuur":17,"Kredietbeperking":1,"LocatienummersTonen":19,"KredietCheck":8,"KredietWaardigheid":3,"KredietCheckDatum":"non","Boekhoudkoppeling_Forceren":1,"KvKnummer":"deleniti","VerzamelfacturenWaardeID":"ab","IncassoRekeninghouder":1,"BankNr":"corporis","IbanNr":"officiis","BicNr":"veritatis","IncassoMachtigingAkkoord":15,"MandaatID":17,"IncassoOndertekenDatum":5,"Opmerking":"excepturi","MoederID":15,"CrediteurNummer":"et","DebiteurNummer":"exercitationem","BusinessUnit":"sit"}'

Example response (200):

{
    "id": 2186,
    "success": true
}

Update

POST api/v1/relation

Requires authentication

Omschrijving:
Aanpassen van een bestaand relatie object.

Body parameters

Parameter	Type	Status	Description
RelatieID	integer	required	Wanneer ExternalID niet gevuld is RelatieID required endpoint: api/v1/relation/{id}
ExternalID	integer	required	Wanneer ExternalID niet gevuld is RelatieID required
TypeRelatieID	integer	required
Bedrijfsnaam	string	required	Naam van het bedrijf
Telefoon	required	optional	string
Email	email	required
TAVStijl	integer	optional
TAVHandmatig	string	optional
Fax	string	optional
RelatieVerantwoordelijkeID	integer	optional
EersteBoekingDagMaand	string	optional	format: "DD-MM"
EersteBoekingJaar	string	optional	format: "YYYY"
VestigingslandID	integer,	optional	endpoint: api/v1/country/all
BedrijfsvormWaardeID	integer,	optional	endpoint: api/v1/dropdownvalue/{id}
BrancheWaardeID	integer,	optional	endpoint: api/v1/dropdownvalue/{id}
AantalMedewerkersWaardeID	integer,	optional	endpoint: api/v1/dropdownvalue/{id}
RelatieStatusWaardeID	integer,	optional	endpoint: api/v1/dropdownvalue/{id}
BronWaardeID	integer,	optional	endpoint: api/v1/dropdownvalue/{id}
Broncode	string/integer	optional
BetalingsTermijn	integer	optional
BetalingsTermijn_Crediteur	integer	optional	0 of 1
BTWNummer	string	optional
DigitaleFactuur	integer	optional	0 of 1
Kredietbeperking	integer	optional	0 of 1
LocatienummersTonen	integer	optional	0 of 1
KredietCheck	integer	optional	0 of 1
KredietWaardigheid	integer	optional	0 of 1
KredietCheckDatum	date	optional	format: YYYY-mm-dd HH:mm:ss
Boekhoudkoppeling_Forceren	integer	optional	0 of 1
KvKnummer	string	optional
VerzamelfacturenWaardeID	integer,	optional	endpoint: api/v1/dropdownvalue/{id}
IncassoRekeninghouder	integer	optional	0 of 1
BankNr	string	optional
IbanNr	string	optional
BicNr	string	optional
IncassoMachtigingAkkoord	integer	optional	0 of 1
MandaatID	integer	optional
IncassoOndertekenDatum	integer	optional	format: YYYY-mm-dd
Opmerking	string	optional
MoederID	integer	optional
CrediteurNummer	null	optional
DebiteurNummer	null	optional
BusinessUnit	string	optional

Example request

curl -X POST "/api/v1/relation" \
    -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjE3ZjRkN2Y4YjI1NWVmMWFmMWY5MDFiOTcyODY1MDkyOTdlZjhmOGE4ZGJlZTNmZWFkYmRiODM0YjZkN2NhZjQ4YzZlODk4ZDE5YWFlNjdmIn0.eyJhdWQiOiIxIiwianRpIjoiMTdmNGQ3ZjhiMjU1ZWYxYWYxZjkwMWI5NzI4NjUwOTI5N2VmOGY4YThkYmVlM2ZlYWRiZGI4MzRiNmQ3Y2FmNDhjNmU4OThkMTlhYWU2N2YiLCJpYXQiOjE2NzA0OTY2NTUsIm5iZiI6MTY3MDQ5NjY1NSwiZXhwIjoxNzAyMDMyNjU1LCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.Nz6o13kbkhxqTwiE_7sXqC34tEXLDPubMCV19Fqhe38yAdue38dYe3TcASionN6bletxN0cPfxwjF7Pn4dWx8F-6b-NO8SWCJTMzyZDpLf8mITwzrFFvCNquk1JJ-haMay81pUUlcSHaOZNHjP0JCOE-gr35dvx9-BpaLUulwkMqSiDXuiw2ex0prA8UIt1IKJw54baI9mHb5ThU5Eonzdyyk2BLqEXoIuXmkWGrh2GTagVg-SE1r-uS1xHpsJYCtRnAc5sbqQDl8gnYb4gSwuiik6vpFOL7SOiluPj-mDl6okBgNBdoU5KiBjgF4RcOWBKFHMKl0IHidy4ewbJad47riWHIseNdeIod0VPFB7D4vJCzbbZHHb6soY57kLIHwmaf-ugr_QGUT7XqvFY-OPhu5PbfVwR-O6yItnYhW4NGERgVMKVwo1UYpOkhLrWJzE6X9vSLj8yOPUILyrkgzBRCcjE98Wah25bA5ERWP-Ocu2zVSXQ3t7clgcNUae-K-4-Z7YQ8ef8CpdcLdT65b4ZpFpDYSJ-WoHux5HH6hVWa_ZJfphZr-I4PiUvA210Lzqk81DiKD8Qby5_JsCPJLV1dNSLSbZGKsZDThXmw9E7vHoteMKSCoOIo2BoQX8rNEz0lFSbqdr3GgEvS20A546leNGtwGBnIRlsPAvT1J9I" \
    -H "Content-Type: application/json" \
    -d '{"RelatieID":14,"ExternalID":4,"TypeRelatieID":4,"Bedrijfsnaam":"reiciendis","Telefoon":"quam","Email":"explicabo","TAVStijl":17,"TAVHandmatig":"consectetur","Fax":"nihil","RelatieVerantwoordelijkeID":5,"EersteBoekingDagMaand":"accusantium","EersteBoekingJaar":"aspernatur","VestigingslandID":"amet","BedrijfsvormWaardeID":"quae","BrancheWaardeID":"perferendis","AantalMedewerkersWaardeID":"veniam","RelatieStatusWaardeID":"harum","BronWaardeID":"consequatur","Broncode":"pariatur","BetalingsTermijn":8,"BetalingsTermijn_Crediteur":8,"BTWNummer":"sint","DigitaleFactuur":11,"Kredietbeperking":20,"LocatienummersTonen":18,"KredietCheck":19,"KredietWaardigheid":3,"KredietCheckDatum":"et","Boekhoudkoppeling_Forceren":8,"KvKnummer":"sit","VerzamelfacturenWaardeID":"et","IncassoRekeninghouder":6,"BankNr":"est","IbanNr":"quis","BicNr":"quos","IncassoMachtigingAkkoord":11,"MandaatID":11,"IncassoOndertekenDatum":1,"Opmerking":"et","MoederID":12,"CrediteurNummer":"porro","DebiteurNummer":"voluptatem","BusinessUnit":"consequuntur"}'

Example response (200):

{
    "id": 2186,
    "success": true
}

Delete

DELETE api/v1/relation/{ID}

Requires authentication

Omschrijving:
Verwijderen van een relatie object

Query parameters

Parameter	Status	Description
RelatieID	required	integer

Example request

curl -X DELETE "/api/v1/relation/1" \
    -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjE3ZjRkN2Y4YjI1NWVmMWFmMWY5MDFiOTcyODY1MDkyOTdlZjhmOGE4ZGJlZTNmZWFkYmRiODM0YjZkN2NhZjQ4YzZlODk4ZDE5YWFlNjdmIn0.eyJhdWQiOiIxIiwianRpIjoiMTdmNGQ3ZjhiMjU1ZWYxYWYxZjkwMWI5NzI4NjUwOTI5N2VmOGY4YThkYmVlM2ZlYWRiZGI4MzRiNmQ3Y2FmNDhjNmU4OThkMTlhYWU2N2YiLCJpYXQiOjE2NzA0OTY2NTUsIm5iZiI6MTY3MDQ5NjY1NSwiZXhwIjoxNzAyMDMyNjU1LCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.Nz6o13kbkhxqTwiE_7sXqC34tEXLDPubMCV19Fqhe38yAdue38dYe3TcASionN6bletxN0cPfxwjF7Pn4dWx8F-6b-NO8SWCJTMzyZDpLf8mITwzrFFvCNquk1JJ-haMay81pUUlcSHaOZNHjP0JCOE-gr35dvx9-BpaLUulwkMqSiDXuiw2ex0prA8UIt1IKJw54baI9mHb5ThU5Eonzdyyk2BLqEXoIuXmkWGrh2GTagVg-SE1r-uS1xHpsJYCtRnAc5sbqQDl8gnYb4gSwuiik6vpFOL7SOiluPj-mDl6okBgNBdoU5KiBjgF4RcOWBKFHMKl0IHidy4ewbJad47riWHIseNdeIod0VPFB7D4vJCzbbZHHb6soY57kLIHwmaf-ugr_QGUT7XqvFY-OPhu5PbfVwR-O6yItnYhW4NGERgVMKVwo1UYpOkhLrWJzE6X9vSLj8yOPUILyrkgzBRCcjE98Wah25bA5ERWP-Ocu2zVSXQ3t7clgcNUae-K-4-Z7YQ8ef8CpdcLdT65b4ZpFpDYSJ-WoHux5HH6hVWa_ZJfphZr-I4PiUvA210Lzqk81DiKD8Qby5_JsCPJLV1dNSLSbZGKsZDThXmw9E7vHoteMKSCoOIo2BoQX8rNEz0lFSbqdr3GgEvS20A546leNGtwGBnIRlsPAvT1J9I"

Example response (200):

{
    "id": 2186,
    "success": true
}

All

GET api/v1/relation/all

Requires authentication

Omschrijving:
Ophalen van alle actieve relatie objecten.

Example request

curl -X GET -G "/api/v1/relation/all" \
    -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjE3ZjRkN2Y4YjI1NWVmMWFmMWY5MDFiOTcyODY1MDkyOTdlZjhmOGE4ZGJlZTNmZWFkYmRiODM0YjZkN2NhZjQ4YzZlODk4ZDE5YWFlNjdmIn0.eyJhdWQiOiIxIiwianRpIjoiMTdmNGQ3ZjhiMjU1ZWYxYWYxZjkwMWI5NzI4NjUwOTI5N2VmOGY4YThkYmVlM2ZlYWRiZGI4MzRiNmQ3Y2FmNDhjNmU4OThkMTlhYWU2N2YiLCJpYXQiOjE2NzA0OTY2NTUsIm5iZiI6MTY3MDQ5NjY1NSwiZXhwIjoxNzAyMDMyNjU1LCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.Nz6o13kbkhxqTwiE_7sXqC34tEXLDPubMCV19Fqhe38yAdue38dYe3TcASionN6bletxN0cPfxwjF7Pn4dWx8F-6b-NO8SWCJTMzyZDpLf8mITwzrFFvCNquk1JJ-haMay81pUUlcSHaOZNHjP0JCOE-gr35dvx9-BpaLUulwkMqSiDXuiw2ex0prA8UIt1IKJw54baI9mHb5ThU5Eonzdyyk2BLqEXoIuXmkWGrh2GTagVg-SE1r-uS1xHpsJYCtRnAc5sbqQDl8gnYb4gSwuiik6vpFOL7SOiluPj-mDl6okBgNBdoU5KiBjgF4RcOWBKFHMKl0IHidy4ewbJad47riWHIseNdeIod0VPFB7D4vJCzbbZHHb6soY57kLIHwmaf-ugr_QGUT7XqvFY-OPhu5PbfVwR-O6yItnYhW4NGERgVMKVwo1UYpOkhLrWJzE6X9vSLj8yOPUILyrkgzBRCcjE98Wah25bA5ERWP-Ocu2zVSXQ3t7clgcNUae-K-4-Z7YQ8ef8CpdcLdT65b4ZpFpDYSJ-WoHux5HH6hVWa_ZJfphZr-I4PiUvA210Lzqk81DiKD8Qby5_JsCPJLV1dNSLSbZGKsZDThXmw9E7vHoteMKSCoOIo2BoQX8rNEz0lFSbqdr3GgEvS20A546leNGtwGBnIRlsPAvT1J9I"

Example response (200):

[
    {
        "RelatieID": 871,
        "DebiteurNummer": 10866,
        "CrediteurNummer": 50178,
        "Bedrijfsnaam": "KJ Software",
        "Telefoon": "0413-747474",
        "Fax": "",
        "Email": "",
        "Website": "www.kj.nu",
        "BTWNummer": "",
        "Opmerking": "",
        "TypeRelatieID": 1,
        "BetalingsTermijn": 14,
        "DEL": false,
        "TAVStijl": null,
        "DigitaleFactuur": true,
        "KvKnummer": null,
        "BedrijfsvormWaardeID": null,
        "Broncode": null,
        "Kredietbeperking": false,
        "BankNr": "",
        "IbanNr": "NL16ABNA0526715995",
        "BicNr": "",
        "Boekhoudkoppeling_Forceren": false,
        "BetalingsTermijn_Crediteur": 14,
        "ExternalID": null,
        "MandaatID": null,
        "EvenementOpmerking": null,
        "EersteBoekingJaar": 2019,
        "EersteBoekingDagMaand": "04-10",
        "KredietCheck": false,
        "KredietWaardigheid": null,
        "KredietCheckDatum": null,
        "TypeGebruikerWaardeID": null,
        "IncassoRekeninghouder": null,
        "IncassoOndertekenDatum": null,
        "IncassoMachtigingAkkoord": null,
        "TAVHandmatig": null,
        "LocatienummersTonen": null,
        "OprichtingsDatum": null,
        "BusinessUnit": "Test"
    },
    {
        "RelatieID": 872,
        "DebiteurNummer": 10866,
        "CrediteurNummer": 50178,
        "Bedrijfsnaam": "KJ Software 2",
        "Telefoon": "0413-747474",
        "Fax": "",
        "Email": "",
        "Website": "www.kj.nu",
        "BTWNummer": "",
        "Opmerking": "",
        "TypeRelatieID": 1,
        "BetalingsTermijn": 14,
        "DEL": false,
        "TAVStijl": null,
        "DigitaleFactuur": true,
        "KvKnummer": null,
        "BedrijfsvormWaardeID": null,
        "Broncode": null,
        "Kredietbeperking": false,
        "BankNr": "",
        "IbanNr": "NL16ABNA0526715995",
        "BicNr": "",
        "Boekhoudkoppeling_Forceren": false,
        "BetalingsTermijn_Crediteur": 14,
        "ExternalID": null,
        "MandaatID": null,
        "EvenementOpmerking": null,
        "EersteBoekingJaar": 2019,
        "EersteBoekingDagMaand": "04-10",
        "KredietCheck": false,
        "KredietWaardigheid": null,
        "KredietCheckDatum": null,
        "TypeGebruikerWaardeID": null,
        "IncassoRekeninghouder": null,
        "IncassoOndertekenDatum": null,
        "IncassoMachtigingAkkoord": null,
        "TAVHandmatig": null,
        "LocatienummersTonen": null,
        "OprichtingsDatum": null,
        "BusinessUnit": "Test"
    }
]

Search

GET api/v1/relation/search/{query}

Requires authentication

Omschrijving:
Ophalen van actieve relaties middels een zoekopdracht die filtert op de volgende kolommen van een relatie:

Bedrijfsnaam
RelatieID
Telefoon
Email
BTWNummer
DebiteurNummer
Contactpersonen ->Voornaam
Contactpersonen -> Achternaam
Contactpersonen ->Telefoon
Contactpersonen -> Mobiel
Contactpersonen -> Email
Plaats
Straat
Postcode

Query parameters

Parameter	Status	Description
filterValue	required	value is string. bijvoorbeeld: 'KJ Software'

Example request

curl -X GET -G "/api/v1/relation/search/1" \
    -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjE3ZjRkN2Y4YjI1NWVmMWFmMWY5MDFiOTcyODY1MDkyOTdlZjhmOGE4ZGJlZTNmZWFkYmRiODM0YjZkN2NhZjQ4YzZlODk4ZDE5YWFlNjdmIn0.eyJhdWQiOiIxIiwianRpIjoiMTdmNGQ3ZjhiMjU1ZWYxYWYxZjkwMWI5NzI4NjUwOTI5N2VmOGY4YThkYmVlM2ZlYWRiZGI4MzRiNmQ3Y2FmNDhjNmU4OThkMTlhYWU2N2YiLCJpYXQiOjE2NzA0OTY2NTUsIm5iZiI6MTY3MDQ5NjY1NSwiZXhwIjoxNzAyMDMyNjU1LCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.Nz6o13kbkhxqTwiE_7sXqC34tEXLDPubMCV19Fqhe38yAdue38dYe3TcASionN6bletxN0cPfxwjF7Pn4dWx8F-6b-NO8SWCJTMzyZDpLf8mITwzrFFvCNquk1JJ-haMay81pUUlcSHaOZNHjP0JCOE-gr35dvx9-BpaLUulwkMqSiDXuiw2ex0prA8UIt1IKJw54baI9mHb5ThU5Eonzdyyk2BLqEXoIuXmkWGrh2GTagVg-SE1r-uS1xHpsJYCtRnAc5sbqQDl8gnYb4gSwuiik6vpFOL7SOiluPj-mDl6okBgNBdoU5KiBjgF4RcOWBKFHMKl0IHidy4ewbJad47riWHIseNdeIod0VPFB7D4vJCzbbZHHb6soY57kLIHwmaf-ugr_QGUT7XqvFY-OPhu5PbfVwR-O6yItnYhW4NGERgVMKVwo1UYpOkhLrWJzE6X9vSLj8yOPUILyrkgzBRCcjE98Wah25bA5ERWP-Ocu2zVSXQ3t7clgcNUae-K-4-Z7YQ8ef8CpdcLdT65b4ZpFpDYSJ-WoHux5HH6hVWa_ZJfphZr-I4PiUvA210Lzqk81DiKD8Qby5_JsCPJLV1dNSLSbZGKsZDThXmw9E7vHoteMKSCoOIo2BoQX8rNEz0lFSbqdr3GgEvS20A546leNGtwGBnIRlsPAvT1J9I"

Example response (200):

{
    "RelatieID": 871,
    "DebiteurNummer": "10866",
    "CrediteurNummer": "50178",
    "Bedrijfsnaam": "KJ Software",
    "Telefoon": "0413-747474",
    "Fax": "",
    "Email": null,
    "Website": "www.kj.nu",
    "BTWNummer": "",
    "Opmerking": "",
    "TypeRelatieID": "1",
    "BetalingsTermijn": "14",
    "DEL": "0",
    "TAVStijl": null,
    "DigitaleFactuur": "1",
    "KvKnummer": null,
    "BedrijfsvormWaardeID": null,
    "Broncode": null,
    "Kredietbeperking": "0",
    "BankNr": "",
    "IbanNr": "NL16ABNA0526715995",
    "BicNr": "",
    "Boekhoudkoppeling_Forceren": "0",
    "BetalingsTermijn_Crediteur": "14",
    "ExternalID": null,
    "MandaatID": null,
    "EvenementOpmerking": null,
    "EersteBoekingJaar": "2019",
    "EersteBoekingDagMaand": "04-10",
    "KredietCheck": "0",
    "KredietWaardigheid": null,
    "KredietCheckDatum": null,
    "TypeGebruikerWaardeID": null,
    "IncassoRekeninghouder": null,
    "IncassoOndertekenDatum": null,
    "IncassoMachtigingAkkoord": null,
    "TAVHandmatig": null,
    "LocatienummersTonen": null,
    "OprichtingsDatum": null,
    "BusinessUnit": "Test"
}

Get started

Authenticatie

Core

Core - Product

Endpoints

Events

Planning

Relation

Tests

Relation

Detail

Query parameters

Example request

Detail external

Query parameters

Example request

Create

Body parameters

Example request

Update

Body parameters

Example request

Delete

Query parameters

Example request

All

Example request

Search

Query parameters

Example request