Transactionchannel
Represents a transaction channel.
attributes object
Represents transaction channel attributes.
The flag that determines of overdraft is allowed.
TRUE if the transaction channel is available for all users, FALSE otherwise.
customFields object[]
The custom field definition available for the transaction channel.
The entity type the custom field definition is associated with.
Possible values: [CLIENT, GROUP, CREDIT_ARRANGEMENT, LOAN_ACCOUNT, GUARANTOR, ASSET, DEPOSIT_ACCOUNT, DEPOSIT_PRODUCT, TRANSACTION_CHANNEL, TRANSACTION_TYPE, BRANCH, CENTRE, USER]
The date the custom field definition was created.
2016-09-06T13:37:50+03:00Can be defined only for selection custom field definitions. Indicates the parent custom field definition on which the dependency is based upon.
displaySettings object
Represents the display settings of a custom field definition.
The original ID of the built-in custom field definition.
Possible values: [FIRST_NAME, MIDDLE_NAME, LAST_NAME, BIRTHDATE, GENDER, MOBILE_PHONE, MOBILE_PHONE_2, HOME_PHONE, EMAIL_ADDRESS]
The user-provided description of the custom field definition.
The user-provided name of the custom field definition.
The custom field value display size in the UI.
Possible values: [SHORT, LONG]
The custom field definition position in the custom field set.
editRights object
Represents the edit rights for custom field values for a particular custom field definition.
TRUE if custom field values of a custom field definition can be edited by all users, FALSE if custom field values of a custom field definition can only be edited by users with the specified roles.
The list of IDs of the roles that have edit rights for the custom field values of a custom field definition if it is not accessible by all users.
The encoded key of the entity, generated, globally unique
The user-defined ID, which is globally unique.
The date the latest update was performed for this custom field definition.
2016-09-06T13:37:50+03:00selectionOptions object[]
Can be defined only for selection custom field definitions. Indicates that the field has predefined selections and only those can be used to populate it.
availableOptions object[]
The list of options that that are available for the dependent selection custom field value based on the selected parent custom field value.
The score of the option.
The system-generated ID of the option.
The name of the option.
The key for the parent selection custom field value.
The parent selection custom field value.
Indicates whether the custom field definition is active or inactive.
Possible values: [ACTIVE, INACTIVE]
The type of custom field definition.
Possible values: [FREE_TEXT, SELECTION, NUMBER, CHECKBOX, DATE, DATE_TIME, CLIENT_LINK, GROUP_LINK, USER_LINK]
usage object[]
Represents the usage settings of a custom field definition.
TRUE if the field is displayed by default on create or edit pages for this record type, FALSE otherwise.
The key of the record type.
TRUE if the field is required for this record type, FALSE otherwise.
valueValidationSettings object
Represents the settings for field input validation.
TRUE if this field does not allow duplicate values, FALSE otherwise.
The expected format for the input.
viewRights object
Represents the view rights for custom field values for a particular custom field definition.
TRUE if custom field values of a custom field definition can be viewed by all users, FALSE if custom field values of a custom field definition can only be viewed by users with the specified roles.
Lists the IDs of the roles that have view rights for the custom field values of a custom field definition if it is not accessible by all users.
depositConstraints objectrequired
The constraints applied to the transaction channel
constraints object[]
Holds the custom constraints, only for the limited usage case. For the unconstrainedcase, no constraints are applied
Defines the criteria on which the constraint is applied
Possible values: [AMOUNT, TYPE, PRODUCT]
Defines the constraint operator. Example: in 'Amount Equals 100' it is the 'Equals'
Possible values: [EQUALS, EMPTY, NOT_EMPTY, MORE_THAN, LESS_THAN, BETWEEN, IN]
The second filtering value of the filter parameter (constraint). It might not exist. Example: it represents '500' from 'Amount Between 100 and 500'
The first filtering value of the filter constraint. Example: it represents 'Disbursement' from 'Type equals Disbursement' and it also represents 100 from 'Amount Between 100 and 500'
Filtering values used for the Product and Type criteria, where filtering might be applied on one or more values
Holds the match filter option for the constraints. It can be ALL so all the constraints must match, or ANY so at least one must match
Possible values: [ALL, ANY]
States the limited/unconstrained usage of the transaction channel
Possible values: [UNCONSTRAINED, LIMITED]
The encoded key of the entity, generated, globally unique
The general ledger (GL) account associated with the transaction channel.
The ID of the transaction channel.
TRUE if the transaction channel is set as the default, FALSE otherwise.
loanConstraints objectrequired
The constraints applied to the transaction channel
constraints object[]
Holds the custom constraints, only for the limited usage case. For the unconstrainedcase, no constraints are applied
Defines the criteria on which the constraint is applied
Possible values: [AMOUNT, TYPE, PRODUCT]
Defines the constraint operator. Example: in 'Amount Equals 100' it is the 'Equals'
Possible values: [EQUALS, EMPTY, NOT_EMPTY, MORE_THAN, LESS_THAN, BETWEEN, IN]
The second filtering value of the filter parameter (constraint). It might not exist. Example: it represents '500' from 'Amount Between 100 and 500'
The first filtering value of the filter constraint. Example: it represents 'Disbursement' from 'Type equals Disbursement' and it also represents 100 from 'Amount Between 100 and 500'
Filtering values used for the Product and Type criteria, where filtering might be applied on one or more values
Holds the match filter option for the constraints. It can be ALL so all the constraints must match, or ANY so at least one must match
Possible values: [ALL, ANY]
States the limited/unconstrained usage of the transaction channel
Possible values: [UNCONSTRAINED, LIMITED]
The name of the transaction channel.
The state of the transaction channel.
Possible values: [ACTIVE, INACTIVE]
The usage rights that describe the transaction channel.
{
"attributes": {
"overdraftAllowed": true
},
"availableForAll": true,
"customFields": [
{
"availableFor": "CLIENT",
"creationDate": "2016-09-06T13:37:50+03:00",
"dependentFieldKey": "string",
"displaySettings": {
"builtInId": "FIRST_NAME",
"description": "string",
"displayName": "string",
"fieldSize": "SHORT",
"position": 0
},
"editRights": {
"allUsers": true,
"roles": [
"string"
]
},
"encodedKey": "string",
"id": "string",
"lastModifiedDate": "2016-09-06T13:37:50+03:00",
"selectionOptions": [
{
"availableOptions": [
{
"score": 0,
"selectionKey": "string",
"value": "string"
}
],
"forSelectionKey": "string",
"forValue": "string"
}
],
"state": "ACTIVE",
"type": "FREE_TEXT",
"usage": [
{
"default": true,
"objectKey": "string",
"required": true
}
],
"valueValidationSettings": {
"unique": true,
"validationPattern": "string"
},
"viewRights": {
"allUsers": true,
"roles": [
"string"
]
}
}
],
"depositConstraints": {
"constraints": [
{
"criteria": "AMOUNT",
"operator": "EQUALS",
"secondValue": "string",
"value": "string",
"values": [
"string"
]
}
],
"matchFiltersOption": "ALL",
"usage": "UNCONSTRAINED"
},
"encodedKey": "string",
"glAccount": "string",
"id": "string",
"isDefault": true,
"loanConstraints": {
"constraints": [
{
"criteria": "AMOUNT",
"operator": "EQUALS",
"secondValue": "string",
"value": "string",
"values": [
"string"
]
}
],
"matchFiltersOption": "ALL",
"usage": "UNCONSTRAINED"
},
"name": "string",
"state": "ACTIVE",
"usageRights": [
"string"
]
}