This API call is used to get fields of a(n) Payment(s)

HTTP method	API version
GET	v1

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

API Path: /Payments/
or
API Path: /Payments/{id}

You can make this API call:
* without the key field id to get a list of Payments
* with the key field id as the path parameter (the specific id of the Payment you want to get)

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 200
(200 OK)

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

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

with the following parameters :

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

Query Parameters :
ParameterName: limit, ParameterValue: 5
ParameterName: sort, ParameterValue: id

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/805”, “Records”: [
  {
    "id": 1,
    "purchaseinvoice_id": 60,
    "purchaseinvoice_nr": "20120041",
    "salesinvoice_id": 0,
    "salesinvoice_type": "",
    "salesinvoice_nr": 0,
    "address_id": 15895,
    "address_name": "AB ELECTRO",
    "paymentaccount_id": 0,
    "paymentaccount_nr": "",
    "paymentaccount_name": "",
    "date": "2018–06–20",
    "amount": 101.0,
    "paymentmethod": "Overschrijving",
    "paymentmethod_localized": "Bank transfer",
    "advance": false,
    "iban": "",
    "bic": "",
    "note": "test",
    "docnr": "abc12",
    "statementnr": "001",
    "externalcode": "",
    "externalsource": 0,
    "ts_lastupdate": "2024–05–23 09:58:45"
  },
  {
    "id": 2,
    "purchaseinvoice_id": 0,
    "purchaseinvoice_nr": "",
    "salesinvoice_id": 6566,
    "salesinvoice_type": "FAKTUUR",
    "salesinvoice_nr": 201814018,
    "address_id": 0,
    "address_name": "",
    "paymentaccount_id": 0,
    "paymentaccount_nr": "",
    "paymentaccount_name": "",
    "date": "2018–06–20",
    "amount": 0.0,
    "paymentmethod": "",
    "paymentmethod_localized": "",
    "advance": false,
    "iban": "",
    "bic": "",
    "note": "",
    "docnr": "456",
    "statementnr": "001",
    "externalcode": "",
    "externalsource": 0,
    "ts_lastupdate": "2024–05–23 09:58:45"
  }
,
…
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue: purchaseinvoice_id eq 918

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 887,
    "purchaseinvoice_id": 918,
    "purchaseinvoice_nr": "202000130",
    "salesinvoice_id": 0,
    "salesinvoice_type": "",
    "salesinvoice_nr": 0,
    "address_id": 328961,
    "address_name": "DirkAPISupp",
    "paymentaccount_id": 0,
    "paymentaccount_nr": "",
    "paymentaccount_name": "",
    "date": "2025–06–12",
    "amount": –167.25,
    "paymentmethod": "",
    "paymentmethod_localized": "",
    "advance": false,
    "iban": "",
    "bic": "",
    "note": "",
    "docnr": "",
    "statementnr": "",
    "externalcode": "",
    "externalsource": 0,
    "ts_lastupdate": "2025–06–12 12:17:26"
  }
]
}

/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/887

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 887,
    "purchaseinvoice_id": 208,
    "purchaseinvoice_nr": "20160041",
    "salesinvoice_id": 0,
    "salesinvoice_type": "",
    "salesinvoice_nr": 0,
    "address_id": 18942,
    "address_name": "Spike Needle",
    "paymentaccount_id": 1,
    "paymentaccount_nr": "BE67 0013 3231 34 87",
    "paymentaccount_name": "Use IT Group NV",
    "date": "2025–06–12",
    "amount": –50.0,
    "paymentmethod": "",
    "paymentmethod_localized": "",
    "advance": false,
    "iban": "BE38750608132972",
    "bic": "AXAB BE 22",
    "note": "",
    "docnr": "",
    "statementnr": "",
    "externalcode": "",
    "externalsource": 0,
    "ts_lastupdate": "2025–06–12 12:19:56"
  }
]
}