Factuurbetalingen

Authenticatie vereist

Met deze resource is het mogelijk factuurbetalingen voor facturen te beheren

Laatste update: 29-06-2016

Resource mogelijkheden

HTTP Request Type Resource Type Vereisten Rechten
POST Collectie Invoices.payments
GET Element
POST Element
DELETE Element

Velden

Veld Beschrijving Zichbaar Aanpasbaar Vereist bij aanmaken
id Het indificatie nummer van de factuurbetaling. Ja Nee Nee
invoice_id Een geldig en bestaand factuur id. Ja Ja Ja
type
  1. Overboeking
  2. Automatische incasso
  3. Contant
  4. Creditcard
  5. Creditfactuur
  6. iDEAL
  7. PayPal
  8. Pin betaling
  9. Stornering
  10. Betalingsverschil
 Ja Ja Ja
amount Standaard waarde: 1 Ja Ja Nee
created   Ja Nee Nee
modified   Ja Nee Nee
date   Ja Ja Nee
memo   Ja Ja Nee

Collectie POST

POST Collectie

Een POST request op de collectie zal resulteren in het aanmaken van een nieuw element.

https://api.workspace.nl/api/v1/invoicepayments.json

Let op

Bij een POST Request via het HTTP protocol wordt de header Content-Type: application/x-www-form-urlencoded verwacht.

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
POST 400 Bad Request Something went wrong while saving the data.

ELEMENT GET

GET Element

Een GET request op het element zal resulteren op een enkele factuur betaling.

https://api.workspace.nl/api/v1/invoicepayments/{id}.json
Parameters
{id} Het indentificatie nummer van de factuur betaling in formaat (0-9)
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "InvoicePayment": {
                "id": "17348",
                "invoice_id": "270",
                "type": "6",
                "amount": "10000",
                "created": "2015-05-15 11:31:03",
                "modified": "2015-05-15 11:31:03",
                "date": null,
                "memo": null
            }
        }
    }
}

ELEMENT POST

POST Element

Een POST request op het element zal resulteren in het aanpassen van het element. Alleen specifieke velden zijn aanpasbaar.

https://api.workspace.nl/api/v1/invoicepayments/{id}.json
Parameters
{id} Het indentificatie nummer van de factuur betaling in formaat (0-9)

Let op

Bij een POST Request via het HTTP protocol wordt de header Content-Type: application/x-www-form-urlencoded verwacht.

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
POST 400 Bad Request Something went wrong while saving the data.
POST 404 Not Found Invoicepayment not found.

ELEMENT DELETE

DELETE Element

Een DELETE request op het element zal resulteren in het verwijderen van het element.

https://api.workspace.nl/api/v1/invoicepayments/{id}.json
Parameters
{id} Het indentificatie nummer van de factuur betaling in formaat (0-9)

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
DELETE 404 Not Found Invoicepayment not found.