Direct naar inhoud

Aan de slag

Rechten en pakketfeatures

Welke endpoints beschikbaar zijn hangt af van het pakket van de organisatie. Overzicht per onderdeel.

Hoe het werkt

  • Pakketfeature: geldt voor elke sleutel. Zit de feature niet in het pakket, dan geeft het endpoint 403 met package_feature_unavailable.
  • Recht: een organisatie-API-sleutel heeft alle rechten. Dezelfde endpoints worden ook door de Factora-app gebruikt met een persoonlijke login; daar gelden de rechten van de rol van de gebruiker.
  • Limieten: pakketten kunnen een maximum hebben (bijvoorbeeld aantal klanten of facturen). Daarboven geeft aanmaken 422 met subscription_limit_reached.

Overzicht per onderdeel

OnderdeelPakketfeatureRechten
Hele APIapi—
Organisatie bijwerken—settings.manage
Klantencustomerscustomers.view, customers.manage
Automatisch factureren per klantautomatic_invoicingcustomers.manage
Factureninvoicesinvoices.view, invoices.manage
Facturen en offertes e-mailenautomatic_emailsinvoices.send, quotes.send
PDF downloadenpdf_exportinvoices.view, quotes.view
Offertesquotesquotes.view, quotes.manage
Offerte omzetten naar factuurquotes + invoicesquotes.manage + invoices.manage
Productenproductsproducts.view, products.manage
Klantabonnementensubscriptionssubscriptions.view, subscriptions.manage
Abonnementsperiode verwerkenautomatic_invoicingsubscriptions.manage
Rapportenreportsreports.view
Klantenportaalcustomer_portalcustomer_portal.manage
BoekhoudingAdministratie ingerichtadministration.view plus bookkeeping.*, bank.*, documents.*, vat.view
Webhooks (automatiseringen)webhooksBeheer van automatiseringen in de webapp

Vooraf controleren

Er is geen apart endpoint dat de features van het pakket opsomt. Vang 403 met package_feature_unavailable af en toon de gebruiker dat de functie een ander pakket vraagt; error.upgrade_url verwijst naar de pakketpagina.

Lees ook