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

HTTP method	API version
GET	v1

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

API Path: /Transactions/
or

or
API Path: /Transactions/FieldInfo/

You can make this API call:
* without the key field id to get a list of Transactions
* with the key field id as the path parameter (the specific id of the Transaction you want to get)
* to request the FieldInfo for this call

Fields

The following fields are available:

Field Name	Type Name	Length	Required	Writeable	Force Write	Link
payment_id	tpLong	0	No	No	No
paymentaccount_id	tpLong	0	No	No	No
paymentaccount_nr	tpString	100	No	No	No
paymentaccount_name	tpString	150	No	No	No
date	tpDate	0	No	No	No
amount	tpCurrency	0	No	No	No
paymentmethod_id	tpString	0	No	No	No
paymentmethod	tpString	0	No	No	No
paymentmethod_localized	tpString	0	No	No	No
iban	tpString	35	No	No	No
bic	tpString	11	No	No	No
statementnr	tpString	50	No	No	No
docnr	tpString	50	No	No	No
note	tpString	0	No	No	No
notification	tpString	0	No	No	No
externalcode	tpString	250	No	No	No
externalsource	tpLong	0	No	No	No
ts_lastupdate	tpDate	0	No	No	No

/Transactions/

API Path: /Transactions/

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

/Transactions/FieldInfo

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/Transactions/FieldInfo

with the following parameters :

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

Success gives statuscode 200 And the following result

[
  {
    "name": "payment_id",
    "type_id": 1,
    "type_name": "tpLong",
    "length": 0,
    "required": false,
    "writeable": false,
    "forcewrite": false,
    "link": ""
  },
  {
    "name": "paymentaccount_id",
    "type_id": 1,
    "type_name": "tpLong",
    "length": 0,
    "required": false,
    "writeable": false,
    "forcewrite": false,
    "link": ""
  }
,
…
]