# Money

The Currency Value Set and Value Source must be selected for the Money Characteristic to work.

This field also presents a currency conversion from the selected currency to the company's default currency.\
\
The expected format of the value entered is a standard number with decimal. The full decimal entered is saved but not displayed.

| Value Precision | is AllowMultiple respected? | Has validation? |
| --------------- | --------------------------- | --------------- |
| .00             | No                          | Yes             |

### Example Money Field Value

```json
{
    "locAmt": 1.50,
    "locSym": "EUR",
    "locCur": 2,
    "divAmt": 1.75,
    "divSym": "USD",
    "divCur": 1
}
```

{% hint style="info" %}
When setting or updating a money field via the API, you should only pass the `locAmt`, and either`locSym` or `locCur` fields. If any of the additional fields are present in the request you will be presented with an error.
{% endhint %}

<figure><img src="/files/8z5l7o2vAQF6qHMH7LpC" alt=""><figcaption></figcaption></figure>

### Example Creating Deal with Money Field ("allocated") with locSym

{% code title="POST /v4/deal" %}

```json
{
    "title": "Test Deal",
    "template": {
        "templateId":1
    },
    "characteristics": {
        "allocated": {
            "locAmt": 10.00,
            "locSym": "EUR"
        } 
    }
}
```

{% endcode %}

### Example Creating Deal with Money Field ("allocated") with locCur

{% code title="POST /v4/deal" %}

```json
{
    "title": "Test Deal",
    "template": {
        "templateId":1
    },
    "characteristics": {
        "allocated": {
            "locAmt": 10.00,
            "locCur": 4
        } 
    }
}
```

{% endcode %}

{% hint style="info" %}
If you are using our new Three Level Currency Conversion Feature, API requirements can be found [here](https://rightsline.zendesk.com/hc/en-us/articles/15278043998619-Populating-Money-Fields-via-the-API).
{% endhint %}

### Money Data Type Definition

```json
{
     "fields" : [
     	{
	   "fieldName": "Money single",
	   "label": "money_single",
	   "required": false,
	   "maxLength": 10000,
	   "editable": true,
	   "dataType": "Money",
	   "allowMultiple": false,
	   "listOfValues": [
		{
			"id": 1,
			"label": "USD",
			"xref": null,
			"childValues": []
		},
		{
			"id": 2,
			"label": "GBP",
			"xref": null,
			"childValues": []
		},
		{
			"id": 3,
			"label": "JPY",
			"xref": null,
			"childValues": []
		}
		...
	    ]
	},
        ...
    ]
}  
```


---

# 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://api-docs.rightsline.com/config/data-types/money.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.
