General Description

HTTP method	API version
POST	v1

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

API Path: /Payments
or

Fields

The following fields are available:

Field Name	Type
id	Number
purchaseinvoice_id	Number
purchaseinvoice_nr	String
salesinvoice_id	Number
salesinvoice_type	String
salesinvoice_nr	Number
address_id	Number
address_name	String
paymentaccount_id	Number
paymentaccount_nr	String
paymentaccount_name	String
date	String
amount	Number
paymentmethod	String
paymentmethod_localized	String
advance	Boolean
iban	String
bic	String
note	String
docnr	String
statementnr	String
externalcode	String
externalsource	Number
ts_lastupdate	String

/Payments

API Path: /Payments/

If everything succeeds the HTTP response status is 201
(201 CREATED)

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

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

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: purchaseinvoice_id=208,amount=100.05

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 863,
    "purchaseinvoice_id": 208,
    "purchaseinvoice_nr": "20160041",
    "salesinvoice_id": 0,
    "salesinvoice_type": "",
    "salesinvoice_nr": 0,
    "address_id": 18942,
    "address_name": "Spike Needle",
    "paymentaccount_id": 0,
    "paymentaccount_nr": "",
    "paymentaccount_name": "",
    "date": "2025–02–12",
    "amount": 100.049999999999997,
    "paymentmethod": "",
    "paymentmethod_localized": "",
    "advance": false,
    "iban": "",
    "bic": "",
    "note": "",
    "docnr": "",
    "statementnr": "",
    "externalcode": "",
    "externalsource": 0,
    "ts_lastupdate": "2025–02–12 14:30:52"
  }
]
}