FinGoal

https://fingoal.com/developer-documentation
Admin
FinGoal provides transaction data enrichment, categorization, and user tagging APIs, plus account...
Tokens:30,531
Snippets:197
Trust Score:7.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Webhook Configurations Response Example

Source: https://fingoal.com/developer-documentation

This is an example of the JSON response you will receive when successfully retrieving webhook configurations. It includes default client configurations and tenant-specific configurations.

```json
{
  "webhook_configurations": {
    "client": [
      {
        "id": 1,
        "client_id": "your-client-id",
        "tenant_id": "TEN-123456",
        "webhook_type": "ENRICHMENT_DATA",
        "callback_url": "https://your-server.com/webhooks/enrichment",
        "created_at": "2024-01-15T10:00:00.000Z",
        "updated_at": "2024-01-15T10:00:00.000Z"
      }
    ],
    "by_tenant": {
      "TEN-123456": [
        {
          "id": 2,
          "client_id": "your-client-id",
          "tenant_id": "TEN-123456",
          "webhook_type": "ENRICHMENT_DATA",
          "callback_url": "https://tenant-specific.com/webhooks/enrichment",
          "created_at": "2024-01-15T11:00:00.000Z",
          "updated_at": "2024-01-15T11:00:00.000Z"
        }
      ]
    }
  }
}
```

--------------------------------

### Webhook Payload Example

Source: https://fingoal.com/developer-documentation

This is an example of the JSON payload received for enriched transactions. It includes details on both enriched and failed transactions, along with tenant information.

```json
{
  "enrichedTransactions": {
    "enrichedTransactions": [
      {
        "accountid": "string",
        "accountType": "string",
        "amountnum": 0,
        "category": "string",
        "categoryId": 0,
        "categoryLabel": [
          "string"
        ],
        "address": "123 Main St",
        "city": "Urbana",
        "client_id": "string",
        "container": "Transaction",
        "date": "2024-05-01T12:00:00Z",
        "detailCategoryId": 0,
        "guid": "string",
        "highLevelCategoryId": 0,
        "isPhysical": true,
        "isRecurring": false,
        "merchantAddress1": "123 Main St",
        "merchantCity": "Urbana",
        "merchantCountry": "US",
        "merchantLatitude": "38.9517",
        "merchantLogoURL": "string",
        "merchantLongitude": "-92.3341",
        "merchantName": "Dollar General",
        "merchantPhoneNumber": "555-555-5555",
        "merchantState": "MO",
        "merchantType": "retail",
        "merchantZip": "65401",
        "original_description": "string",
        "receiptDate": "2024-05-01T12:00:00Z",
        "requestId": "04f00a35-a8fa-40fd-a2ee-4af7be22ed0a",
        "simple_description": "string",
        "simpleDescription": "string",
        "settlement": "debit",
        "sourceId": "1234",
        "state": "MO",
        "subtype": "purchase",
        "subType": "purchase",
        "tenant_id": "TNT-4b7d4b7d-4b7d-4b7d-4b7d-4b7d4b7d4b7d",
        "transactionid": "string",
        "transactionTags": [
          "string"
        ],
        "transactionTagsId": [
          0
        ],
        "type": "string",
        "uid": "string",
        "website": "https://links.fingoal.com/dollar-general",
        "zip_code": "65401"
      }
    ],
    "failedTransactions": [
      {
        "transactionid": "string",
        "amountnum": 0,
        "original_description": "string",
        "uid": "string",
        "date": "2024-05-01T12:00:00Z",
        "settlement": "string",
        "accountType": "string"
      }
    ]
  },
  "failedTransactions": {
    "enrichedTransactions": [
      {
        "accountid": "string",
        "accountType": "string",
        "amountnum": 0,
        "category": "string",
        "categoryId": 0,
        "categoryLabel": [
          "string"
        ],
        "address": "123 Main St",
        "city": "Urbana",
        "client_id": "string",
        "container": "Transaction",
        "date": "2024-05-01T12:00:00Z",
        "detailCategoryId": 0,
        "guid": "string",
        "highLevelCategoryId": 0,
        "isPhysical": true,
        "isRecurring": false,
        "merchantAddress1": "123 Main St",
        "merchantCity": "Urbana",
        "merchantCountry": "US",
        "merchantLatitude": "38.9517",
        "merchantLogoURL": "string",
        "merchantLongitude": "-92.3341",
        "merchantName": "Dollar General",
        "merchantPhoneNumber": "555-555-5555",
        "merchantState": "MO",
        "merchantType": "retail",
        "merchantZip": "65401",
        "original_description": "string",
        "receiptDate": "2024-05-01T12:00:00Z",
        "requestId": "04f00a35-a8fa-40fd-a2ee-4af7be22ed0a",
        "simple_description": "string",
        "simpleDescription": "string",
        "settlement": "debit",
        "sourceId": "1234",
        "state": "MO",
        "subtype": "purchase",
        "subType": "purchase",
        "tenant_id": "TNT-4b7d4b7d-4b7d-4b7d-4b7d-4b7d4b7d4b7d",
        "transactionid": "string",
        "transactionTags": [
          "string"
        ],
        "transactionTagsId": [
          0
        ],
        "type": "string",
        "uid": "string",
        "website": "https://links.fingoal.com/dollar-general",
        "zip_code": "65401"
      }
    ],
    "failedTransactions": [
      {
        "transactionid": "string",
        "amountnum": 0,
        "original_description": "string",
        "uid": "string",
        "date": "2024-05-01T12:00:00Z",
        "settlement": "string",
        "accountType": "string"
      }
    ]
  },
  "tenant_id": "TEN-123456"
}
```

--------------------------------

### POST /cleanup Request Example

Source: https://fingoal.com/developer-documentation

Use this endpoint to enrich historical transaction data. Ensure your Authorization header includes a valid Bearer token.

```curl
curl -X POST "https://findmoney-dev.fingoal.com/v3/cleanup" 
  -H "Authorization: Bearer YOUR_TOKEN" 
  -H "Content-Type: application/json" 
  -d '{
    "transactions": [
      {
        "accountType": "checking",
        "amountnum": 19.99,
        "date": "2024-05-01",
        "identifiers": {
          "sfmc_contact_id": "sfmc-1234",
          "banno_end_user_id": "banno-1234"
        },
        "original_description": "Cottonwood Supermarket & Deli",
        "transactionid": "178b1f61-dafe-4d47-837b-54ce34dc82b2",
        "settlement": "debit",
        "uid": "user123",
        "accountid": "account456"
      }
    ]
  }'
```

```javascript
const response = await fetch("https://findmoney-dev.fingoal.com/v3/cleanup", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "transactions": [
          {
              "accountType": "checking",
              "amountnum": 19.99,
              "date": "2024-05-01",
              "identifiers": {
                  "sfmc_contact_id": "sfmc-1234",
                  "banno_end_user_id": "banno-1234"
              },
              "original_description": "Cottonwood Supermarket & Deli",
              "transactionid": "178b1f61-dafe-4d47-837b-54ce34dc82b2",
              "settlement": "debit",
              "uid": "user123",
              "accountid": "account456"
          }
      ]
  })
});

const data = await response.json();
console.log(data);
```

```python
import requests

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}

payload = {
    "transactions": [
        {
            "accountType": "checking",
            "amountnum": 19.99,
            "date": "2024-05-01",
            "identifiers": {
                "sfmc_contact_id": "sfmc-1234",
                "banno_end_user_id": "banno-1234"
            },
            "original_description": "Cottonwood Supermarket & Deli",
            "transactionid": "178b1f61-dafe-4d47-837b-54ce34dc82b2",
            "settlement": "debit",
            "uid": "user123",
            "accountid": "account456"
        }
    ]
}

response = requests.post("https://findmoney-dev.fingoal.com/v3/cleanup", headers=headers, json=payload)
data = response.json()
print(data)
```

--------------------------------

### Get Webhook Configurations

Source: https://fingoal.com/developer-documentation

Retrieves all webhook configurations for your client, organized by scope. This includes default configurations and tenant-specific configurations.

```APIDOC
## GET /v3/webhook-configurations

### Description
Retrieves all webhook configurations for your client, organized by scope.

### Method
GET

### Endpoint
/v3/webhook-configurations

### Request Headers
- **Authorization** (string) - Required - Bearer token for authentication.
- **Content-Type** (string) - Required - application/json

### Response
#### Success Response (200)
- **webhook_configurations** (object) - All webhook configurations for your client, organized by scope.
  - **client** (object[]) - Default webhook configurations (no tenant_id).
  - **by_tenant** (object) - Tenant-specific webhook configurations.

#### Response Example
```json
{
  "webhook_configurations": {
    "client": [
      {
        "id": 1,
        "client_id": "your-client-id",
        "tenant_id": null,
        "webhook_type": "ENRICHMENT_DATA",
        "callback_url": "https://your-server.com/webhooks/enrichment",
        "created_at": "2024-01-15T10:00:00.000Z",
        "updated_at": "2024-01-15T10:00:00.000Z"
      }
    ],
    "by_tenant": {
      "TEN-123456": [
        {
          "id": 2,
          "client_id": "your-client-id",
          "tenant_id": "TEN-123456",
          "webhook_type": "ENRICHMENT_DATA",
          "callback_url": "https://tenant-specific.com/webhooks/enrichment",
          "created_at": "2024-01-15T11:00:00.000Z",
          "updated_at": "2024-01-15T11:00:00.000Z"
        }
      ]
    }
  }
}
```
```

--------------------------------

### Callback Payload Example

Source: https://fingoal.com/developer-documentation

This is an example of the JSON payload received by a webhook when a batch of transactions has been enriched.

```json
{
  "batch_request_id": "5f4b1b9b-4b7d-4b7d-4b7d-4b7d4b7d4b7d",
  "client_id": "client-123",
  "tenant_id": "TNT-5f4b1b9b-4b7d-4b7d-4b7d-4b7d4b7d4b7d"
}
```

--------------------------------

### User Tags Notification Webhook Payload Example

Source: https://fingoal.com/developer-documentation

This is an example of a non-data-rich webhook payload for user tag notifications. It contains only identifiers like 'guid' and 'tenant_id'. Use this when you prefer smaller payloads and want to fetch tag data separately.

```json
{
  "guid": "3961c39e-e1c6-45ec-acd0-9a7793dabe02",
  "tenant_id": "string"
}
```

--------------------------------

### Sync Transactions using JavaScript

Source: https://fingoal.com/developer-documentation

This JavaScript example demonstrates how to use the fetch API to send transaction data to the sync endpoint. It includes setting the Authorization header and stringifying the request body.

```javascript
const response = await fetch("https://findmoney-dev.fingoal.com/v3/cleanup/sync", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "transactions": [
          {
              "accountType": "checking",
              "amountnum": 19.99,
              "date": "2024-05-01",
              "identifiers": {
                  "sfmc_contact_id": "sfmc-1234",
                  "banno_end_user_id": "banno-1234"
              },
              "original_description": "Cottonwood Supermarket & Deli",
              "transactionid": "178b1f61-dafe-4d47-837b-54ce34dc82b2",
              "settlement": "debit",
              "uid": "user123",
              "accountid": "account456"
          }
      ]
  })
});

const data = await response.json();
console.log(data);
```

--------------------------------

### Transaction Request Body Example

Source: https://fingoal.com/developer-documentation

This is an example of a transaction request body. It includes all required fields and optional identifiers.

```json
{
  "transactions": [
    {
      "accountType": "checking",
      "amountnum": 19.99,
      "date": "2024-05-01",
      "identifiers": {
        "sfmc_contact_id": "sfmc-1234",
        "banno_end_user_id": "banno-1234"
      },
      "original_description": "Cottonwood Supermarket & Deli",
      "transactionid": "178b1f61-dafe-4d47-837b-54ce34dc82b2",
      "settlement": "debit",
      "uid": "user123"
    }
  ]
}
```

--------------------------------

### Retrieve Webhook Configurations (Python)

Source: https://fingoal.com/developer-documentation

This Python script uses the 'requests' library to get webhook configurations. Remember to replace 'YOUR_TOKEN' with your valid bearer token.

```python
import requests

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get("https://findmoney-dev.fingoal.com/v3/webhook-configurations", headers=headers)
data = response.json()
print(data)
```

--------------------------------

### Make GET Request to Cleanup API

Source: https://fingoal.com/developer-documentation

Use this snippet to make a GET request to the Cleanup API. Replace YOUR_TOKEN with your actual API token. The batch_request_id is a required path parameter.

```cURL
curl -X GET "https://findmoney-dev.fingoal.com/v3/cleanup/{batch_request_id}" 
  -H "Authorization: Bearer YOUR_TOKEN" 
  -H "Content-Type: application/json"
```

```JavaScript
const response = await fetch("https://findmoney-dev.fingoal.com/v3/cleanup/{batch_request_id}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  }
});

const data = await response.json();
console.log(data);
```

```Python
import requests

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get("https://findmoney-dev.fingoal.com/v3/cleanup/{batch_request_id}", headers=headers)
data = response.json()
print(data)
```

--------------------------------

### User Tags Data-Rich Webhook Payload Example

Source: https://fingoal.com/developer-documentation

This is an example of a data-rich webhook payload for user tag updates. It includes created, deleted, and modified tags with their details. Use this when you need complete user tag information directly in the webhook.

```json
{
  "tenant_id": "string",
  "userTags": {
    "created": [
      {
        "user_id": "409088",
        "user_tag_id": 61,
        "tag_name": "Home Improvement Loan"
      }
    ],
    "deleted": [
      {
        "user_id": "409088",
        "user_tag_id": 46,
        "tag_name": "Movie Goer"
      }
    ],
    "modified": [
      {
        "user_id": "409088",
        "user_tag_id": 46,
        "tag_name": "Movie Goer",
        "previous_value": 50,
        "new_value": 75,
        "delta": 25
      }
    ]
  }
}
```

--------------------------------

### Get User Tags (Python)

Source: https://fingoal.com/developer-documentation

Fetches user and transaction tags for a specified user ID using Python. Tagging is processed in batches twice daily and requires transaction dates within the past 90 days.

```Python
import requests

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get("https://findmoney-dev.fingoal.com/v3/users/{userId}", headers=headers)
data = response.json()
print(data)
```

--------------------------------

### Get a User

Source: https://fingoal.com/developer-documentation

Fetches user and transaction tags for a specified user ID. Tagging is run in batches twice daily and thus not available immediately after posting transactions. Transaction dates must be within the past 90 days.

```APIDOC
## GET /users/{userId}

### Description
Fetches user and transaction tags for a specified user ID. Both endpoints return the same schema. Use the sync keyword to trigger a manual update on the transaction and user tags for a single user.

### Method
GET

### Endpoint
/users/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID for the user you want to retrieve.
#### Header Parameters
- **include_tagged_transactions** (string) - Deprecated - This field has been deprecated. Tagged transactions are received automatically from the enrichment API. Set to true to include all of the user's tagged transactions in the response. By default, tagged transactions are not included.

### Responses
#### Success Response (200)
- **user** (object) - The user object containing details like client ID, ID, unique ID, lifetime savings, registration date, subtenant ID, tags, total transactions, and transactions since last update.
- **transactions** (object[]) - An array of transaction objects, each containing transaction ID, simple description, original description, category, amount, date, and tags.

#### Response Example (200)
{
  "user": {
    "client_id": "string",
    "id": "string",
    "uid": "string",
    "uniqueId": "string",
    "lifetimeSavings": 0,
    "registrationDate": "2024-05-01T12:00:00Z",
    "subtenantId": "string",
    "tags": [
      "string"
    ],
    "totaltransactions": 0,
    "transactionsSinceLastUpdate": 0
  },
  "transactions": [
    {
      "transaction_id": "string",
      "simple_description": "string",
      "original_description": "string",
      "category": "string",
      "amount": 0,
      "date": "2024-05-01T12:00:00Z",
      "tags": [
        "string"
      ]
    }
  ]
}

#### Error Responses
- **401** Unauthorized
- **404** User ID could not be found
```

--------------------------------

### Get User Tags (JavaScript)

Source: https://fingoal.com/developer-documentation

Fetches user and transaction tags for a specified user ID using JavaScript. Tagging is processed in batches twice daily and requires transaction dates within the past 90 days.

```JavaScript
const response = await fetch("https://findmoney-dev.fingoal.com/v3/users/{userId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  }
});

const data = await response.json();
console.log(data);
```

--------------------------------

### List Webhook Configurations

Source: https://fingoal.com/developer-documentation

Retrieves all webhook configurations for your client, including default and tenant-specific settings.

```APIDOC
## GET /webhook-configurations

### Description
Retrieve all webhook configurations for your client. Configurations are organized into default and tenant-specific settings.

### Method
GET

### Endpoint
/webhook-configurations

### Response
#### Success Response (200)
- **default** (object) - Configurations for the client's default callback URL.
- **tenants** (object) - Tenant-specific configurations organized by tenant_id.
```

--------------------------------

### Retrieve Webhook Configurations (cURL)

Source: https://fingoal.com/developer-documentation

Use this cURL command to fetch all webhook configurations for your client. Ensure you replace 'YOUR_TOKEN' with your actual bearer token.

```bash
curl -X GET "https://findmoney-dev.fingoal.com/v3/webhook-configurations" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
```

--------------------------------

### Create or Update Webhook Configuration (JavaScript)

Source: https://fingoal.com/developer-documentation

This JavaScript code snippet demonstrates how to use the fetch API to create or update a webhook configuration. It includes setting the necessary headers and stringifying the request body.

```javascript
const response = await fetch("https://findmoney-dev.fingoal.com/v3/webhook-configurations", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "webhook_type": "ENRICHMENT_DATA",
      "callback_url": "https://your-server.com/webhooks/enrichment"
  })
});

const data = await response.json();
console.log(data);
```

--------------------------------

### Sync Transactions using Python

Source: https://fingoal.com/developer-documentation

This Python script utilizes the requests library to make a POST request to the sync endpoint. It shows how to set up headers and the JSON payload for sending transaction data.

```python
import requests

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}

payload = {
    "transactions": [
        {
            "accountType": "checking",
            "amountnum": 19.99,
            "date": "2024-05-01",
            "identifiers": {
                "sfmc_contact_id": "sfmc-1234",
                "banno_end_user_id": "banno-1234"
            },
            "original_description": "Cottonwood Supermarket & Deli",
            "transactionid": "178b1f61-dafe-4d47-837b-54ce34dc82b2",
            "settlement": "debit",
            "uid": "user123",
            "accountid": "account456"
        }
    ]
}

response = requests.post("https://findmoney-dev.fingoal.com/v3/cleanup/sync", headers=headers, json=payload)
data = response.json()
print(data)
```

--------------------------------

### Retrieve Updated Tags

Source: https://fingoal.com/developer-documentation

Retrieves updated user tags using a provided GUID. This is typically used in conjunction with webhook notifications for tag status updates.

```APIDOC
## GET /users/tags/{guid}

### Description
Retrieve updated tags for a user using a GUID received from a status update webhook. The tag updates are available for 24 hours.

### Method
GET

### Endpoint
/users/tags/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The GUID for the updates you want to retrieve.

### Request Example
```curl
curl -X GET "https://findmoney-dev.fingoal.com/v3/users/tags/{guid}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
```

### Response
#### Success Response (200)
- **tenant_id** (string) - The ID of the tenant for the users included in this update.
- **userTags** (object) - Contains lists of created, deleted, and modified user tags.
  - **created** (object[]) - A list of new user tags.
    - **user_id** (string) - The user who received this tag.
    - **user_tag_id** (integer) - The ID of the tag that has been applied.
    - **tag_name** (string) - The name of the tag that has been applied.
  - **deleted** (object[]) - A list of user tags that were removed.
    - **user_id** (string) - The user who received this tag.
    - **user_tag_id** (integer) - The ID of the tag that has been removed.
    - **tag_name** (string) - The name of the tag that has been removed.
  - **modified** (object[]) - For incremental user tags, contains scoring changes.
    - **user_id** (string) - The user who received this tag.
    - **user_tag_id** (integer) - The ID of the tag that has been updated.
    - **tag_name** (string) - The name of the tag that has been updated.
    - **previous_value** (integer) - The last value for this tag's score.
    - **new_value** (integer) - The new value for this tag's score.
    - **delta** (integer) - The amount by which this tag's score has changed.
```

--------------------------------

### Create or Update Webhook Configuration

Source: https://fingoal.com/developer-documentation

Creates a new webhook configuration or updates an existing one. The client and tenant IDs are inferred from the bearer token. Omit `tenant_id` to set the default callback URL.

```APIDOC
## PUT /webhook-configurations

### Description
Create a new webhook configuration or update an existing one. Your `client_id` and `tenant_id` are automatically inferred from the bearer token on this request. To set up a webhook for a specific tenant, please ensure that the bearer token on this request as a `tenant_id` claim. If your bearer token lacks a `tenant_id`, the webhook will be created for your single-tenant environment.

* If a configuration already exists for the same client/tenant/webhook_type combination, it will be updated.
* If `tenant_id` is provided, your client must have a relationship with that tenant.
* Omit `tenant_id` to set the default callback URL for your client.

### Method
PUT

### Endpoint
/webhook-configurations

### Request Body
- **webhook_type** (string) - Required - The type of webhook to configure. Accepted values: `ENRICHMENT_DATA`, `ENRICHMENT_NOTIFICATION`, `USER_TAGS_DATA`, `USER_TAGS_NOTIFICATION`, `INSIGHTS`.
- **callback_url** (string) - Required - Valid HTTPS URL for webhook delivery.
```

--------------------------------

### Retrieve Webhook Configurations (JavaScript)

Source: https://fingoal.com/developer-documentation

This JavaScript code snippet demonstrates how to retrieve webhook configurations using the Fetch API. It includes setting the necessary Authorization and Content-Type headers.

```javascript
const response = await fetch("https://findmoney-dev.fingoal.com/v3/webhook-configurations", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  }
});

const data = await response.json();
console.log(data);
```

--------------------------------

### GET /v3/cleanup/{batch_request_id}

Source: https://fingoal.com/developer-documentation

Retrieves transaction data associated with a specific batch request ID. This endpoint is useful for fetching processed transaction information after a cleanup operation.

```APIDOC
## GET /v3/cleanup/{batch_request_id}

### Description
Retrieves transaction data associated with a specific batch request ID. This endpoint is useful for fetching processed transaction information after a cleanup operation.

### Method
GET

### Endpoint
/v3/cleanup/{batch_request_id}

### Parameters
#### Path Parameters
- **batch_request_id** (string) - Required - The unique identifier for the batch request.

#### Request Example
```curl
curl -X GET "https://findmoney-dev.fingoal.com/v3/cleanup/{batch_request_id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
```

### Response
#### Success Response (200)
- **enrichedTransactions** (object[]) - A list of enriched transaction objects.
  - **accountid** (string) - The ID of the account associated with the transaction.
  - **accountType** (string) - The type of account associated with the transaction (e.g., 'checking', 'savings').
  - **amountnum** (number) - The transaction's USD amount.
  - **category** (string) - The most applicable categorization for the transaction.
  - **categoryId** (number) - The numeric ID of the transaction's category.
  - **categoryLabel** (string[]) - A cascading hierarchy of the transaction's categories.
  - **address** (string,null) - The address associated with the transaction.
  - **city** (string,null) - The city associated with the transaction.
  - **client_id** (string) - Your FinGoal client ID.
  - **container** (string,null) - A high-level categorization of the account type.
  - **date** (string) - The date on which the transaction took place.
  - **detailCategoryId** (number) - The numeric ID of the transaction's detail category.
  - **guid** (string) - The transaction's globally unique FinSight API issued ID.
  - **highLevelCategoryId** (number) - The numeric ID of the transaction's high level category.
  - **isPhysical** (boolean,null) - Whether the transaction was made at a physical location, or online.
  - **isRecurring** (boolean,null) - Denotes whether the transaction is set to recur on a fixed interval.
  - **merchantAddress1** (string,null) - The street address of the merchant associated with the transaction.
  - **merchantCity** (string,null) - The name of the city where the merchant is located.
  - **merchantCountry** (string,null) - The name of the country where the merchant is located.
  - **merchantLatitude** (string,null) - The latitude of the merchant.
  - **merchantLogoURL** (string) - The URL resource for the merchant's logo.
  - **merchantLongitude** (string,null) - The longitude of the merchant.
  - **merchantName** (string,null) - The name of the merchant associated with the transaction.
  - **merchantPhoneNumber** (string,null) - The phone number of the merchant associated with the transaction.
  - **merchantState** (string,null) - The name of the state where the merchant is located.
  - **merchantType** (string,null) - The merchant's type.
  - **merchantZip** (string,null) - The zip code of the merchant.
  - **original_description** (string) - The original description of the transaction.
  - **receiptDate** (string) - The date the receipt was issued.
  - **requestId** (string) - The ID of the request associated with the transaction.
  - **simple_description** (string) - A simplified description of the transaction.
  - **simpleDescription** (string) - A simplified description of the transaction.
  - **settlement** (string) - The settlement type of the transaction (e.g., 'debit', 'credit').
  - **sourceId** (string) - The ID of the source system for the transaction.
  - **state** (string) - The state associated with the transaction.
  - **subtype** (string) - The subtype of the transaction.
  - **subType** (string) - The subtype of the transaction.
  - **tenant_id** (string) - The tenant ID associated with the transaction.
  - **transactionid** (string) - The unique identifier for the transaction.
  - **transactionTags** (string[]) - Tags associated with the transaction.
  - **transactionTagsId** (number[]) - IDs of tags associated with the transaction.
  - **type** (string) - The type of the transaction.
  - **uid** (string) - The unique ID of the transaction.
  - **website** (string) - The website associated with the merchant.
  - **zip_code** (string) - The zip code associated with the transaction.
- **failedTransactions** (object[]) - A list of failed transaction objects.
  - **transactionid** (string) - The unique identifier for the failed transaction.
  - **amountnum** (number) - The amount of the failed transaction.
  - **original_description** (string) - The original description of the failed transaction.
  - **uid** (string) - The unique ID of the failed transaction.
  - **date** (string) - The date of the failed transaction.
  - **settlement** (string) - The settlement type of the failed transaction.
  - **accountType** (string) - The type of account associated with the failed transaction.

#### Response Example
```json
{
  "enrichedTransactions": [
    {
      "accountid": "string",
      "accountType": "string",
      "amountnum": 0,
      "category": "string",
      "categoryId": 0,
      "categoryLabel": [
        "string"
      ],
      "address": "123 Main St",
      "city": "Urbana",
      "client_id": "string",
      "container": "Transaction",
      "date": "2024-05-01T12:00:00Z",
      "detailCategoryId": 0,
      "guid": "string",
      "highLevelCategoryId": 0,
      "isPhysical": true,
      "isRecurring": false,
      "merchantAddress1": "123 Main St",
      "merchantCity": "Urbana",
      "merchantCountry": "US",
      "merchantLatitude": "38.9517",
      "merchantLogoURL": "string",
      "merchantLongitude": "-92.3341",
      "merchantName": "Dollar General",
      "merchantPhoneNumber": "555-555-5555",
      "merchantState": "MO",
      "merchantType": "retail",
      "merchantZip": "65401",
      "original_description": "string",
      "receiptDate": "2024-05-01T12:00:00Z",
      "requestId": "04f00a35-a8fa-40fd-a2ee-4af7be22ed0a",
      "simple_description": "string",
      "simpleDescription": "string",
      "settlement": "debit",
      "sourceId": "1234",
      "state": "MO",
      "subtype": "purchase",
      "subType": "purchase",
      "tenant_id": "TNT-4b7d4b7d-4b7d-4b7d-4b7d-4b7d4b7d4b7d",
      "transactionid": "string",
      "transactionTags": [
        "string"
      ],
      "transactionTagsId": [
        0
      ],
      "type": "string",
      "uid": "string",
      "website": "https://links.fingoal.com/dollar-general",
      "zip_code": "65401"
    }
  ],
  "failedTransactions": [
    {
      "transactionid": "string",
      "amountnum": 0,
      "original_description": "string",
      "uid": "string",
      "date": "2024-05-01T12:00:00Z",
      "settlement": "string",
      "accountType": "string"
    }
  ]
}
```

### Errors
- **401** Unauthorized
- **404** No transactions found for the given request id.
```

--------------------------------

### Retrieve Updated Tags

Source: https://fingoal.com/developer-documentation

Fetches updated user tags using a provided GUID. This endpoint is intended for use with webhook status updates and data is available for 24 hours.

```curl
curl -X GET "https://findmoney-dev.fingoal.com/v3/users/tags/{guid}" 
  -H "Authorization: Bearer YOUR_TOKEN" 
  -H "Content-Type: application/json"
```

```javascript
const response = await fetch("https://findmoney-dev.fingoal.com/v3/users/tags/{guid}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  }
});

const data = await response.json();
console.log(data);
```

```python
import requests

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get("https://findmoney-dev.fingoal.com/v3/users/tags/{guid}", headers=headers)
data = response.json()
print(data)
```

--------------------------------

### Create or Update Webhook Configuration

Source: https://fingoal.com/developer-documentation

Use this endpoint to create a new webhook configuration or update an existing one. The client_id and tenant_id are inferred from the bearer token. Provide a tenant_id for tenant-specific webhooks; omit it for default client-wide webhooks.

```json
{
  "webhook_type": "ENRICHMENT_DATA",
  "callback_url": "https://your-server.com/webhooks/enrichment"
}
```

--------------------------------

### Get User Tags

Source: https://fingoal.com/developer-documentation

Fetches user and transaction tags for a specified user ID. Tagging is processed in batches twice daily and requires transaction dates within the past 90 days.

```cURL
curl -X GET "https://findmoney-dev.fingoal.com/v3/users/{userId}" 
  -H "Authorization: Bearer YOUR_TOKEN" 
  -H "Content-Type: application/json"
```

--------------------------------

### Create or Update Webhook Configuration (Python)

Source: https://fingoal.com/developer-documentation

This Python script uses the requests library to create or update a webhook configuration. It defines the headers and payload separately before making the PUT request.

```python
import requests

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}

payload = {
    "webhook_type": "ENRICHMENT_DATA",
    "callback_url": "https://your-server.com/webhooks/enrichment"
}

response = requests.put("https://findmoney-dev.fingoal.com/v3/webhook-configurations", headers=headers, json=payload)
data = response.json()
print(data)
```

--------------------------------

### Retrieve Enrichment by Batch Request ID

Source: https://fingoal.com/developer-documentation

Use this GET request to retrieve the results of an asynchronous transaction cleanup operation using its batch operation ID. The ID is obtained from the webhook sent upon completion.

```http
GET /cleanup/{batch_request_id}
```

--------------------------------

### POST /v3/cleanup/sync

Source: https://fingoal.com/developer-documentation

Submits a list of transactions for synchronization and cleanup. It returns enriched transaction data and any transactions that failed processing.

```APIDOC
## POST /v3/cleanup/sync

### Description
Submits a list of transactions for synchronization and cleanup. It returns enriched transaction data and any transactions that failed processing.

### Method
POST

### Endpoint
/v3/cleanup/sync

### Request Body
- **transactions** (array) - Required - An array of transaction objects to be processed.
  - **accountType** (string) - Required - The type of the account (e.g., "checking").
  - **amountnum** (number) - Required - The transaction amount.
  - **date** (string) - Required - The date of the transaction in YYYY-MM-DD format.
  - **identifiers** (object) - Required - Identifiers for the transaction.
    - **sfmc_contact_id** (string) - Required - Salesforce Marketing Cloud contact ID.
    - **banno_end_user_id** (string) - Required - Banno end user ID.
  - **original_description** (string) - Required - The original description of the transaction.
  - **transactionid** (string) - Required - The unique ID of the transaction.
  - **settlement** (string) - Required - The settlement type (e.g., "debit").
  - **uid** (string) - Required - The user ID associated with the transaction.
  - **accountid** (string) - Required - The ID of the account.

### Request Example
```json
{
  "transactions": [
    {
      "accountType": "checking",
      "amountnum": 19.99,
      "date": "2024-05-01",
      "identifiers": {
        "sfmc_contact_id": "sfmc-1234",
        "banno_end_user_id": "banno-1234"
      },
      "original_description": "Cottonwood Supermarket & Deli",
      "transactionid": "178b1f61-dafe-4d47-837b-54ce34dc82b2",
      "settlement": "debit",
      "uid": "user123",
      "accountid": "account456"
    }
  ]
}
```

### Responses
#### Success Response (200)
Returns an object containing lists of enriched and failed transactions.
- **enrichedTransactions** (object) - Contains lists of enriched and failed transactions.
  - **enriched** (array) - An array of successfully processed and enriched transactions.
    - **accountid** (string) - The ID of the account associated with the transaction.
    - **amountnum** (number) - The transaction's USD amount.
    - **category** (string) - The most applicable categorization for the transaction.
    - **categoryId** (number) - The numeric ID of the transaction's category.
    - **categoryLabel** (array) - Labels associated with the transaction's category.
    - **client_id** (string) - The client ID.
    - **container** (string) - The container type.
    - **date** (string) - The date of the transaction.
    - **detailCategoryId** (number) - The detail category ID.
    - **guid** (string) - The GUID of the transaction.
    - **highLevelCategoryId** (number) - The high-level category ID.
    - **isPhysical** (boolean) - Indicates if the transaction is physical.
    - **isRecurring** (boolean) - Indicates if the transaction is recurring.
    - **merchantAddress1** (string) - The merchant's address.
    - **merchantCity** (string) - The merchant's city.
    - **merchantCountry** (string) - The merchant's country.
    - **merchantLatitude** (string) - The merchant's latitude.
    - **merchantLogoURL** (string) - The URL of the merchant's logo.
    - **merchantLongitude** (string) - The merchant's longitude.
    - **merchantName** (string) - The name of the merchant.
    - **merchantPhoneNumber** (string) - The merchant's phone number.
    - **merchantState** (string) - The merchant's state.
    - **merchantType** (string) - The type of the merchant.
    - **merchantZip** (string) - The merchant's zip code.
    - **original_description** (string) - The original description of the transaction.
    - **receiptDate** (string) - The date of the receipt.
    - **requestId** (string) - The request ID.
    - **simple_description** (string) - A simplified description of the transaction.
    - **simpleDescription** (string) - A simplified description of the transaction.
    - **sourceId** (string) - The source ID of the transaction.
    - **subType** (string) - The subtype of the transaction.
    - **tenant_id** (string) - The tenant ID.
    - **transactionid** (string) - The unique ID of the transaction.
    - **transactionTags** (array) - Tags associated with the transaction.
    - **type** (string) - The type of the transaction.
    - **uid** (string) - The user ID associated with the transaction.
  - **failed** (array) - An array of transactions that failed processing.
    - **amountnum** (number) - The transaction amount.
    - **settlement** (string) - The settlement type.
    - **original_description** (string) - The original description of the transaction.
    - **transactionid** (string) - The unique ID of the transaction.
    - **date** (string) - The date of the transaction.
    - **accountType** (string) - The type of the account.
    - **uid** (string) - The user ID associated with the transaction.
    - **error_message** (string) - The error message for the failed transaction.

#### Error Response (400)
Bad request. An array of errors in the data will be returned. Fields not allowed or incorrectly formatted will be noted.

#### Error Response (401)
Unauthorized
```

--------------------------------

### Sync Transactions using cURL

Source: https://fingoal.com/developer-documentation

Use this cURL command to send a POST request with transaction data to the sync endpoint. Ensure you replace YOUR_TOKEN with your actual authorization token.

```bash
curl -X POST "https://findmoney-dev.fingoal.com/v3/cleanup/sync" 
  -H "Authorization: Bearer YOUR_TOKEN" 
  -H "Content-Type: application/json" 
  -d '{
    "transactions": [
      {
        "accountType": "checking",
        "amountnum": 19.99,
        "date": "2024-05-01",
        "identifiers": {
          "sfmc_contact_id": "sfmc-1234",
          "banno_end_user_id": "banno-1234"
        },
        "original_description": "Cottonwood Supermarket & Deli",
        "transactionid": "178b1f61-dafe-4d47-837b-54ce34dc82b2",
        "settlement": "debit",
        "uid": "user123",
        "accountid": "account456"
      }
    ]
  }'
```
Tokens:
Raw