Menu

Samenvatting van de Paymo API

Met de Paymo API automatiseer je het volledige project-to-cash-proces: van projectaanmaak en taakplanning tot urenregistratie, facturatie en betaling. Elk resource-type uit de Paymo-app is via REST aanspreekbaar inclusief filters via de where-parameter en includes voor gerelateerde objecten.
  • Project- en taakbeheer: Volledige CRUD op projecten, tasklists, tasks, subtasks, milestones en project- en taak-templates inclusief recurring profiles.
  • Tijdregistratie en planning: Beheer time entries met start/stop-timer, bookings voor resource-scheduling en task-assignments per gebruiker.
  • Facturatie en betalingen: Genereer offertes, facturen en recurring invoice-profiles, registreer payments en hergebruik invoice- en estimate-templates.
  • Klanten en uitgaven: Synchroniseer clients, client-contacts en expenses met je CRM of boekhoudsysteem inclusief receipt-uploads.
  • Workflow en automatisering: Configureer workflows met statuses, abonneer op webhooks per event-type en gebruik wildcard-events voor bulk-monitoring.
API Quick Facts REST
  • Authenticatie API Key, Basic Auth
  • Methods GET (62)POST (37)PUT (23)DELETE (18)
  • Rate limits Dynamische limieten via X-Ratelimit-headers; bij overschrijding HTTP 429 met Retry-After
  • Webhooks Beschikbaar
  • Sandbox Niet beschikbaar
  • Response format JSON, XML
  • SDK's PHP

Laatste ontwikkelingen bij de Paymo API

Paymo lanceerde rond 2014 een REST API onder app.paymoapp.com/api met JSON- en XML-serialisatie en Basic auth via email of API-key. In 2016 zijn bookings (resource scheduling), recurring profiles voor invoices en taken en project-templates toegevoegd. Webhooks volgden in 2017 met events voor model.insert/update/delete op alle hoofd-objecten plus wildcard-support en HMAC-signatures. Daarna zijn workflows met workflow-statuses uitgebreid en werden estimate-templates, project-statuses en task-recurring-profiles toegevoegd. Paymo onderhoudt de officiële API-docs als open source repository op GitHub en publiceert daar ook changelogs en code samples.

API versies

Webhooks Major release
1 januari 2017

Webhooks-endpoints (/api/hooks) geïntroduceerd met events voor insert/update/delete op Client, Project, Task, Invoice, Entry, Booking en meer; inclusief wildcard-events en HMAC-signature-verificatie.

Bookings & recurring profiles Major release
1 januari 2016

Resource scheduling via bookings, recurring profiles voor invoices en taken, en project-templates toegevoegd.

REST API v1 Major release
1 januari 2014

Lancering van de publieke REST API onder app.paymoapp.com/api met JSON/XML, Basic auth met email of API-key en sessie-tokens via X-Session-header.