# dbd_debt_check

Name dbd_debt_check
Type panel
Version 1.0
Since 2020-01-01

# Prologue

Panels offers testing subject for debts, insolvencies and distraints from multiple registries. Client is charged for every request to the registries.

NOTE: In order to make this callback work properly, ensure you have following env variables properly set:

  • NETTE__EXTRAS__3RD__DBD__HOST
  • NETTE__EXTRAS__3RD__DBD__USER
  • NETTE__EXTRAS__3RD__DBD__PASS

Received result can be stored to result variable for later usage.

You can check subject for debts by

  • company ID
  • personal ID
  • personal firstName, lastName and date of birth

If some API error occurs, the error => TRUE, and error_message => string will be stored in result variable. If API returns valid response following fields will be stored in result variable:

  • error FALSE
  • error_message ''
  • xml (raw API response)
  • subject (the subject checked)
  • date_performed (when the check was performed)
  • is_debtor (boolean if subject has some record)
  • debt_count (number of debts found)
  • insolvency_count (number of insolvencies found)
  • distraint_count (number of distraints found)

# Preview

# Configuration

dbd_debt_check:
	render: {width: 6}
	config:

		# Optional - is used only when provided
		# May be Scalar or Json variable type if provided
		# Stores personal or company data
		#
		# When the variable type is scalar, it should contain CompanyID or PersonalID
		#
		# When the variable type is json, to pre-fill company a variable must contain `id` key
		# When the variable type is json, to pre-fill person a variable must contain `pin` key or `firstName`, `lastName` and `birthDate` keys
		# Form will be filled with these data if provided
		#
		# Examples:
		#  - scalar company: '76641040'
		#  - scalar person: '8703243422'
		#  - json company ['id' => '76641040',  ...]
		#  - json person ['pin' => '8703243422', ...]
		#  - json person ['firstName' => 'Michal', 'lastName' => 'Safry', 'birthDate' => '1976-06-05', ...]
		#
		subject: person

		# Optional - is used only when provided
		# Must be Json variable type if provided
		# When provided, results from registries will be stored to this variable
		# Stores result about subject debts to variable
		result: debt_result

		mode:
			# Optional | Default - company
			# Enum type, options: company, person, person_id
			# defines which form will be displayed by default
			default: person

			# Optional | Default - true
			# Boolean type
			# Whether to allow change of modes
			switch: true

		log:

			# Optional | Default - false
			# Boolean type
			# Whether the performed requests to registries should be logged on process wall
			wall: true

		# Optional | Default - null
		# If set, this price in CZK will be displayed in result table in row: "Price charged"
		price: 26

		ui:
			# Optional | Default - null
			# Panel title
			title: Check for debts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55