Stap voor stap aan de slag met de Minox API

Hoe zet ik een API koppeling op tussen onze software en Minox?

Snel een Minox koppeling realiseren met de meest gebruikte endpoints in logische volgorde:

  1. Oauth: een voorbeeldproject hoe je connectie maakt met Oauth van Minox vind je hier: Minox client demo

  2. Token: Admin | /inspect/{token} kun je bekijken tot welke tenants de token je toegang geeft (een token van een accountantstenant geeft ook toegang tot de bedrijven met een eigen licentie waar de accountant toegang toe heeft)

  3. Lijst met administraties: Administration | /tenant/{tenant_id}/administration (geeft ook informatie over boekjaren, perioden en startdatum / einddatum)

  4. Lijst met grootboekrekeningen: Ledger| get /tenant/{tenant_id}/administration/{administration_id}/ledger_account

  5. Dagboek waar de journaalposten in moeten komen: Journal | Get

  6. Klant aanmaken: Master data - customer (zie voorbeeld create customer.json)

  7. Klant opvragen op emailadres of externalID of andere zoekcriteria: Master data - customer | Get

  8. Journaalpost boeken: transaction_line_batch | Put (zie voorbeeld Batch transaction_new.json voor een verkoopjournaalpost. Bij Minox kun je het beste niet werken met btw codes. De accountant / klant moet deze zelf goed instellen bij de grootboekrekeningen en dan werkt het voor jouw als koppelpartner automatisch goed)

  9. Openstaandeposten opvragen: financial - receivable | Get (status open)

  10. Openstaandeposten continue up-2-date houden: third party - webhook | Post → enige wat nodig is {"description": "string", "enabled": true, "url": "string", "retry_in_minutes": 120, "notifications": {"receivable": true, "payable": false}}. Hierna ontvang je op opgegeven url een update van de openstaande post als er een betaling in Minox wordt verwerkt.

Stap voor stap aan de slag met de Swagger Minox API documentatie:

  1. Ga naar Minox API Specification  

  2. Klik op Authorize (OAuth).

  3. Vink de voor de koppeling vereiste scopes aan en login als partner met uw partner client_id en client_secret.

  4. Log vervolgens in als klant met de Minox credentials om toestemming te geven voor gevraagde "scopes".

Na toestemming kun je eenvoudig de werking van de API proberen en bekijken hoe transacties in de Minox administratie landen. Hieronder laten we een voorbeeld zien: 

  • Klik op het administration endpoint en klik op "Try it out".

  • Geef in dit geval het Minox klantnummer op en je krijgt een lijst van administraties waar toegang toe nodig is terug.

Je kunt op deze manier ieder endpoint uitproberen en bijvoorbeeld bekijken hoe een journaalpost in Minox wordt weergegeven op basis van de input in de JSON. 

Voor het genereren van journaalposten zijn een aantal best practices opgesteld die je als ontwikkelaar helpen eenvoudig en onafhankelijk van de inrichting van Minox journaalposten in te schieten. Deze lichten we graag toe in het kennismakingsgesprek.

 

Voorbeeld batch transaction JSON:

Voorbeeld create customer JSON: