Items uit het domein “Suppliers” stellen leveranciers voor. Leveranciers worden automatisch aangemaakt bij het ontvangen van aankoopfacturen via Peppol. Het aanpassen van leveranciers is niet mogelijk.
URL opbouw
- Alle leveranciers:
GET /api/v1/suppliers/{supplier_id} - Specifieke leverancier:
GET /api/v1/suppliers/{supplier_id}
Velden
| Veldnaam | Type | Beschrijving | Voorbeeld |
| supplier_id | int | Uniek ID van de leverancier. | 5 |
| uri | text | URL naar de leverancier. Te gebruiken bij het aanspreken van de leverancier via de API | /api/v1/suppliers/5 |
| name | text | Naam van de leverancier | Proximus NV |
| vat_number | text | BTW-nummer van de leverancier | BE0202239951 |
| company_id | text | Ondernemingsnr van de leverancier | 0202239951 |
| street | text | Straatnaam en nummer van de leverancier | Olifantstraat 200 |
| city | text | Stad waar de leverancier is gevestigd | Gent |
| postal_code | text | Postcode van de leverancier | 9000 |
| country_code | text | Landcode van het land waar de leverancier is gevestigd. 2-letter landcode. | BE |
| iban | text | IBAN van de leverancier | BE36735049236881 |
| email_address | text | E-mailadres van de leverancier | my@domain.com |
| phone_number | text | Telefoonnummer van de leverancier | (Leeg) |
| created | date | Datum waarop de leverancier is aangemaakt. Formaat YYYY-MM-DD | 2024-08-30 |
| references | list | Lijst van referenties gerelateerd aan de leverancier | - |
Voorbeeld in JSON:
{
"supplier_id": 5,
"uri": "https://.../api/v1/suppliers/5",
"name": "Telenet BV",
"vat_number": "BE0719379912",
"company_id": "BE0719379912",
"street": "Olifantstraat 200",
"postal_code": "9000",
"city": "Gent",
"country_code": "BE",
"iban": "BE36735049236881",
"email_address": "my@domain.com",
"phone_number": "",
"created": "2024-11-11",
"references": [
{
"type": "peppol",
"value": "0208:BE0719379912"
}
]
}