Search

/

Reference

Pages

Homeorganizationproductsdeposit accountsloan accountstransactionsservicesledgersuserssystem

System Management

This page includes endpoints to configure the Core Banking system such as backups, custom fields, imports, jobs and tasks.

TASKS

Package tasks allows you to retrieve, create, update or delete tasks. A task represents a human task that can be assigned by a user to another.

CreateTask

POST /v1/tasks

Creates a new task..

Request Body (Task)
Name Description Type
task_id The uniquely generated ID of the task String
title The title of the task String
status The status of the task Status
description The extra context provided by the user for the task String
assignee_id The ID of the user this task is assigned to String
assigner_full_name The name of the user that created the task String
assigner_id The ID of the user that created this task String
linked_id The ID of the object linked to the task String
linked_type The type of the object linked to by the task LinkedType
template_id The ID of the template used to create the task String
due_time The time at which the task has to be completed Timestamp
create_time The time at which the task was created Timestamp
update_time The time at which the task was last updated Timestamp
  • Name Description Type
    task_id The uniquely generated ID of the task String
    title The title of the task String
    status The status of the task Status
    description The extra context provided by the user for the task String
    assignee_id The ID of the user this task is assigned to String
    assigner_full_name The name of the user that created the task String
    assigner_id The ID of the user that created this task String
    linked_id The ID of the object linked to the task String
    linked_type The type of the object linked to by the task LinkedType
    template_id The ID of the template used to create the task String
    due_time The time at which the task has to be completed Timestamp
    create_time The time at which the task was created Timestamp
    update_time The time at which the task was last updated Timestamp

ListTasks

GET /v1/tasks

Lists tasks..

Parameters
Name Description Type
Query Parameters
page_token The token of the page to be returned String
page_size The number of tasks to be returned Integer
order_by The field to order the tasks by String
filter The filter to apply to the tasks String
  • Name Description Type
    total The total number of tasks matching the filter Integer
    remaining The number of tasks remaining in the list, including the tasks in the response Integer
    tasks The list of tasks Array[Task]
    next_page_token The token of the next page String

GetTask

GET /v1/tasks/{TaskID}

Retrieves a task..

Parameters
Name Description Type
Query Parameters
task_id The ID of the task to retrieve String
  • Name Description Type
    task_id The uniquely generated ID of the task String
    title The title of the task String
    status The status of the task Status
    description The extra context provided by the user for the task String
    assignee_id The ID of the user this task is assigned to String
    assigner_full_name The name of the user that created the task String
    assigner_id The ID of the user that created this task String
    linked_id The ID of the object linked to the task String
    linked_type The type of the object linked to by the task LinkedType
    template_id The ID of the template used to create the task String
    due_time The time at which the task has to be completed Timestamp
    create_time The time at which the task was created Timestamp
    update_time The time at which the task was last updated Timestamp

UpdateTask

PUT /v1/tasks/{TaskID}

Updates an existing task..

Parameters
Name Description Type
Query Parameters
task_id The ID of the task to update String
Request Body (Task)
Name Description Type
task_id The uniquely generated ID of the task String
title The title of the task String
status The status of the task Status
description The extra context provided by the user for the task String
assignee_id The ID of the user this task is assigned to String
assigner_full_name The name of the user that created the task String
assigner_id The ID of the user that created this task String
linked_id The ID of the object linked to the task String
linked_type The type of the object linked to by the task LinkedType
template_id The ID of the template used to create the task String
due_time The time at which the task has to be completed Timestamp
create_time The time at which the task was created Timestamp
update_time The time at which the task was last updated Timestamp
  • Name Description Type
    task_id The uniquely generated ID of the task String
    title The title of the task String
    status The status of the task Status
    description The extra context provided by the user for the task String
    assignee_id The ID of the user this task is assigned to String
    assigner_full_name The name of the user that created the task String
    assigner_id The ID of the user that created this task String
    linked_id The ID of the object linked to the task String
    linked_type The type of the object linked to by the task LinkedType
    template_id The ID of the template used to create the task String
    due_time The time at which the task has to be completed Timestamp
    create_time The time at which the task was created Timestamp
    update_time The time at which the task was last updated Timestamp

DeleteTask

DELETE /v1/tasks/{TaskID}

Deletes an existing task..

Parameters
Name Description Type
Query Parameters
task_id The ID of the task to delete String

FIELDS

Package fields allows retrieving custom fields.

CreateSet

POST /v1/fields

Creates a new custom field set..

Request Body (Set)
Name Description Type
set_id The unique user-defined ID String
name The user-provided name of the custom field set String
description The user-provided description of the custom field set String
allow_duplicates True if the same field set may appear in the same entity multiple times Boolean
valid_for The associated entity the field can be used in AvailableFor
state The state of the custom field set State
create_time When the field set was created Timestamp
update_time The time when the field set was last updated Timestamp
  • Name Description Type
    set_id The unique user-defined ID String
    name The user-provided name of the custom field set String
    description The user-provided description of the custom field set String
    allow_duplicates True if the same field set may appear in the same entity multiple times Boolean
    valid_for The associated entity the field can be used in AvailableFor
    state The state of the custom field set State
    create_time When the field set was created Timestamp
    update_time The time when the field set was last updated Timestamp

ListSets

GET /v1/fields

Lists custom field sets..

Parameters
Name Description Type
Query Parameters
page_token The token when retrieving the next page of results String
page_size The number of results to return per page Integer
order_by The field to order the results by String
filter The filter to apply to the results String
  • Name Description Type
    total The total number of sets matching the filter Integer
    remaining The number of sets remaining in the list, including the sets in the response Integer
    sets The list of custom field sets Array[Set]
    next_page_token The token when retrieving the next page of results String

GetSet

GET /v1/fields/{SetID}

Retrieves the specified custom field set..

Parameters
Name Description Type
Query Parameters
set_id The ID of the field set to retrieve String
  • Name Description Type
    set_id The unique user-defined ID String
    name The user-provided name of the custom field set String
    description The user-provided description of the custom field set String
    allow_duplicates True if the same field set may appear in the same entity multiple times Boolean
    valid_for The associated entity the field can be used in AvailableFor
    state The state of the custom field set State
    create_time When the field set was created Timestamp
    update_time The time when the field set was last updated Timestamp

UpdateSet

PUT /v1/fields/{SetID}

Updates the specified custom field set..

Parameters
Name Description Type
Query Parameters
set_id The ID of the field set to update String
Request Body (Set)
Name Description Type
set_id The unique user-defined ID String
name The user-provided name of the custom field set String
description The user-provided description of the custom field set String
allow_duplicates True if the same field set may appear in the same entity multiple times Boolean
valid_for The associated entity the field can be used in AvailableFor
state The state of the custom field set State
create_time When the field set was created Timestamp
update_time The time when the field set was last updated Timestamp
  • Name Description Type
    set_id The unique user-defined ID String
    name The user-provided name of the custom field set String
    description The user-provided description of the custom field set String
    allow_duplicates True if the same field set may appear in the same entity multiple times Boolean
    valid_for The associated entity the field can be used in AvailableFor
    state The state of the custom field set State
    create_time When the field set was created Timestamp
    update_time The time when the field set was last updated Timestamp

DeleteSet

DELETE /v1/fields/{SetID}

Deletes the specified custom field set..

Parameters
Name Description Type
Query Parameters
set_id The ID of the field set to delete String

CreateField

POST /v1/fields/{SetID}/fields

Creates a new field in a field set..

Parameters
Name Description Type
Query Parameters
set_id The ID of the field set to create the field in String
body The value of the field to create Field
  • Name Description Type
    field_id The ID of the field which uniquely identifies the field's values String
    type The type of the field Type
    name The name for the field String
    description The description for the field String
    options The list of options for the field Array[String]
    usage A list of usage information for the field Usage
    validation_rule The validation rules for the field ValidationRule
    view_rights The viewing permissions for the field Array[String]
    edit_rights The editing permissions for the field Array[String]

ListSetFields

GET /v1/fields/{SetID}/fields

Lists all of the fields in a field set..

Parameters
Name Description Type
Query Parameters
set_id The ID of the field set to retrieve fields from String
page_token The token when retrieving the next page of results String
page_size The number of results to return per page Integer
order_by The field to order the results by String
filter The filter to apply to the results String
  • Name Description Type
    total The total number of fields matching the filter Integer
    remaining The number of fields remaining in the list, including the fields in the response Integer
    fields The retrieved fields of the field set Array[Field]
    next_page_token The token when retrieving the next page of results String

GetField

GET /v1/fields/{SetID}/fields/{FieldID}

Retrieves the specified field in a field set..

Parameters
Name Description Type
Query Parameters
set_id The ID of the field set to retrieve fields from String
field_id The ID of the field to retrieve String
  • Name Description Type
    field_id The ID of the field which uniquely identifies the field's values String
    type The type of the field Type
    name The name for the field String
    description The description for the field String
    options The list of options for the field Array[String]
    usage A list of usage information for the field Usage
    validation_rule The validation rules for the field ValidationRule
    view_rights The viewing permissions for the field Array[String]
    edit_rights The editing permissions for the field Array[String]

UpdateField

POST /v1/fields/{SetID}/fields/{FieldID}

Updates the specified field in the field set..

Parameters
Name Description Type
Query Parameters
set_id The ID of the field set to update String
field_id The ID of the field to update String
body The new value of the field Field
  • Name Description Type
    field_id The ID of the field which uniquely identifies the field's values String
    type The type of the field Type
    name The name for the field String
    description The description for the field String
    options The list of options for the field Array[String]
    usage A list of usage information for the field Usage
    validation_rule The validation rules for the field ValidationRule
    view_rights The viewing permissions for the field Array[String]
    edit_rights The editing permissions for the field Array[String]

DeleteField

DELETE /v1/fields/{SetID}/fields/{FieldID}

Deletes the specified field from the field set..

Parameters
Name Description Type
Query Parameters
set_id The ID of the field set String
field_id The ID of the field to delete String

UTIL

Package util is a utility service primary for testing.

Echo

GET /v1/util/echo

Echoes a message..

Parameters
Name Description Type
Query Parameters
msg The message to echo back String
  • Name Description Type
    msg The message to echo back String

BACKUPS

Package backup allows creating and retrieving backups.

CreateBackup

POST /v1/backup

Triggers a new database backup..

Parameters
Name Description Type
Query Parameters
callback_url The URL to send a webhook to when the backup is ready String
  • Name Description Type
    backup_id The ID of the backup String
    status The status of the backup Status
    create_time The time the backup was triggered Timestamp
    complete_time The time of completion of the backup, if it has completed Timestamp

ListBackups

GET /v1/backup

Lists backups..

Parameters
Name Description Type
Query Parameters
page_token The token of the page to return String
page_size The number of backups to return Integer
order_by The field to order the backups by String
filter The filter to apply to the backups String
  • Name Description Type
    total The total number of backups matching the filter Integer
    remaining The number of backups remaining in the list, including the backups in the response Integer
    backups The list of backups retrieved Array[Backup]
    next_page_token The token of the next page String

GetBackup

GET /v1/backup/{BackupID}

Retrieves the specified database backup..

Parameters
Name Description Type
Query Parameters
backup_id The ID of the backup to retrieve String
  • Name Description Type
    backup_id The ID of the backup String
    status The status of the backup Status
    create_time The time the backup was triggered Timestamp
    complete_time The time of completion of the backup, if it has completed Timestamp

DownloadBackup

GET /v1/backup/{BackupID}/download

Downloads the specified database backup..

Parameters
Name Description Type
Query Parameters
backup_id The ID of the backup to download String
  • Name Description Type
    content The raw content of the file encoded in base64 Bytes

JOBS

Package jobs allows running of EOD (End of Day) and hourly jobs. This service is available only if manual eod processing is enabled.

RunEOD

POST /v1/jobs/eod

Runs end of day processing jobs..

  • Name Description Type
    status The status of the job Status
    start_time The time the job started Timestamp

RunHourly

POST /v1/jobs/hourly

Runs hourly processing jobs..

  • Name Description Type
    status The status of the job Status
    start_time The time the job started Timestamp

IMPORTS

Package imports allows creating and managing data imports.

CreateImport

POST /v1/imports

Creates a new file to be processed..

Request Body (File)
Name Description Type
content The raw content of the file encoded in base64 Bytes
  • Name Description Type
    import_id The ID of the import String
    importer_id The ID of the user that initiated the import String
    status The current status of the import Status
    errors A list of errors encountered during the import Array[Error]
    progress The current estimated progress of the import in percentage, ranging from 0 to 100 Float(64)

ListImports

GET /v1/imports

Lists imports based on the query..

Parameters
Name Description Type
Query Parameters
page_token The token of the page to return String
page_size The number of imports to return Integer
order_by The field to order imports by String
filter The filter to apply to the imports String
  • Name Description Type
    total The total number of imports matching the filter Integer
    remaining The number of imports remaining in the list, including the imports in the response Integer
    imports The list of imports Array[Import]
    next_page_token The token of the next page String

GetImport

GET /v1/imports/{ImportID}

Retrieves the status of an import, and any errors that occurred during the import..

Parameters
Name Description Type
Query Parameters
import_id The ID of the import to retrieve the status for String
  • Name Description Type
    import_id The ID of the import String
    importer_id The ID of the user that initiated the import String
    status The current status of the import Status
    errors A list of errors encountered during the import Array[Error]
    progress The current estimated progress of the import in percentage, ranging from 0 to 100 Float(64)

UpdateImport

POST /v1/imports/{ImportID}

Updates the status of an import, preparing it for importing or discarding it..

Parameters
Name Description Type
Query Parameters
import_id The ID of the import to update String
Request Body (Import)
Name Description Type
import_id The ID of the import String
importer_id The ID of the user that initiated the import String
status The current status of the import Status
errors A list of errors encountered during the import Array[Error]
progress The current estimated progress of the import in percentage, ranging from 0 to 100 Float(64)
  • Name Description Type
    import_id The ID of the import String
    importer_id The ID of the user that initiated the import String
    status The current status of the import Status
    errors A list of errors encountered during the import Array[Error]
    progress The current estimated progress of the import in percentage, ranging from 0 to 100 Float(64)

Address

The address of an entity..

Name Description Type
extended The extended address of the entity such as apartment or suite number String
street The street address of the entity String
city The city of the address String
region The region of the address String
post_code The postal code for the address String
country The full name of the country of the location String
latitude The GPS latitude in the signed degree format (DD.dddddd), eg String
longitude The GPS longitude in the signed degree format (DDD.dddddd), eg String

Amount

A monetary amount in the specified currency..

Name Description Type
cur The ISO3 currency code of the currency String
val The amount of the currency, in the smallest unit of the currency String

ContactInfo

The contact information of an entity..

Name Description Type
full_name The full name of the entity String
addresses The list of the addresses for the entity Array[Address]
telephones A list of telephone numbers for the entity Array[String]
emails A list of email addresses for the entity Array[String]
language The preferred language for contacting the entity String

Entity

A type of a client..

Name Description
Client
Group

File

A binary file..

Name Description Type
content The raw content of the file encoded in base64 Bytes

Operator

The set of operators that can be used to filter results..

Name Description
OpEquals
OpEqualsIgnoreCase
OpNotEquals
OpGreaterThan
OpLessThan
OpOn
OpAfter
OpBefore
OpHasPrefix
OpHasPrefixIgnoreCase
OpLastDays
OpBetween
OpIn
OpToday
OpThisWeek
OpThisMonth
OpThisYear
OpEmpty
OpNotEmpty

Permission

The permission that a user may have while interacting with the service..

Name Description
PermissionAuditTransactions
PermissionViewComments
PermissionCreateComments
PermissionEditComments
PermissionDeleteComments
PermissionCreateIndexRate
PermissionDownloadBackups
PermissionImportData
PermissionViewExchangeRates
PermissionCreateExchangeRate
PermissionViewCentreDetails
PermissionCreateCentre
PermissionEditCentre
PermissionDeleteCentre
PermissionManageConfigurationAsCode
PermissionViewBranchDetails
PermissionCreateBranch
PermissionEditBranch
PermissionCreateCommunicationTemplates
PermissionEditCommunicationTemplates
PermissionSendManualSms
PermissionSendManualEmail
PermissionViewCommunicationHistory
PermissionResendFailedMessages
PermissionViewTransactionChannels
PermissionCreateTransactionChannels
PermissionEditTransactionChannels
PermissionDeleteTransactionChannels
PermissionManageHolidays
PermissionManageEodProcessing
PermissionManageRiskLevels
PermissionViewLoanProductDetails
PermissionCreateLoanProduct
PermissionEditLoanProduct
PermissionDeleteLoanProducts
PermissionViewSavingsProductDetails
PermissionCreateSavingsProduct
PermissionEditSavingsProduct
PermissionDeleteSavingsProduct
PermissionCreateProductDocumentTemplates
PermissionEditProductDocumentTemplates
PermissionDeleteProductDocumentTemplates
PermissionViewClientDetails
PermissionCreateClient
PermissionEditClient
PermissionDeleteClients
PermissionApproveClient
PermissionRejectClient
PermissionExitClient
PermissionAnonymizeClient
PermissionBlacklistClient
PermissionUndoClientStateChanged
PermissionEditClientID
PermissionEditBlacklistedClientCfv
PermissionEditGroupID
PermissionChangeClientType
PermissionViewGroupDetails
PermissionCreateGroup
PermissionEditGroup
PermissionDeleteGroup
PermissionChangeGroupType
PermissionViewLineOfCreditDetails
PermissionCreateLinesOfCredit
PermissionEditLinesOfCredit
PermissionAddAccountsToLineOfCredit
PermissionRemoveAccountsFromLineOfCredit
PermissionApproveLineOfCredit
PermissionUndoApproveLineOfCredit
PermissionWithdrawLineOfCredit
PermissionUndoWithdrawLineOfCredit
PermissionRejectLineOfCredit
PermissionUndoRejectLineOfCredit
PermissionCloseLinesOfCredit
PermissionDeleteLinesOfCredit
PermissionViewLoanAccountDetails
PermissionCreateLoanAccount
PermissionEditLoanAccount
PermissionDeleteLoanAccount
PermissionEnterRepayment
PermissionEditRepaymentSchedule
PermissionApproveLoans
PermissionRequestLoanApproval
PermissionDiburseLoans
PermissionWithdrawLoanAccounts
PermissionUndoWithdrawLoanAccounts
PermissionSetLoanIncomplete
PermissionRejectLoans
PermissionUndoRejectLoans
PermissionCloseLoanAccounts
PermissionWriteOffLoanAccounts
PermissionTerminateLoanAccounts
PermissionPayOffLoan
PermissionUndoLoanAccountClosure
PermissionReverseLoanAccountWriteOff
PermissionRefinanceLoanAccount
PermissionRescheduleLoanAccount
PermissionApplyAccruedLoanInterest
PermissionApplyLoanFees
PermissionApplyLoanAdjustments
PermissionBackdateLoanTransactions
PermissionLinkAccounts
PermissionCollectGuaranties
PermissionViewSecuritiesDetails
PermissionCreateSecurities
PermissionEditSecurities
PermissionDeleteSecurities
PermissionLockLoanAccounts
PermissionPostTransactionsOnLockedLoanAccounts
PermissionEditLoanTranches
PermissionEditPenaltyRate
PermissionSetDisbursementConditions
PermissionEditLoanTransactions
PermissionBulkLoanCorrections
PermissionEditInterestRate
PermissionEditRepaymentMethodValue
PermissionEditPeriodicPaymentForActiveAccount
PermissionManageLoanAssociation
PermissionMakeWithdrawalRedraw
PermissionViewSavingsAccountDetails
PermissionCreateSavingsAccount
PermissionEditSavingsAccount
PermissionDeleteSavingsAccount
PermissionMakeDeposit
PermissionMakeWithdrawal
PermissionMakeEarlyWithdrawals
PermissionApproveSavings
PermissionActivateMaturity
PermissionUndoMaturity
PermissionCloseSavingsAccounts
PermissionApplySavingsFees
PermissionReopenSavingsAccount
PermissionApplySavingsAdjustments
PermissionLockSavingsAccount
PermissionUnlockSavingsAccount
PermissionReverseSavingsAccountWriteOff
PermissionBackdateSavingsTransactions
PermissionMakeTransfer
PermissionMakeInterClientsTransfers
PermissionPostTransactionsOnDormantAccounts
PermissionApplyAccruedSavingsInterest
PermissionEditSavingsTransactions
PermissionBulkDepositCorrections
PermissionBlockAndSeizeFunds
PermissionWithdrawBlockedFunds
PermissionCreateCards
PermissionViewCards
PermissionDeleteCards
PermissionReverseCardWithdrawalTransaction
PermissionReverseCardTransaction
PermissionCardBalanceInquiry
PermissionCreateAuthorizationHold
PermissionUpdateAuthorizationHold
PermissionViewAuthorizationHold
PermissionCreateCardTransaction
PermissionViewDocuments
PermissionCreateDocuments
PermissionEditDocuments
PermissionDeleteDocuments
PermissionViewTask
PermissionCreateTask
PermissionEditTask
PermissionDeleteTask
PermissionViewIntelligence
PermissionViewReports
PermissionCreateReports
PermissionEditReports
PermissionDeleteReports
PermissionViewChartOfAccounts
PermissionManageAccounts
PermissionViewJournalEntries
PermissionLogJournalEntries
PermissionViewAccountingReports
PermissionMakeAccountingClosure
PermissionApplyAccountingAdjustments
PermissionBookingDateLoansGL
PermissionBookingDateSavingsGL
PermissionRectifyAdjustment
PermissionViewAccountingRates
PermissionCreateAccountingRates
PermissionOpenTill
PermissionCloseTill
PermissionAddCash
PermissionRemoveCash
PermissionPostTransactionsWithoutOpenedTill
PermissionViewInvestorFundsDetails
PermissionCreateInvestorFunds
PermissionEditInvestorFunds
PermissionDeleteInvestorFunds
PermissionSellLoanFraction
PermissionCreateUser
PermissionEditUser
PermissionViewUserDetails
PermissionDeleteUser
PermissionManageClientAssociation
PermissionManageGroupAssociation
PermissionEditPrincipalPaymentActiveRevolvingCredit
PermissionPerformRepaymentsWithCustomAmountsAllocation
PermissionExportToExcel
PermissionViewAdministrationDetails
PermissionManageEventsStreaming
PermissionManageApps
PermissionAdmin
PermissionCreateRole
PermissionEditRole
PermissionDeleteRole
PermissionViewRole
PermissionManageFederatedAuthentication
PermissionManageAccessPreferences
PermissionViewAPIConsumersAndKeys
PermissionCreateAPIConsumersAndKeys
PermissionEditAPIConsumersAndKeys
PermissionDeleteAPIConsumersAndKeys
PermissionViewCustomField
PermissionCreateCustomField
PermissionEditCustomField
PermissionDeleteCustomField

State

The state of an entity, like a branch or a centre..

Name Description
PendingApproval
Inactive
Active
Exited
Blacklisted
Rejected

Status

The status of an asynchronous operation, long-running action, or other processes. FIXME: Review usages of this type, and move to EntityStatus where applicable. All statuses may not be applicable to all situations..

Name Description
Error
Queued
InProgress
Pending
Complete
NotFound
Cancel
ToBeCanceled
TimedOut
TransientError
Overridden

LinkedType

The type of entity that is linked to the task..

Name Description
None
Client
Group
LoanProduct
SavingsProduct
Centre
Branch
User
LoanAccount
DepositAccount
IDDocument
LineOfCredit
GLJournalEntry

Status

The state of the task, i.e. whether it still needs to be done or it has been completed..

Name Description
Open
Completed

Task

A human task that can be assigned by a user to another. Its initial status is Open..

Name Description Type
task_id The uniquely generated ID of the task String
title The title of the task String
status The status of the task Status
description The extra context provided by the user for the task String
assignee_id The ID of the user this task is assigned to String
assigner_full_name The name of the user that created the task String
assigner_id The ID of the user that created this task String
linked_id The ID of the object linked to the task String
linked_type The type of the object linked to by the task LinkedType
template_id The ID of the template used to create the task String
due_time The time at which the task has to be completed Timestamp
create_time The time at which the task was created Timestamp
update_time The time at which the task was last updated Timestamp

AvailableFor

The scope for which the field can be used..

Name Description
ForClient
ForGroup
ForCreditArrangement
ForLoanAccount
ForGuarantor
ForAsset
ForDepositAccount
ForTransactionChannel
ForTransactionType
ForBranch
ForCentre
ForUser

Field

A custom field..

Name Description Type
field_id The ID of the field which uniquely identifies the field's values String
type The type of the field Type
name The name for the field String
description The description for the field String
options The list of options for the field Array[String]
usage A list of usage information for the field Usage
validation_rule The validation rules for the field ValidationRule
view_rights The viewing permissions for the field Array[String]
edit_rights The editing permissions for the field Array[String]

Set

A set of fields..

Name Description Type
set_id The unique user-defined ID String
name The user-provided name of the custom field set String
description The user-provided description of the custom field set String
allow_duplicates True if the same field set may appear in the same entity multiple times Boolean
valid_for The associated entity the field can be used in AvailableFor
state The state of the custom field set State
create_time When the field set was created Timestamp
update_time The time when the field set was last updated Timestamp

Type

The type of a field..

Name Description
TypeFreeText
TypeParagraph
TypeSelection
TypeNumber
TypeCheckbox
TypeDate
TypeClient
TypeGroup
TypeUser

Usage

The usage information for a custom field..

Name Description Type
default Whether the field is displayed by default on create/edit page for this record type Boolean
required Whether the field is required Boolean

ValidationRule

A custom field validation rule..

Name Description Type
unique A flag indicating whether the field value must be unique Boolean
patterns A validation patterns for the field Array[String]

Backup

A database backup..

Name Description Type
backup_id The ID of the backup String
status The status of the backup Status
create_time The time the backup was triggered Timestamp
complete_time The time of completion of the backup, if it has completed Timestamp

Error

An error that occurred while attempting to import data..

Name Description Type
sheet The name of the sheet where the error was found String
row The row number where the error was found Integer
column The column number where the error was found String
message The description of what error has occurred String

Import

A data import from a file..

Name Description Type
import_id The ID of the import String
importer_id The ID of the user that initiated the import String
status The current status of the import Status
errors A list of errors encountered during the import Array[Error]
progress The current estimated progress of the import in percentage, ranging from 0 to 100 Float(64)