# CustomFieldsConfigurationApi

All URIs are relative to *http://localhost:8889/api*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**get**](#get) | **GET** /configuration/customfields.yaml | Get custom field definitions configuration|
|[**getTemplate**](#gettemplate) | **GET** /configuration/customfields/template.yaml | Get custom field definitions configuration|
|[**update**](#update) | **PUT** /configuration/customfields.yaml | Update custom field definitions configuration|

# **get**
> CustomFieldsConfiguration get()


### Example

```typescript
import {
    CustomFieldsConfigurationApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new CustomFieldsConfigurationApi(configuration);

let availableFor: Array<'CLIENT' | 'GROUP' | 'CREDIT_ARRANGEMENT' | 'LOAN_ACCOUNT' | 'GUARANTOR' | 'ASSET' | 'DEPOSIT_ACCOUNT' | 'DEPOSIT_PRODUCT' | 'TRANSACTION_CHANNEL' | 'TRANSACTION_TYPE' | 'BRANCH' | 'CENTRE' | 'USER'>; //The entity type of the custom field sets to be returned. If it is used multiple times, it will return all the custom field sets of all the specified entity types. If the parameter is absent, all the custom field sets will be returned. (optional) (default to undefined)

const { status, data } = await apiInstance.get(
    availableFor
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **availableFor** | **Array<&#39;CLIENT&#39; &#124; &#39;GROUP&#39; &#124; &#39;CREDIT_ARRANGEMENT&#39; &#124; &#39;LOAN_ACCOUNT&#39; &#124; &#39;GUARANTOR&#39; &#124; &#39;ASSET&#39; &#124; &#39;DEPOSIT_ACCOUNT&#39; &#124; &#39;DEPOSIT_PRODUCT&#39; &#124; &#39;TRANSACTION_CHANNEL&#39; &#124; &#39;TRANSACTION_TYPE&#39; &#124; &#39;BRANCH&#39; &#124; &#39;CENTRE&#39; &#124; &#39;USER&#39;>** | The entity type of the custom field sets to be returned. If it is used multiple times, it will return all the custom field sets of all the specified entity types. If the parameter is absent, all the custom field sets will be returned. | (optional) defaults to undefined|


### Return type

**CustomFieldsConfiguration**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/vnd.mambu.v2+yaml


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Custom field definitions configuration returned. |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getTemplate**
> CustomFieldsConfiguration getTemplate()


### Example

```typescript
import {
    CustomFieldsConfigurationApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new CustomFieldsConfigurationApi(configuration);

const { status, data } = await apiInstance.getTemplate();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**CustomFieldsConfiguration**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/vnd.mambu.v2+yaml


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Custom field definitions configuration template returned. |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update**
> update()


### Example

```typescript
import {
    CustomFieldsConfigurationApi,
    Configuration,
    CustomFieldsConfiguration
} from './api';

const configuration = new Configuration();
const apiInstance = new CustomFieldsConfigurationApi(configuration);

let xMambuAsync: boolean; // (optional) (default to undefined)
let xMambuCallback: string; // (optional) (default to undefined)
let customFieldsConfiguration: CustomFieldsConfiguration; // (optional)

const { status, data } = await apiInstance.update(
    xMambuAsync,
    xMambuCallback,
    customFieldsConfiguration
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **customFieldsConfiguration** | **CustomFieldsConfiguration**|  | |
| **xMambuAsync** | [**boolean**] |  | (optional) defaults to undefined|
| **xMambuCallback** | [**string**] |  | (optional) defaults to undefined|


### Return type

void (empty response body)

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: application/yaml
 - **Accept**: application/vnd.mambu.v2+yaml


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Custom field definitions configuration updated. |  -  |
|**202** | The request has been accepted for processing. |  -  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Custom field definitions configuration not found. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)