General Description

HTTP method	API version
PUT	v1

Don’t forget to put the Authorization field in the header

API Path: /Payments/{id}

You make this API call with the key field id as the path parameter (the id of the Payment you want to update)

Fields

The following fields are available:

Field Name	Type
id	Number
paymentaccount_id	Number
paymentaccount_nr	String
paymentaccount_name	String
amount	Number
iban	String
bic	String

/Payments/{id}

If everything succeeds the HTTP response status is 200
(200 OK)

If there is something wrong with the request, the response status and code is 400
(400 Bad Request)

If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)

If you forget to send the Authorization, the response status is 401
(401 Unauthorized)

If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)

For an explanation of all possible errors, please consult our section on possible answers to API calls here

Examples:

https://ra.bouwsoft.be/api/v1/Payments/863

with the following parameters :

Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: UbOfWxfrDkzSfIIIrfzRqDlIfDlrGfjVflbbzbPtflmfAGAPkA

Query Parameters :
ParameterName: columns, ParameterValue: amount=–50,paymentaccount_id=1,iban=’BE38750608132972’

Success gives statuscode 200 And the following result

{“RecordChanges”: [
  {
    "id": 863,
    "paymentaccount_id": 1,
    "paymentaccount_nr": "BE67 0013 3231 34 87",
    "paymentaccount_name": "Use IT Group NV",
    "amount": –50.0,
    "iban": "BE38750608132972",
    "bic": "AXAB BE 22"
  }
]
}