# Import Business Data

### API Overview

This API is used to upload business data to the system. Data should be transmitted in JSON format.

* **Request Method：**`POST`
* **Request URL：**`https://openapi.elven.com/open/v3/businessData`
* **Content-Type：**`application/json`

### Request Headers

<table><thead><tr><th width="202">Parameter Name</th><th width="90">Type</th><th width="100">Required</th><th>Description</th></tr></thead><tbody><tr><td>elven-api-key</td><td>String</td><td>Yes</td><td>The API key assigned to you</td></tr><tr><td>elven-api-sign</td><td>String</td><td>Yes</td><td>Request signature, used to verify the legitimacy of the request</td></tr><tr><td>elven-api-timestamp</td><td>String</td><td>Yes</td><td>Request timestamp, in milliseconds</td></tr></tbody></table>

[View Details](https://docs.elven.com/v3/~/changes/YkdBoYHdjwadymwIANKf/openapi/obtaining-api-authorization?r=LJbAoiJKFX1i7Py2GCYr)

### Request Parameters

#### Body Parameters (JSON Format)

<table><thead><tr><th width="243">Parameter Name</th><th width="84">Type</th><th width="101">Required</th><th>Description</th></tr></thead><tbody><tr><td>businessDataTypeName</td><td>String</td><td>Yes</td><td>Business Data Type Name: Must already exist in the system.</td></tr><tr><td>businessDataSourceName</td><td>String</td><td>Yes</td><td>Business Data Source Name: If not already created, it will be automatically created with the type <code>openapi</code></td></tr><tr><td>type</td><td>String</td><td>No</td><td>TRANSACTION is for business transaction data, BALANCE is for business balance data, and if not transmitted, the default is TRANSACTION.</td></tr><tr><td>balanceTransformer</td><td>Object</td><td>No</td><td>Identification rules for the business balance field type</td></tr><tr><td>businessDataList</td><td>Array</td><td>Yes</td><td>Business Data List: Each element represents a business data object.</td></tr></tbody></table>

**balanceTransformer**

Define the identification rules for the business balance field type, which only needs to be provided during the first import of business balance data.

**Example:**

```json
{ 
    "datetimeColumn": 1, 
    "timezone": "UTC", 
    "currencyColumn": 4, 
    "amountColumn": 8, 
    "auxiliaryTypeName": "User", 
    "auxiliaryValueColumn": 0 
} 
```

<table><thead><tr><th width="246">Parameter Name</th><th width="100">Required</th><th>Description</th></tr></thead><tbody><tr><td>datetimeColumn</td><td>YES</td><td>The zero-based index position of the datetime column in businessDataList array</td></tr><tr><td>timezone</td><td>YES</td><td>Timezone of datetime in business balance data <a href="timezone">View Details</a></td></tr><tr><td>currencyColumn</td><td>YES</td><td>The zero-based index position of the currency column in businessDataList array</td></tr><tr><td>amountColumn</td><td>YES</td><td>The zero-based index position of the amount column in businessDataList array</td></tr><tr><td>auxiliaryTypeName</td><td>NO</td><td>Auxiliary code name (please create auxiliary code in system first)</td></tr><tr><td>auxiliaryValueColumn</td><td>NO</td><td>The zero-based index position of the auxiliary code column in businessDataList array</td></tr></tbody></table>

**businessDataList:**

Each element in`businessDataList` is a JSON object containing your business data fields.=

**Example:**

```json
[
    {"a": 100, "b": "buy", "c": "2024-07-01 22:33:44"},
    {"a": 100, "b": "sell", "c": "2024-07-01 23:33:44"},
    {"a": 100, "b": "buy", "c": "2024-07-02 06:33:44"}
]
```

#### Example Request

```json
{
    "businessDataTypeName": "Settlement",
    "businessDataSourceName": "Settlement-2024-07",
    "businessDataList": [
        {"a": 100, "b": "buy", "c": "2024-07-01 22:33:44"},
        {"a": 100, "b": "sell", "c": "2024-07-01 23:33:44"},
        {"a": 100, "b": "buy", "c": "2024-07-02 06:33:44"}
    ]
}
```

### Response Parameters

| Parameter Name | Type    | Description        |
| -------------- | ------- | ------------------ |
| success        | Boolean | Upload Task Status |

#### Example Response

```json
{
    "success": true
}
```

### **Notes**

* **Data Size Limit:** The maximum request body size is 100KB. If the data exceeds this limit, reduce the number of entries in businessDataList or contact Elven support for assistance.
* **Content-Type:** The request must use application/json as the Content-Type.
* &#x20;**Business Data Type:** Ensure the provided businessDataTypeName already exists in the system.
* &#x20;**Business Data Source:** If businessDataSourceName does not exist, it will be automatically created with the type set to openapi.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.elven.com/v3/openapi/import-business-data.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.