Prerequisites
You should have
- an user-account enabled for api access & CRM access
- an api-client
Dataset
Dataset "account"
Getting the accounts
Get a list of all saved accounts for a person
Request URL
https://{your hublify url}/api/eos_10/data_getList
Request parameter
{
"dataset": "account",
"filter": {
"fk_acc_persid": "1111" // this is the internal ID for the person these accounts belong to
}
}
Response
{
"data": [
{
"accid": "1", // this is the internal ID for the bank account
"fk_acc_persid": "1111", // this is the internal ID for the person these accounts belong to
"acc_type": "account", // "account" = bank account, it could also be e.g. "paypal"
"acc_xdata": { // the actual account-data
"iban": "1234567890", // IBAN
"accountowner": "", // (optional) account-owner
"bankname": "", // (optional) Name of the bank
"bic": "", // (optional) BIC
"dd_mref": "HfyDemoReferenz", // mandate reference - required for direct debit
"dd_mdate": "2021-09-01", // date the mandate was issued
"dd_use": 1, // is this the account that should be debited? 1 = yes
},
"acc_default": "0",
"acc_time_insert": "2021-09-23 20:45:33",
"acc_time_update": "2021-09-23 20:45:53",
"acc_time_deleted": null,
"personid": "KHFY000001",
}
],
}
Save a new account for a person
You can save multiple accounts for a person.
Request URL
https://{your hublify url}/api/eos_10/data_create
Request parameter
{
"dataset": "account",
"fields": {
"fk_acc_persid": "2",
"acc_type": "account",
"acc_xdata": {
"iban": "112233445566778890",
"dd_mref": "HfyDemoReferenz2",
"dd_mdate": "2021-09-21",
"dd_use": 1
}
}
}
Response
{
"status": true
}