
Configuring Mutual as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Mutual option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
You’ll need to provide your Mutual credentials to allow Nekt to extract your data. The following configurations are available:- Access Token: The API access token for authentication.
- API Base URL: The base URL for the Mutual API endpoints.
2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.Tip: The stream can be found more easily by typing its name.Select the streams and click Next.
3. Configure data streams
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.- Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: The sync is always FULL_TABLE for Mutual sources.
- Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:- Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.Streams and Fields
The Mutual connector supports a wide range of streams, includingAssociated Person, Association Consultants, Contracts, Core Users, Events, Invoices, Quotations, Vehicles, and more. Below you’ll find details for some of the key data streams and their corresponding fields:
Contracts
Contracts
Stream for managing contracts.Key Fields:
| Field | Type | Description |
|---|---|---|
uuid | String | Unique identifier |
total_installment_value | Number | Total installment value |
total_accession_value | Number | Total accession value |
previous_consultant | String | Previous consultant |
previous_sales_team | String | Previous sales team |
previous_regional | String | Previous regional |
contract_negotion_type | String | Contract negotiation type |
referred_by_id | Integer | Referred by ID |
first_contract_active | DateTime | First contract active date |
Invoices
Invoices
Stream for managing invoices.Key Fields:
| Field | Type | Description |
|---|---|---|
uuid | String | Unique identifier |
transaction_fee | Number | Transaction fee |
payment_link_message | String | Payment link message |
discount_amount | Number | Discount amount |
payment_attempts | Array of Strings | Payment attempts details |
in_serasa | Boolean | In Serasa indicator |
billing_simulation_id | Integer | Billing simulation ID |
Invoice Billets
Invoice Billets
Stream for managing invoice billets.Key Fields:
| Field | Type | Description |
|---|---|---|
codigo_do_banco | String | Bank code |
linha_digitavel | String | Typeable line |
especie_moeda | String | Currency type |
informacoes_beneficiario | String | Beneficiary information |
banco | String | Bank name |
codigo_de_barra | String | Barcode |
codigo_barras_base64 | String | Base64 encoded barcode |
data_processamento | Date | Processing date |
data_documento | Date | Document date |
Invoice Product
Invoice Product
Stream for managing invoice products.Key Fields:
| Field | Type | Description |
|---|---|---|
contract_object_id | Integer | Contract object ID |
vehicle_id | Integer | Vehicle ID |
vehicle_plate | String | Vehicle plate |
implemento_id | Integer | Implemento ID |
invoice_billet_id | Integer | Invoice billet ID |
product_id | Integer | Product ID |
product_amount | Number | Product amount |
product_name | String | Product name |
invoice_payment_type | String | Invoice payment type |
Vehicle Category
Vehicle Category
Stream for vehicle categories.Key Fields:
| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier |
name | String | Category name |
Vehicle Color
Vehicle Color
Stream for vehicle colors.Key Fields:
| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier |
name | String | Color name |
Vehicle Type
Vehicle Type
Stream for vehicle types.Key Fields:
| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier |
name | String | Type name |
Vehicle Use Type
Vehicle Use Type
Stream for vehicle use types.Key Fields:
| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier |
name | String | Use type name |
Skills for agents
Download Mutual skills file
Mutual connector documentation as plain markdown, for use in AI agent contexts.