API Documentatie

Autorisatie

Voor de autorisatie gebruiken we Bearer Tokens. Neem contact op met For Suppliers om een autorisatie aan te vragen.

Endpoints

Een lijst met alle endpoints voor het ophalen van gegevens.

Method	Request	Beschrijving
GET	`https://api.forsuppliers.com/v1/suppliers`	Ontvang een lijst met alle leveranciers
GET	`https://api.forsuppliers.com/v1/suppliers/:id`	Ontvang een specifieke leverancier
GET	`https://api.forsuppliers.com/v1/suppliers/kvk/:kvk`	Ontvang een specifieke leverancier
GET	`https://api.forsuppliers.com/v1/doesnotapply/:id`	Ontvang van specifieke leverancier N.V.T gegevens
GET	`https://api.forsuppliers.com/v1/comments/:id`	Ontvang van specifieke leverancier de opmerkingen
GET	`https://api.forsuppliers.com/v1/storage?_path=:path`	Ontvang een specifiek document
GET	`https://api.forsuppliers.com/v1/invites`	Ontvang een lijst met alle uitnodigingen
POST	`https://api.forsuppliers.com/v1/invites`	Verstuur een uitnodiging
GET	`https://api.forsuppliers.com/v1/invite/:id`	Ontvang een specifieke uitnodiging
GET	`https://api.forsuppliers.com/v1/minidataset?_kvk=:kvk`	Haal een mini dataset op

Leveranciers

Ontvang alle leveranciers die overeenkomen met de parameters. U kunt hier meer lezen over parameters.

GET https://api.forsuppliers.com/v1/suppliers

Leverancier

Ontvang een leverancier via de id.

GET https://api.forsuppliers.com/v1/suppliers/0000-0000-0000-0000

Leverancier N.V.T

Ontvang van specifieke leverancier N.V.T gegevens

GET https://api.forsuppliers.com/v1/doesnotapply/0000-0000-0000-0000

Response

{
    "data": {
        "g_rekening": bool,
        "wka": bool,
        "avb": bool,
        "wam": bool,
        "safety_ladder": bool,
        "if_rate_2020": bool,
        "if_rate_2021": bool,
        "if_rate_2022": bool,
        "co2_certificate": bool,
        "mvo_certificate": bool,
        "pso_certificate": bool,
        "fsc_certificate": bool,
        "ohsas18001_certificate": bool,
        "iso9001_certificate": bool,
        "iso14001_2015_certificate": bool,
        "iso19650_1_certificate": bool,
        "iso19650_2_certificate": bool,
        "iso19650_3_certificate": bool,
        "iso45001_certificate": bool,
        "iso55001_certificate": bool,
        "iso27001_certificate": bool,
        "vca_certificate": bool,
        "vca_diploma": bool,
        "tool_operator_certificate": bool,
        "ecm_certificate": bool,
        "tcvt_certificate": bool,
        "speno_certificate": bool,
        "workplace_security_certificate": bool,
        "security__a__b_certificate": bool,
        "ckb_certificate": truebool
        "brl_sikb100": bool,
        "brl_sikb1000": bool,
        "brl_sikb2000": bool,
        "brl_sikb6000": bool,
        "brl_sikb7000": bool,
        "brl_sikb11000": bool,
        "brl_sikb12000": bool,
        "average_annual_revenue": bool
    ]
}

Leverancier opmerkingen

Ontvang van specifieke leverancier de opmerkingen

GET https://api.forsuppliers.com/v1/comments/0000-0000-0000-0000

Response

{
    "data": {
        "client_comments": string,
        "forsuppliers_comments": string,
    ]
}

Document

Ontvang een document via de path.

GET https://api.forsuppliers.com/v1/storage?_path=business/000000000000000.pdf

Uitnodigingen

Ontvang een lijst met alle uitnodigingen

GET https://api.forsuppliers.com/v1/invites

Response

{
    "meta": {
        "total": int,
        "current_page": int,
        "last_page": int,
        "per_page": int,
    },
    "data": [{
        "id": string,
        "kvk": string,
        "title": string
        "email": string
        "phone_number": string
        "profile": string
        "client_attachment": string
        "accepted": boolean|null
        "accepted_by": string,
        "created_at": datetime
    }]
}

Uitnodiging

Ontvang een specifieke uitnodiging

GET https://api.forsuppliers.com/v1/invite/0000-0000-0000-0000

Response

{
    "data": {
        "id": string,
        "kvk": string,
        "title": string
        "email": string
        "phone_number": string
        "profile": string
        "client_attachment": string
        "accepted": boolean|null
        "accepted_by": string,
        "created_at": datetime
    }
}

Uitnodigingen vesturen

Verstuur uitnodigingen

POST https://api.forsuppliers.com/v1/invites

Body

Om uitnodigingen te versturen gebruik je de volgende request: application/x-www-form-urlencoded met values.

_invites[0][title] Bedrijfsnaam

_invites[0][kvk] KVK nummer

_invites[0][email] Het e-mailadres waarnaar de uitnodiging verstuurd wordt

_invites[0][profile] Naam van het profiel

attachment het bestand

Meerdere uitnodigingen tegelijk versturen

U kunt meerdere uitnodigingen tegelijk versturen. Hiervoor verzend je meerdere keren de request, het enige wat wordt vervangen is het nummer.

Voorbeeld

_invites[1][title]

_invites[1][kvk]

_invites[1][email]

_invites[1][profile]

Mini dataset

Haal een mini dataset op, op basis van het KvK-nummer.

GET https://api.forsuppliers.com/v1/minidataset?_kvk=0000000

U kunt ook het opgegeven IBAN laten controleren, gebruik hiervoor de _iban parameter.

GET https://api.forsuppliers.com/v1/minidataset?_kvk=0000000&_iban=NL00AAAA0000000000

Response

{
    "kvk": {
        "company_name": string,
        "trade_names": string,
        "kvk": string,
        "rsin": string,
        "location_number": string",
        "legal_form": string,
        "sbi_main": string,
        "sbi_sub": string,
        "website": string,
        "business_address": {
            "street": string,
            "number": string,
            "zip_code": string,
            "place": string
        },
        "correspondence_address": {
            "street": string,
            "number": string,
            "zip_code": string,
            "place": string
        }
    },
    "iban": {
        "iban_valid": boolean,
        "company_name_valid": boolean,
        "company_name_known": string
    }
}

Parameters

Pages

Als u de volgende pagina met leveranciers wilt ophalen, gebruikt u _page.

GET https://api.forsuppliers.com/v1/suppliers?_page=1

Filters

U kunt eenvoudig filters doorgeven met de parameter _where.

Filters worden gebruikt als achtervoegsel van een veldnaam:

Filters	Beschrijving
`eq`	Gelijk
`ne`	Niet gelijk
`lt`	Kleiner dan
`gt`	Groter dan
`lte`	Kleiner dan of gelijk aan
`gte`	Groter dan of gelijk aan

Voorbeeld

Zoek naar leveranciers die `00000000` als KvK-nummer hebben.

GET https://api.forsuppliers.com/v1/suppliers?_where[kvk]=00000000 of GET https://api.forsuppliers.com/v1/suppliers?_where[kvk.eq]=00000000

GET https://api.forsuppliers.com/v1/suppliers?_where[wka-date_of_manufacture]=1970-01-01 of GET https://api.forsuppliers.com/v1/suppliers?_where[wka-date_of_manufacture.eq]=1970-01-01

Meerdere

GET https://api.forsuppliers.com/v1/suppliers?_where[0][vat_number.eq]=NL000000000B00&_where[0][kvk.eq]=00000000

Complex zoeken

`AND` operator

De filtering ondersteunt impliciet de AND filter bij het specificeren van een reeks expressies in de filtering.

Voorbeeld

Leverancier dat kvk 00000000 heeft en vat_number NL000000000B00

GET https://api.forsuppliers.com/v1/suppliers?_where[0][kvk]=00000000&_where[1][vat_number]=NL000000000B00

`OR` operator

Om het OR filter gebruiken, moet u het filter _or gebruiken en een reeks expressies opgeven waarop de bewerking moet worden uitgevoerd.

Voorbeeld

Leveranciers dat kvk 000000 heeft of vat_number NL000000000B00

GET https://api.forsuppliers.com/v1/suppliers?_where[_or][0][kvk]=00000000&_where[_or][1][vat_number]=NL000000000B00

Sort

Sorteer op een specifiek veld.

Voorbeeld

Sorteer leveranciers op het KvK-nummer.

ASC: GET https://api.forsuppliers.com/v1/suppliers?_sort=kvk:asc
DESC: GET https://api.forsuppliers.com/v1/suppliers?_sort=kvk:desc

Sorteren op meerdere velden

GET https://api.forsuppliers.com/v1/suppliers?_sort=kvk:asc,vat_number:desc

Limit

Beperk de grootte van het resultaat

Standaard is 10

Maximaal is 50

Voorbeeld

Beperk de lengte van het resultaat tot 30.

GET https://api.forsuppliers.com/v1/suppliers?_limit=30

Fields

Om specifieke velden op te halen kunt u gebruik maken van _fields.

Veld	Code	Waardes
ID	`id`	`string`
Bedrijfsnaam	`company_name`	`string`
Status	`status`	`string ("Gevalideerd incompleet", "Gevalideerd compleet", "In behandeling")`
Commercieel actief	`commercially_active`	`string ("Ja", "Failliet", "Uitgeschreven")`
KVK nummer	`kvk`	`string`
RSIN	`rsin`	`string`
Handelsnamen	`trade_names`	`string`
Rechtsvorm	`legal_form`	`string`
Vestigingsnummer	`location_number`	`string`
BTW nummer	`vat_number`	`string`
Is dit BTW nummer gelijk aan het BTW nummer op de factuur?	`vat_number_equal_to_invoices`	`string`
SBI hoofdbranche	`sbi_main`	`string`
SBI subbranche	`sbi_sub`	`string`
Algemeen telefoonnummer	`general_telephone_number`	`string`
Website	`website`	`string`
Algemeen e-mailadres	`general_email`	`string`
E-mailadres voor bestellingen en orders	`orders_email`	`string`
Global Location Number (GLN)	`gln`	`string`
Vestigingsadres	`business_address`	`{ "street": string, "number": string, "zip_code": string, "place": string }`
Correspondentieadres	`correspondence_address`	`{ "street": string, "number": string, "zip_code": string, "place": string }`
Contactpersoon commercieel	`commercials_contact`	`{ "name": string, "job": string, "email": string, "telephone_number": string }`
Contactpersoon administratief	`administrative_contact`	`{ "name": string, "email": string, "telephone_number": string }`
Contactpersoon VGM	`vgm_contact`	`{ "name": string, "email": string, "telephone_number": string }`
Kernactiviteiten	`core_activities`	`string`
Nevenactiviteiten	`side_activities`	`string`
Type opdrachtgever(s)	`type_of_clients`	`string`
Gemiddeld aantal medewerkers	`average_number_of_employees`	`string`
Percentage ingeleende medewerkers t.o.v. vaste medewerkers	`percentage_of_hired_employees`	`string`
IBAN rekeningnummer	`iban`	`string`
Tenaamstelling IBAN	`ascription_iban`	`string`
IBANS	`ibans`	`[{ "iban": string, "ascription": string }]`
Maakt u gebruik van factoring?	`iban_factoring`	`boolean`
Staat de WKA verklaring op een andere bedrijfsnaam?	`wka_different_company_name`	`string`
G-rekening	`g_rekening`	`{ "iban": string, "ascription": string, "agreement_number": string,` `"agreement": string`, `"payroll_tax_number": string`, `"different_company_name": string }`
WKA betalingsgedrag	`wka`	`{ "date_of_manufacture": date, "sort": string \|\| null ("Ketenaansprakelijkheid", "Inlenersaansprakelijkheid", "Fiscale Verplichtingen"), "file": string, }`
Verklaring betalingsgedrag ketenaansprakelijkheid	`chain_liability`	`{ "date_of_manufacture": date, "sort": string ("Ketenaansprakelijkheid"), "file": string, }`
Verklaring betalingsgedrag inlenersaansprakelijkheid	`hirers_liability`	`{ "date_of_manufacture": date, "sort": string ("Inlenersaansprakelijkheid"), "file": string, }`
Betalingsgedrag nakoming fiscale verplichtingen	`tax_obligation`	`{ "date_of_manufacture": date, "sort": string ("Fiscale Verplichtingen"), "file": string, }`
Gemiddelde jaaromzet	`average_annual_revenue`	`string`
AVB	`avb`	`{ "valid_until": date, "policy": string }`
Maatschappij	`insurance_company`	`string`
Verzekerd bedrag per aanspraak	`insured_amount_per_claim`	`string`
Hoogte eigen risico	`amount_of_deductible`	`string`
WAM	`wam`	`{ "valid_until": date, "policy": string }`
Veiligheidsdoelstelling	`safety_objective`	`string`
Veiligheidsladder	`safety_ladder`	`{ "valid_until": date, "step": string \|\| null ("SCL Trede 5", "SCL Trede 4", "SCL Trede 3", "SCL Trede 2", "SCL Trede 1", "SCL Light Trede 5", "SCL Light Trede 4", "SCL Light Trede 3", "SCL Light Trede 2", "SCL Light Trede 1", "Approved Self Assessment", "Eigen verklaring / Offerte"), "certificate": string }`
IF Rate	`if_rate`	`{ "last_year": string, "two_years_ago": string, "three_years_ago": string }`
Eindverantwoordelijk voor veiligheid	`responsible_for_safety`	`string`
Omschrijving toezicht	`description_of_safety_supervision`	`string`
KvK uittreksel	`kvk_extract`	`{ "date_of_manufacture": date, "file": string }`
Briefpapier	`writing_paper`	`{ "file": string }`
WAADI geregistreerd	`waadi_registration`	`{ "exist": boolean }`
SNA gecertificeerd	`sna_certificate`	`{ "exist": boolean, "sort": string \|\| null ("Ter beschikking stelling van arbeid", "Aanneming van werk", "Beide") }`
CO2 Prestatieladder	`co2_certificate`	`{ "valid_until": date, "step": string \|\| null ("Niveau 5", "Niveau 4", "Niveau 3", "Niveau 2", "Niveau 1"), "file": string }`
MVO Prestatieladder	`mvo_certificate`	`{ "valid_until": date, "step": string \|\| null ("Niveau 5", "Niveau 4", "Niveau 3", "Niveau 2", "Niveau 1"), "file": string }`
PSO Prestatieladder	`pso_certificate`	`{ "valid_until": date, "step": string \|\| null ("Trede 3", "Trede 2", "Trede 1", "Aspirant-status"), "file": string }`
VCA Certificaat	`vca_certificate`	`{ "valid_until": date, "step": string \|\| null ("VCA", "VCA*", "VCA-P", "VCU"), "file": string }`
VCA Diploma	`vca_diploma`	`{ "valid_until": date, "step": string \|\| null ("Basis", "VOL"), "file": string }`
FSC	`fsc_certificate`	`{ "valid_until": date, "file": string }`
OHSAS 18001	`ohsas18001_certificate`	`{ "valid_until": date, "file": string }`
ISO 9001	`iso9001_certificate`	`{ "valid_until": date, "file": string }`
ISO 14001:2015	`iso14001_2015_certificate`	`{ "valid_until": date, "file": string }`
ISO 19650-1	`iso19650_1_certificate`	`{ "valid_until": date, "file": string }`
ISO 19650-2	`iso19650_2_certificate`	`{ "valid_until": date, "file": string }`
ISO 19650-3	`iso19650_3_certificate`	`{ "valid_until": date, "file": string }`
ISO 45001	`iso45001_certificate`	`{ "valid_until": date, "file": string }`
ISO 55001	`iso55001_certificate`	`{ "valid_until": date, "file": string }`
ISO 27001	`iso27001_certificate`	`{ "valid_until": date, "file": string }`
Gereedschapsmachinist	`tool_operator_certificate`	`{ "valid_until": date, "file": string }`
ECM	`ecm_certificate`	`{ "valid_until": date, "file": string }`
TCVT	`tcvt_certificate`	`{ "valid_until": date, "file": string }`
SPENO	`speno_certificate`	`{ "valid_until": date, "file": string }`
Werkplekbeveiliging	`workplace_security_certificate`	`{ "valid_until": date, "file": string }`
Veiligheidsattest A/B	`security__a__b_certificate`	`{ "valid_until": date, "file": string }`
CKB	`ckb_certificate`	`{ "valid_until": date, "file": string }`
BRL SIKB 100	`brl_sikb100`	`{ "valid_until": date, "file": string }`
BRL SIKB 1000	`brl_sikb1000`	`{ "valid_until": date, "file": string }`
BRL SIKB 2000	`brl_sikb2000`	`{ "valid_until": date, "file": string }`
BRL SIKB 6000	`brl_sikb6000`	`{ "valid_until": date, "file": string }`
BRL SIKB 7000	`brl_sikb7000`	`{ "valid_until": date, "file": string }`
BRL SIKB 11000	`brl_sikb11000`	`{ "valid_until": date, "file": string }`
BRL SIKB 12000	`brl_sikb12000`	`{ "valid_until": date, "file": string }`
Vestigingen	`locations`	`{ "name": string, "number": string "address": { "number": string, "place": string "street": string "zip_code": string }, "commercials_contact": { "name": string, "job_title": string "email": string "telephone_number": string } }`

Voorbeeld

Ontvang specifieke bedrijfsnamen

GET https://api.forsuppliers.com/v1/suppliers?_fields=company_name

GET https://api.forsuppliers.com/v1/suppliers/0000-0000-0000-0000?_fields=company_name

Meerdere

GET https://api.forsuppliers.com/v1/suppliers?_fields=kvk,company_name,business_address

GET https://api.forsuppliers.com/v1/suppliers/0000-0000-0000-0000?_fields=kvk,company_name,business_address

API Documentatie

Autorisatie

Endpoints

Endpoints

Leveranciers

Leverancier

Leverancier N.V.T

Leverancier opmerkingen

Document

Uitnodigingen

Uitnodiging

Uitnodigingen vesturen

Body

Meerdere uitnodigingen tegelijk versturen

Mini dataset

Parameters

Pages

Filters

Voorbeeld

Zoek naar leveranciers die 00000000 als KvK-nummer hebben.

Meerdere

Complex zoeken

AND operator

OR operator

Sort

Voorbeeld

Sorteer leveranciers op het KvK-nummer.

Sorteren op meerdere velden

Limit

Voorbeeld

Beperk de lengte van het resultaat tot 30.

Fields

Voorbeeld

Ontvang specifieke bedrijfsnamen

Meerdere

Zoek naar leveranciers die `00000000` als KvK-nummer hebben.

`AND` operator

`OR` operator