Betaalmethoden

Huidige versie: 1.1.0

Create

POST /api2/betaalmethoden

Maak een nieuwe betaalmethode

Voorbeeld request:

POST /api2/betaalmethoden HTTP/1.1
Host: demo.recras.nl
Accept: application/json

{
   "naam": "Cadeaubon",
}

Voorbeeld response:

HTTP/1.1 201 Created
Content-Type: application/json
Location: /api2/betaalmethoden/5

{
   "id": 5,
   "naam": "Cadeaubon",
   "weergeven_in_kassa": false,
   "bevestiging_mailen": false,
   "type": "manual",
   "is_deletable": true,
}

JSON Parameters:

• naam (string) – Verplicht Naam van de betaalmethode

• weergeven_in_kassa (boolean) – Of de betaalmethode zichtbaar is in de Recras-kassa of niet

• bevestiging_mailen (boolean) – Of er een bevestiging gemaild wordt naar de klant als er een betaling wordt gedaan met deze betaalmethode

• type (string) – “manual” for most payment methods, “accounting” for payments made through accounting software

• is_deletable (boolean) – Kan deze betaalmethode verwijderd worden? Dit is het geval indien er nog geen betalingen mee gedaan zijn

Response Headers:

• Location – De locatie van de nieuwe betaalmethode

Status Codes:

• 201 Created – Betaalmethode gemaakt

• 406 Not Acceptable – Fout in de invoer

• 403 Forbidden – Gebruiker heeft het recht editBetaalmethode niet

Read

GET /api2/betaalmethoden

De betaalmethoden in Recras

Voorbeeld request:

GET /api2/betaalmethoden HTTP/1.1
Host: demo.recras.nl
Accept: application/json

Voorbeeld response:

HTTP/1.1 200 OK
Content-Type: application/json

[
   {
      "id": 1,
      "naam": "iDeal",
      "weergeven_in_kassa": false,
      "bevestiging_mailen": true,
      "type": "manual",
      "is_deletable": false,
   },
   {
      "id": 2,
      "naam": "Accounting software",
      "weergeven_in_kassa": true,
      "bevestiging_mailen": false,
      "type": "accounting",
      "is_deletable": false,
   }
]

Request Headers:

• Authorization – mandatory Basic authentication

Status Codes:

• 200 OK – no error

GET /betaalmethoden/(int: id)

Een specifieke betaalmethode

Example request:

GET /api2/betaalmethoden/1 HTTP/1.1
Host: demo.recras.nl
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "id": 1,
   "naam": "iDeal",
   "weergeven_in_kassa": false,
   "bevestiging_mailen": true,
   "type": "manual",
   "is_deletable": false,
}

Request Headers:

• Authorization – mandatory Basic authentication

Status Codes:

• 200 OK – OK

• 404 Not Found – Geen betaalmethode met deze id

Update

PUT /api2/betaalmethoden/(int: id)

Voorbeeld request:

PUT /api2/betaalmethoden/5 HTTP/1.1
Host: demo.recras.nl
Accept: application/json

{
   "id": 5
   "naam": "Creditcard",
   "weergeven_in_kassa": false,
   "bevestiging_mailen": true,
   "type": "manual",
   "is_deletable": false,
}

Voorbeeld response:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "id": 5,
   "naam": "Creditcard",
   "weergeven_in_kassa": false,
   "bevestiging_mailen": true,
   "type": "manual",
   "is_deletable": false,
}

JSON Parameters:

• id (int) – ID-nummer, mag niet veranderd worden

• naam (string) – Naam van de betaalmethode

• weergeven_in_kassa (boolean) – Of de betaalmethode zichtbaar is in de Recras-kassa of niet

• bevestiging_mailen (boolean) – Of er een bevestiging gemaild wordt naar de klant als er een betaling wordt gedaan met deze betaalmethode

• type (string) – “manual” for most payment methods, “accounting” for payments made through accounting software

• is_deletable (boolean) – Kan deze betaalmethode verwijderd worden? Dit is het geval indien er nog geen betalingen mee gedaan zijn

Status Codes:

• 200 OK – Betaalmethode aangepast

• 406 Not Acceptable – Fout in de invoer

• 403 Forbidden – Gebruiker heeft het recht editBetaalmethode niet

Delete

DELETE /api2/betaalmethoden/(int: id)

Voorbeeld request:

DELETE /api2/betaalmethoden/5 HTTP/1.1
Host: demo.recras.nl

Voorbeeld response:

HTTP/1.1 200 OK

Status Codes:

• 200 OK – Betaalmethode verwijderd

• 403 Forbidden – Gebruiker heeft het recht editBetaalmethode niet