Resources¶
AccelerateConnect knows quite a few resources. All of them are listed here below.
Dossier¶
| Field | Type | Description |
|---|---|---|
| id | string | Dossier id |
| code | string | The public dossier number |
| date_created | date | When the dossier was created |
| owner | Person | The owner of the dossier |
| advisor | Person | The advisor of the dossier |
| products | Product [] | All products associated with this dossier |
Consumer¶
| Field | Type | Description |
|---|---|---|
| id | string | Consumer id |
| gender | enum(‘M’,’F’) | Male / Female |
| initials | string | |
| firstname | string | |
| prefix | string | |
| surname | string | |
| display_name | string | How the consumer is presented in the system |
| streetname | string | |
| housenumber | int | |
| housenumber_addition | string | |
| zipcode | string | 1234AB |
| city | string | |
| phone | string | 000 123 45 678 |
| phone_mobile | string | 06 123 456 78 |
| emailaddress | string | Preferred email address |
Person¶
| Field | Type | Description |
|---|---|---|
| name | string | Full person name |
| phone | string | 000 123 45 678 |
| emailaddress | string | info@example.com |
| avatar_base64 | string | A small base64 encoded image (JPG, PNG, BMP) |
Product¶
| Field | Type | Description |
|---|---|---|
| id | string | Product id |
| type | Product types | See Product types for a list of options |
| label | string | Product label |
| reference_number | string | This field contains “Aanvraagvolgnummer” |
| quote_number | string | |
| <productType> | <productType> | Based on the given productType |
| product_actions | ProductAction [] | A list of actions to be completed by the consumer |
Product types¶
We currently support the following product types.
Mortgage¶
| Field | Type | Description |
|---|---|---|
| label | string | Mortgage label |
| arrangement | string | |
| mortgage_amount | string | The total mortgage amount |
| lender_name | string | The lender that provides the mortgage |
| has_timeline | bool | Whenever this mortgage provides a HTML based timeline |
| rendered_timeline | string | A fully rendered in HTML timeline |
Credit¶
| Field | Type | Description |
|---|---|---|
| lender_name | string | Lender name |
| product_name | string | Product name |
| date_entry | date | |
| loan_amount | string | Total loan amount |
| spending_target | string | |
| aflos_amount | string | Amount |
| aflos_period | string | Period label displayed as “per kwartaal”, “per jaar”, etc |
| aflos_percentage | string | Percentage label displayed as “2,5 %” |
Appointment¶
| Field | Type | Description |
|---|---|---|
| label | string | Appointment label |
| date | date | Date of the appointment |
| time | time | Time of the appointment |
| time_end | time | End time of the appointment |
| type | string | Type of the appointment (e.g. “Oriënterend gesprek”) |
| is_passed | bool | Has the appointment already taken place |
| location | string | Address info |
WLV¶
| Field | Type | Description |
|---|---|---|
| label | string | Label of the product type |
| status | string | Status |
| insurer_name | string | Name of the insurer |
FGV¶
| Field | Type | Description |
|---|---|---|
| label | string | Label of the product type |
| status | string | Status |
| insurer_name | string | Name of the insurer |
Life insurance¶
| Field | Type | Description |
|---|---|---|
| label | string | Label of the product type |
| status | string | Status |
| insurer_name | string | Name of the insurer |
Bank guarantee¶
| Field | Type | Description |
|---|---|---|
| label | string | Label of the product type |
| status | string | Status |
| insurer_name | string | Name of the insurer |
OTD¶
| Field | Type | Description |
|---|---|---|
| label | string | “OTD” or “OTD inzake service_name / subservice_name” |
| sub_total | string | Total worth of the OTD |
| service_name | string | Chosen service |
| subservice_name | string | Chosen subservice |
ProductAction¶
Each productaction exist out of these fields:
| Field | Type | Description |
|---|---|---|
| id | string | Product action id |
| product_id | string | Where this action belongs to |
| label | string | Label for this product action |
| date_created | date | When this action was created |
| date_executed | date | When this action was executed by the consumer |
| is_done | int(1) | If this product action has been completed by the consumer (1 = true, 0 = false) |
| type | ActionType | All action types Accelerate has |
| comment | string | Comment provided by the dossier owner |
| document | Document | The document where this action needs to be performed |
ActionType¶
Productactions are divided by TYPE, the following types are available;
DOWNLOAD_DOCUMENTMANAGEMENT_FILEProductaction which asks the consumer to download a specific document. UPLOAD_DOCUMENTMANAGEMENT_FILEProductaction which asks the consumer to upload a specific document. REUPLOAD_DOCUMENTMANAGEMENT_FILEProductaction which asks the consumer to re-upload a specific document because the previous document was declined. DOWNLOAD_QUOTEProductaction which asks the consumer to download a quote (mostly; HDN OX quotes). SIGN_OTDProductaction which asks the consumer to sign an OTD provided by the advisor.
Document¶
| Field | Type | Description |
|---|---|---|
| upload_requirements | string[] | When the product action is an upload this will list hold a list of requirements the consumer needs to respect |
| label | string | Label of the document (e.g. “Geldig legitimatiebewijs”) |
| is_hdn_type | bool | Whenever this document is provided by HDN or manually uploaded |
| type_code | string | An code provided by HDN or an Accelerate code |
| description | string | A optional description |
| is_consumer_specific | bool | When the document is attached to a consumer |
| consumer_name | string | display_name of the consumer |
| comment | string | Comment from the advisor |
Quote¶
| Field | Type | Description |
|---|---|---|
| api_id | string | Quote id |
| date_received | date | When the quote was received |
| date_validity | date | Date before it will expire |
| property | string | |
| attachments | string[] | List of attachments |