Branchfulldetailsapiv1

address object

Description for address in BranchFullDetailsApiV1

addressTypestring

the type of the address, eg. home, office. Deprecated.

citystring

the city

countrystring

the country

encodedKeystring

the automatically generated encoded ID for this item

indexInListinteger

the index of this address when there are multiple addresses assigned for a single entity

latitudenumber

the latitude of the address point

line1string

the first line of the address

line2string

the second line of the address

longitudenumber

the longitude of the address point

parentKeystring

the encoded key of the entity to whom this address belongs, for example, the client of group

postcodestring

the postal (zip) code of the address

regionstring

the region of the address

toBeDeletedboolean

whether this address is marked to be deleted

branchHolidays object[]

a list of holidays specific to this branch

Array [

creationDatestring

the date and time when this holdiay was created

dayOfMonthnumber

the day of the month on which this holiday falls

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

isAnnualyRecurringboolean

whether this holiday takes place every year

keyIdnumber

Description for keyId in HolidayApiV1

monthOfYearnumber

the month of the year in which this holiday takes place

namestring

the name of this holiday

yearnumber

the year in which this holiday takes place

]

creationDatestring

the date on which this branch was created

customFieldValues object[]

Description for customFieldValues in BranchFullDetailsApiV1

Array [

amountnumber

Description for amount in CustomFieldValueApiV1

customField object

Description for customField in CustomFieldValueApiV1

amounts object

used when options available for a custom field definition translate to predefined amounts, for example, when the custom field value is used to generate a score

property name*number

builtInCustomFieldIdstring

if this field is one of the built in custom fiel definitions, this will have a value. These names are reserved and you can not use them for your own custom field definitions

Possible values: [MOBILE_PHONE, EMAIL_ADDRESS, GENDER, MIDDLE_NAME, HOME_PHONE, BIRTHDATE, LAST_NAME, FIRST_NAME]

creationDatestring

the date on which this custom field definition was created

customFieldProductSettings object[]

Description for customFieldProductSettings in CustomFieldApiV1

Array [

customFieldEncodedKeystring

the key to the parent custom field definition

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

isDefaultboolean

whether this field is displayed by default when creating a new record

isRequiredboolean

whether this field is required when creating a new record

linkTypestring

the type of entity this field represents a link to

Possible values: [CLIENT_ROLE, CHANNEL, PRODUCT]

productKeystring

when the link type is product, this field should contain the encoded key of the linekd product

]

customFieldSelectionOptions object[]

Description for customFieldSelectionOptions in CustomFieldApiV1

Array [

constraint object

Description for constraint in CustomFieldSelectionApiV1

customFieldKeystring

Description for customFieldKey in CustomFilterConstraintApiV1

dataFieldTypestring

Description for dataFieldType in CustomFilterConstraintApiV1

Possible values: [NATIVE, CUSTOM]

dataFieldValuestring

Description for dataFieldValue in CustomFilterConstraintApiV1

dataItemTypestring

Description for dataItemType in CustomFilterConstraintApiV1

Possible values: [WRITTEN_OFF_LOANS, LINE_OF_CREDIT, INVESTOR_FUND, TRANSACTION_DETAILS, DOCUMENT_TEMPLATE, PRODUCT, MCC_EXPIRATION, CENTRE, REPAYMENT_COLLECTION, TASK, OUTSTANDING_PORTFOLIO_AMOUNTS, REVENUE, COMPOSED_TRANSACTIONS, UNION_TRANSACTIONS, PRINCIPAL_PAYMENT_SETTINGS, LOANS, DISBURSEMENT_DETAILS, SAVINGS_TRANSACTION, IDENTIFICATION_DOCUMENT, LOAN_PRODUCT, DISBURSED_LOANS, LOAN_GROUP, TRANSACTION_CHANNEL, CUSTOM_PREDEFINED_FEE, JOURNAL_ENTRY, ATTACHMENT, PREDEFINED_FEE, TRANCHE, TRANSACTION, INDEX_RATE_SOURCE, GROUP_ROLE, LOAN_TRANSACTION, CLIENT_ROLE, GROUP, NOTIFICATION_MESSAGE, OUTSTANDING_PORTFOLIO_ACCOUNTS, REPAYMENT, LOAN_ACCOUNT_GUARANTY, BRANCH, CURRENCY, CARD_TRANSACTION_REVERSAL, INTEREST_PRODUCT_SETTINGS, CREATED_ACCOUNTS, USER, SAVINGS_PRODUCT, CLIENT, PRODUCT_ARREARS_SETTINGS, SAVINGS, EXPENSE, INDEX_RATE, NOTIFICATION_TEMPLATE, CUSTOM_FIELD_SELECTION, ACTIVITY]

dataTypestring

Description for dataType in CustomFilterConstraintApiV1

Possible values: [ENUM, MONEY, NUMBER, DATE_UTC, JAVA_BLOB, OBJECT, BOOLEAN, DATE, PERCENT, BIG_DECIMAL, STRING, KEY, LONG]

encodedKeystring

Description for encodedKey in CustomFilterConstraintApiV1

filterElementstring

Description for filterElement in CustomFilterConstraintApiV1

Possible values: [STARTS_WITH_CASE_SENSITIVE, THIS_WEEK, EQUALS, STARTS_WITH, IN, TODAY, THIS_YEAR, BETWEEN, AFTER, LESS_THAN, DIFFERENT_THAN, THIS_MONTH, NOT_EMPTY, BEFORE, EQUALS_CASE_SENSITIVE, LAST_DAYS, MORE_THAN, EMPTY, ON]

groupNumbernumber

Description for groupNumber in CustomFilterConstraintApiV1

indexnumber

Description for index in CustomFilterConstraintApiV1

linkingOperatorstring

Description for linkingOperator in CustomFilterConstraintApiV1

Possible values: [OR, AND]

secondValuestring

Description for secondValue in CustomFilterConstraintApiV1

valuestring

Description for value in CustomFilterConstraintApiV1

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

idstring

the ID of this selectable item

scorenumber

the score assigned to this selection

valuestring

display name of this option

]

customFieldSet object

Description for customFieldSet in CustomFieldApiV1

builtInTypestring

if this set is part of the set of built-in custom field sets, its type will be shown here

Possible values: [DETAILS, GENERAL]

createdDatestring

the date and time when this custom field set was created

customFields object[]

an array of custom field definitions included in this custom field set

Array [

]

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

idstring

the ID of this custom field set

indexInListnumber

for field sets that can be added to an entity more than once, this number represents the index in the list and is used when changing values

lastModifiedDatestring

the date on which this custom field set was last modified

namestring

the name of this custom field set

notesstring

any notes regarding this custom field set

typestring

the entity type that this custom field definition is attached to

Possible values: [USER_INFO, ASSET_INFO, CLIENT_INFO, LINE_OF_CREDIT, GROUP_INFO, TRANSACTION_CHANNEL_INFO, BRANCH_INFO, SAVINGS_ACCOUNT_INFO, LOAN_ACCOUNT_INFO, GUARANTOR_INFO, CENTRE_INFO]

usagestring

whether this custom field set can only be used once, or added multiple times to the same entity

Possible values: [SINGLE, GROUPED]

dataTypestring

the type of custom field definition

Possible values: [GROUP_LINK, DATE, NUMBER, CHECKBOX, CLIENT_LINK, STRING, USER_LINK, SELECTION]

descriptionstring

a brief description of this custom field definition

editRights object

Description for editRights in CustomFieldApiV1

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

isAccessibleByAllUsersboolean

Description for isAccessibleByAllUsers in UsageRightsApiV1

rolesstring[]

Description for roles in UsageRightsApiV1

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

idstring

the ID for this custom field definition

indexInListnumber

Description for indexInList in CustomFieldApiV1

isDefaultboolean

whether this field will be included by default on new records

isRequiredboolean

whether this field is required when creating a new record

lastModifiedDatestring

the date on which this custom field definition was last modified

namestring

the name of this custom field definition

statestring

whether this field is available for use or has been deactivated

Possible values: [DEACTIVATED, NORMAL]

typestring

the type of data this custom field definition will contain

uniqueboolean

whether the data in this custom field definition needs to be a unique value

validationPatternstring

a user-provided pattern to which data in this custom field definition must conform where @ represents numbers, # represents letters and $ is either a number or letter. Other special characters used as separators are allowed, for example @@-##-$$$

valueLengthstring

whether this field needs to support a large number of characters

Possible values: [SHORT, LONG]

valuesstring[]

a list of possible values when the field is a selection field

viewRights object

Description for viewRights in CustomFieldApiV1

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

isAccessibleByAllUsersboolean

Description for isAccessibleByAllUsers in UsageRightsApiV1

rolesstring[]

Description for roles in UsageRightsApiV1

customFieldIDstring

Description for customFieldID in CustomFieldValueApiV1

customFieldKeystring

Description for customFieldKey in CustomFieldValueApiV1

customFieldSetGroupIndexnumber

Description for customFieldSetGroupIndex in CustomFieldValueApiV1

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

indexInListnumber

Description for indexInList in CustomFieldValueApiV1

linkedEntityKeyValuestring

Description for linkedEntityKeyValue in CustomFieldValueApiV1

parentKeystring

Description for parentKey in CustomFieldValueApiV1

selectionKeystring

Description for selectionKey in CustomFieldValueApiV1

valuestring

Description for value in CustomFieldValueApiV1

]

emailAddressstring

the email address for this branch

encodedKeystring

the automatically generated encoded ID for this item

idstring

the user provided ID for this branch

lastModifiedDatestring

the date on which the details for this branch were last modified

namestring

the name of this branch

notesstring

notes associated with this branch

phoneNumberstring

the contact telephone number for this branch

statestring

wether this branch is active or not

Possible values: [ACTIVE, INACTIVE]

Branchfulldetailsapiv1
{
  "address": {
    "addressType": "string",
    "city": "string",
    "country": "string",
    "encodedKey": "string",
    "indexInList": 0,
    "latitude": 0,
    "line1": "string",
    "line2": "string",
    "longitude": 0,
    "parentKey": "string",
    "postcode": "string",
    "region": "string",
    "toBeDeleted": true
  },
  "branchHolidays": [
    {
      "creationDate": "string",
      "dayOfMonth": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "isAnnualyRecurring": true,
      "keyId": 0,
      "monthOfYear": 0,
      "name": "string",
      "year": 0
    }
  ],
  "creationDate": "string",
  "customFieldValues": [
    {
      "amount": 0,
      "customField": {
        "amounts": {},
        "builtInCustomFieldId": "MOBILE_PHONE",
        "creationDate": "string",
        "customFieldProductSettings": [
          {
            "customFieldEncodedKey": "string",
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "isDefault": true,
            "isRequired": true,
            "linkType": "CLIENT_ROLE",
            "productKey": "string"
          }
        ],
        "customFieldSelectionOptions": [
          {
            "constraint": {
              "customFieldKey": "string",
              "dataFieldType": "NATIVE",
              "dataFieldValue": "string",
              "dataItemType": "WRITTEN_OFF_LOANS",
              "dataType": "ENUM",
              "encodedKey": "string",
              "filterElement": "STARTS_WITH_CASE_SENSITIVE",
              "groupNumber": 0,
              "index": 0,
              "linkingOperator": "OR",
              "secondValue": "string",
              "value": "string"
            },
            "encodedKey": "8a19b7057471f4af017472dc0fd80472",
            "id": "string",
            "score": 0,
            "value": "string"
          }
        ],
        "customFieldSet": {
          "builtInType": "DETAILS",
          "createdDate": "string",
          "customFields": [
            {}
          ],
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "id": "string",
          "indexInList": 0,
          "lastModifiedDate": "string",
          "name": "string",
          "notes": "string",
          "type": "USER_INFO",
          "usage": "SINGLE"
        },
        "dataType": "GROUP_LINK",
        "description": "string",
        "editRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        },
        "encodedKey": "8a19b7057471f4af017472dc0fd80472",
        "id": "string",
        "indexInList": 0,
        "isDefault": true,
        "isRequired": true,
        "lastModifiedDate": "string",
        "name": "string",
        "state": "DEACTIVATED",
        "type": "USER_INFO",
        "unique": true,
        "validationPattern": "string",
        "valueLength": "SHORT",
        "values": [
          "string"
        ],
        "viewRights": {
          "encodedKey": "8a19b7057471f4af017472dc0fd80472",
          "isAccessibleByAllUsers": true,
          "roles": [
            "string"
          ]
        }
      },
      "customFieldID": "string",
      "customFieldKey": "string",
      "customFieldSetGroupIndex": 0,
      "encodedKey": "8a19b7057471f4af017472dc0fd80472",
      "indexInList": 0,
      "linkedEntityKeyValue": "string",
      "parentKey": "string",
      "selectionKey": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "encodedKey": "string",
  "id": "string",
  "lastModifiedDate": "string",
  "name": "string",
  "notes": "string",
  "phoneNumber": "string",
  "state": "ACTIVE"
}