Belangrijke wijziging in API endpoint
Met ingang van 1 oktober 2023 zal de API basis-URL
veranderen van:
https://rompslomp.nl/api/vinaar:
https://api.rompslomp.nl/api/v1
Het nieuwe endpoint is al beschikbaar.
Wat moet je doen?
Pas zo snel mogelijk de basis-URL aan in je integraties zodat je API requests naar https://api.rompslomp.nl/api/v1 worden gestuurd.
Subresources
In dit artikel
Sommige endpoints staan het toe om subresources van een bestaande resource aan te maken, te bewerken en/of te verwijderen. Een factuur (sales_invoice) heeft bijvoorbeeld factuurregels (invoice_lines) waarvoor dit geldt.
Voorbeeld: subresources toevoegen
In dit voorbeeld worden twee factuurregels aan een bestaande factuur toegevoegd. Bestaande factuurregels blijven ongemoeid.
// PATCH /api/v1/companies/{company_id}/sales_invoices/{id}
{
"sales_invoice": {
"invoice_lines": [
{ "description": "Standaardwerk", "price_per_unit": "39.5", "quantity": "2" },
{ "description": "Maatwerk", "price_per_unit": "49.5", "quantity": "1" }
]
}
}
Voorbeeld: subresources bewerken
In dit voorbeeld worden twee factuurregels van een bestaande factuur aangepast. Overige bestaande factuurregels blijven ongemoeid.
// PATCH /api/v1/companies/{company_id}/sales_invoices/{id}
{
"sales_invoice": {
"invoice_lines": [
{ "id": 876544, "description": "Aangepaste omschrijving" },
{ "id": 987654, "quantity": "10" }
]
}
}
Voorbeeld: subresources verwijderen
In dit voorbeeld worden twee factuurregels van een bestaande factuur verwijderd. Overige bestaande factuurregels blijven ongemoeid.
// PATCH /api/v1/companies/{company_id}/sales_invoices/{id}
{
"sales_invoice": {
"invoice_lines": [
{ "id": 876543, "_destroy": true },
{ "id": 987653, "_destroy": true }
]
}
}
Gecombineerd voorbeeld
In dit voorbeeld wordt één factuurregel toegevoegd, één factuurregel aangepast en één factuurregel verwijderd met één request. Overige bestaande factuurregels blijven ongemoeid.
// PATCH /api/v1/companies/{company_id}/sales_invoices/{id}
{
"sales_invoice": {
"invoice_lines": [
{ "description": "Standaardwerk", "price_per_unit": "39.5", "quantity": "2" },
{ "id": 876544, "description": "Aangepaste omschrijving" },
{ "id": 876543, "_destroy": true }
]
}
}
