Skip to main content
API docs by Redocly

Finbuddy WebAPI (v1)

The public Finbuddy WebAPI - BASEURL: 'https://finbuddy.nl/'

Customers

/webapi/customers

Authorizations:
X-API-KEY
query Parameters
page
integer <int32>
Default: 1
size
integer <int32>
Default: 50

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page": 0,
  • "size": 0,
  • "totalPages": 0,
  • "totalRecords": 0
}

/webapi/customers/{id}

Authorizations:
X-API-KEY
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page": 0,
  • "size": 0,
  • "totalPages": 0,
  • "totalRecords": 0
}

/webapi/customers/{id}/acknowledge

Authorizations:
X-API-KEY
path Parameters
id
required
integer <int32>
Request Body schema: application/json
newDebtCollectionDate
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "newDebtCollectionDate": "string"
}

Response samples

Content type
No sample

/webapi/customers/{id}/decline

Authorizations:
X-API-KEY
path Parameters
id
required
integer <int32>
Request Body schema: application/json
reason
required
string (DeclineReason)
Value: "NO_CUSTOMER"
message
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "reason": "NO_CUSTOMER",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "initials": "string",
  • "lastName": "string",
  • "email": "string",
  • "iban": "string",
  • "newDebtCollectionDate": "2019-08-24T14:15:22Z",
  • "address": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "phoneNumber": "string"
}

/webapi/customers/{id}/internalnote

Authorizations:
X-API-KEY
path Parameters
id
required
integer <int32>
Request Body schema: application/json
message
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "initials": "string",
  • "lastName": "string",
  • "email": "string",
  • "iban": "string",
  • "newDebtCollectionDate": "2019-08-24T14:15:22Z",
  • "address": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "phoneNumber": "string"
}