1 of 1

APIs

iFIX Master Data APIs

iFIX Department Entity Service APIs

APIs

iFIX Master Data APIs

Create/Add new COA on iFix for a tenant

POST/chartOfAccount/v1/_create

Body

Details for the new COA + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseHeader in the response body to ensure correlation.

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

chartOfAccountChartOfAccount (object)

Captures the COA data as map

idstring

Unique system generated UUID

coaCodestring

Chart of account concatinated string

tenantIdstring

Unique tenant identifier

majorHead*string

Capture the major head code

majorHeadNamestring

Capture the major head code name

majorHeadTypestring

Capture the major head code type

Example: "Revenue"

subMajorHead*string

Capture the sub major head code

subMajorHeadNamestring

Capture the sub major head code name

minorHead*string

Capture the minor head code

minorHeadNamestring

Capture the minor head code name

subHead*string

Capture the sub head code

subHeadNamestring

Capture the sub head code name

groupHead*string

Capture the group head code

groupHeadNamestring

Capture the group head code name

objectHead*string

Capture the object head code

objectHeadNamestring

Capture the object head code name

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

attributesobject

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

ResponseHeader should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseHeader should always correspond to the same values in respective request's RequestHeader.

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

chartOfAccountsarray of ChartOfAccount (object)

idstring

Unique system generated UUID

coaCodestring

Chart of account concatinated string

tenantIdstring

Unique tenant identifier

majorHead*string

Capture the major head code

majorHeadNamestring

Capture the major head code name

majorHeadTypestring

Capture the major head code type

Example: "Revenue"

subMajorHead*string

Capture the sub major head code

subMajorHeadNamestring

Capture the sub major head code name

minorHead*string

Capture the minor head code

minorHeadNamestring

Capture the minor head code name

subHead*string

Capture the sub head code

subHeadNamestring

Capture the sub head code name

groupHead*string

Capture the group head code

groupHeadNamestring

Capture the group head code name

objectHead*string

Capture the object head code

objectHeadNamestring

Capture the object head code name

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

attributesobject

Request

const response = await fetch('/chartOfAccount/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "chartOfAccounts": [
    {
      "id": "text",
      "coaCode": "text",
      "tenantId": "text",
      "majorHead": "text",
      "majorHeadName": "text",
      "majorHeadType": "Revenue",
      "subMajorHead": "text",
      "subMajorHeadName": "text",
      "minorHead": "text",
      "minorHeadName": "text",
      "subHead": "text",
      "subHeadName": "text",
      "groupHead": "text",
      "groupHeadName": "text",
      "objectHead": "text",
      "objectHeadName": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Get the list COA.

Based on the criteria get the list of COA.

POST/chartOfAccount/v1/_search

Body

RequestHeader meta data.

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

criteria*COASearchCriteria (object)

The object contains all the search criteria of the fund

tenantId*string

Tenant Id

Idsarray of string

List of COA ids

itemsstring

coaCodesarray of string

itemsstring

Chart of account concatinated string

majorHeadstring

Search by major head

subMajorHeadstring

Search by sub major head

minorHeadstring

Search by minor head

subHeadstring

Search by sub head

groupHeadstring

Search by group head

objectHeadstring

Search by object head

Response

Successful response

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

chartOfAccountsarray of ChartOfAccount (object)

idstring

Unique system generated UUID

coaCodestring

Chart of account concatinated string

tenantIdstring

Unique tenant identifier

majorHead*string

Capture the major head code

majorHeadNamestring

Capture the major head code name

majorHeadTypestring

Capture the major head code type

Example: "Revenue"

subMajorHead*string

Capture the sub major head code

subMajorHeadNamestring

Capture the sub major head code name

minorHead*string

Capture the minor head code

minorHeadNamestring

Capture the minor head code name

subHead*string

Capture the sub head code

subHeadNamestring

Capture the sub head code name

groupHead*string

Capture the group head code

groupHeadNamestring

Capture the group head code name

objectHead*string

Capture the object head code

objectHeadNamestring

Capture the object head code name

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

attributesobject

Request

const response = await fetch('/chartOfAccount/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "criteria": {
        "tenantId": "text"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "chartOfAccounts": [
    {
      "id": "text",
      "coaCode": "text",
      "tenantId": "text",
      "majorHead": "text",
      "majorHeadName": "text",
      "majorHeadType": "Revenue",
      "subMajorHead": "text",
      "subMajorHeadName": "text",
      "minorHead": "text",
      "minorHeadName": "text",
      "subHead": "text",
      "subHeadName": "text",
      "groupHead": "text",
      "groupHeadName": "text",
      "objectHead": "text",
      "objectHeadName": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

iFIX Department Entity Service APIs

Create/Add new Department Entity on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_create

Body

Details for the new Department Entity + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

DepartmentEntityobject

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

any

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentEntityarray of DepartmentEntity (object)

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Update existing Department Entity on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_update

Body

Details for the update Department Entity + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

DepartmentEntity*all of

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

any

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentEntityarray of DepartmentEntity (object)

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Get Department Entity details.

Based on the criteria get the list of department entities.

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_search

Body

RequestHeader meta data.

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

criteria*DepartmentEntitySearchCriteria (object)

The object contains all the search criteria of Department Entity

Idsarray of string

Department Entity Ids

itemsstring

tenantId*string

Tenant Id

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelinteger

Capture the level of department entity

getAncestryboolean

If set to true, it will return all the department entity hierarchy details starting from the root to the specified department entity id.

Response

Successful response

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentEntityarray of DepartmentEntity (object)

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Create/Add new DepartmentHierarchyLevel on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/hierarchyLevel/v1/_create

Body

Details for the new DepartmentHierarchyLevel + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

departmentHierarchyLevel*DepartmentHierarchyLevel (object)

This object captures the information for level of the department hierarchy and it's alias

id*string

Unique system generated UUID

tenantId*string

Unique tenant identifier

departmentId*string

Department id from department master

label*string

Unique department hierarchy level code

Example: "state, zone, city etc"

parentnullable string

Capture the department hierarchy level of the parent id (UUID). If it is the root level it will not have any parent. There can only be one root element for a given department.

levelnumber

The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's

Example: 2

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentHierarchyLevelarray of DepartmentHierarchyLevel (object)

id*string

Unique system generated UUID

tenantId*string

Unique tenant identifier

departmentId*string

Department id from department master

label*string

Unique department hierarchy level code

Example: "state, zone, city etc"

parentnullable string

Capture the department hierarchy level of the parent id (UUID). If it is the root level it will not have any parent. There can only be one root element for a given department.

levelnumber

The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's

Example: 2

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Get DepartmentHierarchyLevel.

Based on the criteria get the list of Department Hierarchy Levels.

POSThttps://<server_address>/ifix-department-entity/departmentEntity/hierarchyLevel/v1/_search

Body

RequestHeader meta data.

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

criteria*DepartmentHierarchyLevelSearchCriteria (object)

The object contains all the search criteria of Department Hierarchy Level

Idsarray of string

Department Hierarchy Level Ids

itemsstring

tenantId*string

Tenant Id

departmentIdstring

Department id from department master

labelstring

Unique department hierarchy label like state, district, etc.

levelnumber

The level of the department hierarchy level

Response

Successful response

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentHierarchyLevelarray of DepartmentHierarchyLevel (object)

id*string

Unique system generated UUID

tenantId*string

Unique tenant identifier

departmentId*string

Department id from department master

label*string

Unique department hierarchy level code

Example: "state, zone, city etc"

parentnullable string

Capture the department hierarchy level of the parent id (UUID). If it is the root level it will not have any parent. There can only be one root element for a given department.

levelnumber

The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's

Example: 2

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Create/Add new Department Entity on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_create

Body

Details for the new Department Entity + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

DepartmentEntityobject

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

any

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentEntityarray of DepartmentEntity (object)

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Get Department Entity details.

Based on the criteria get the list of department entities.

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_search

Body

RequestHeader meta data.

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

criteria*DepartmentEntitySearchCriteria (object)

The object contains all the search criteria of Department Entity

Idsarray of string

Department Entity Ids

itemsstring

tenantId*string

Tenant Id

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelinteger

Capture the level of department entity

getAncestryboolean

If set to true, it will return all the department entity hierarchy details starting from the root to the specified department entity id.

Response

Successful response

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentEntityarray of DepartmentEntity (object)

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Create/Add new DepartmentHierarchyLevel on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/hierarchyLevel/v1/_create

Body

Details for the new DepartmentHierarchyLevel + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

departmentHierarchyLevel*DepartmentHierarchyLevel (object)

This object captures the information for level of the department hierarchy and it's alias

id*string

Unique system generated UUID

tenantId*string

Unique tenant identifier

departmentId*string

Department id from department master

label*string

Unique department hierarchy level code

Example: "state, zone, city etc"

parentnullable string

Capture the department hierarchy level of the parent id (UUID). If it is the root level it will not have any parent. There can only be one root element for a given department.

levelnumber

The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's

Example: 2

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentHierarchyLevelarray of DepartmentHierarchyLevel (object)

id*string

Unique system generated UUID

tenantId*string

Unique tenant identifier

departmentId*string

Department id from department master

label*string

Unique department hierarchy level code

Example: "state, zone, city etc"

parentnullable string

Capture the department hierarchy level of the parent id (UUID). If it is the root level it will not have any parent. There can only be one root element for a given department.

levelnumber

The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's

Example: 2

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Get DepartmentHierarchyLevel.

Based on the criteria get the list of Department Hierarchy Levels.

POSThttps://<server_address>/ifix-department-entity/departmentEntity/hierarchyLevel/v1/_search

Body

RequestHeader meta data.

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

criteria*DepartmentHierarchyLevelSearchCriteria (object)

The object contains all the search criteria of Department Hierarchy Level

Idsarray of string

Department Hierarchy Level Ids

itemsstring

tenantId*string

Tenant Id

departmentIdstring

Department id from department master

labelstring

Unique department hierarchy label like state, district, etc.

levelnumber

The level of the department hierarchy level

Response

Successful response

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentHierarchyLevelarray of DepartmentHierarchyLevel (object)

id*string

Unique system generated UUID

tenantId*string

Unique tenant identifier

departmentId*string

Department id from department master

label*string

Unique department hierarchy level code

Example: "state, zone, city etc"

parentnullable string

Capture the department hierarchy level of the parent id (UUID). If it is the root level it will not have any parent. There can only be one root element for a given department.

levelnumber

The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's

Example: 2

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

Update existing Department Entity on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_update

Body

Details for the update Department Entity + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

DepartmentEntity*all of

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

any

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

departmentEntityarray of DepartmentEntity (object)

idstring

Unique system generated UUID

tenantIdstring

Unique tenant identifier

departmentIdstring

Department id from department master

codestring

Unique the department entity code

namestring

Captures the department entity name

hierarchyLevelnumber

Capture the level of the given department entity

childrenarray of DepartmentEntityChildren (object)

childIdstring

UUID of the child department entity

statusboolean

status of the relationship. In case, the child needs to be removed from the list, mark the status as false.

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

Response

const response = await fetch('https://<server_address>/ifix-department-entity/departmentEntity/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestHeader": {}
    }),
});
const data = await response.json();

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "departmentEntity": [
    {
      "id": "text",
      "tenantId": "text",
      "departmentId": "text",
      "code": "text",
      "name": "text",
      "hierarchyLevel": 0,
      "children": [
        {
          "childId": "text",
          "status": false
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

const response = await fetch('https://<server_address>/ifix-department-entity/departmentEntity/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "criteria": {
        "tenantId": "text"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "departmentEntity": [
    {
      "id": "text",
      "tenantId": "text",
      "departmentId": "text",
      "code": "text",
      "name": "text",
      "hierarchyLevel": 0,
      "children": [
        {
          "childId": "text",
          "status": false
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

const response = await fetch('https://<server_address>/ifix-department-entity/departmentEntity/hierarchyLevel/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "departmentHierarchyLevel": {
        "departmentId": "text",
        "id": "text",
        "label": "state, zone, city etc",
        "tenantId": "text"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "departmentHierarchyLevel": [
    {
      "id": "text",
      "tenantId": "text",
      "departmentId": "text",
      "label": "state, zone, city etc",
      "parent": "text",
      "level": 2,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

const response = await fetch('https://<server_address>/ifix-department-entity/departmentEntity/hierarchyLevel/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "criteria": {
        "tenantId": "text"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "departmentHierarchyLevel": [
    {
      "id": "text",
      "tenantId": "text",
      "departmentId": "text",
      "label": "state, zone, city etc",
      "parent": "text",
      "level": 2,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

const response = await fetch('https://<server_address>/ifix-department-entity/departmentEntity/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "DepartmentEntity": {},
      "requestHeader": {}
    }),
});
const data = await response.json();

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "departmentEntity": [
    {
      "id": "text",
      "tenantId": "text",
      "departmentId": "text",
      "code": "text",
      "name": "text",
      "hierarchyLevel": 0,
      "children": [
        {
          "childId": "text",
          "status": false
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Create/Add new COA on iFix for a tenant

POST/chartOfAccount/v1/_create

Body

Details for the new COA + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

chartOfAccountChartOfAccount (object)

Captures the COA data as map

idstring

Unique system generated UUID

coaCodestring

Chart of account concatinated string

tenantIdstring

Unique tenant identifier

majorHead*string

Capture the major head code

majorHeadNamestring

Capture the major head code name

majorHeadTypestring

Capture the major head code type

Example: "Revenue"

subMajorHead*string

Capture the sub major head code

subMajorHeadNamestring

Capture the sub major head code name

minorHead*string

Capture the minor head code

minorHeadNamestring

Capture the minor head code name

subHead*string

Capture the sub head code

subHeadNamestring

Capture the sub head code name

groupHead*string

Capture the group head code

groupHeadNamestring

Capture the group head code name

objectHead*string

Capture the object head code

objectHeadNamestring

Capture the object head code name

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

attributesobject

Response

Request has been accepted for processing

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

chartOfAccountsarray of ChartOfAccount (object)

idstring

Unique system generated UUID

coaCodestring

Chart of account concatinated string

tenantIdstring

Unique tenant identifier

majorHead*string

Capture the major head code

majorHeadNamestring

Capture the major head code name

majorHeadTypestring

Capture the major head code type

Example: "Revenue"

subMajorHead*string

Capture the sub major head code

subMajorHeadNamestring

Capture the sub major head code name

minorHead*string

Capture the minor head code

minorHeadNamestring

Capture the minor head code name

subHead*string

Capture the sub head code

subHeadNamestring

Capture the sub head code name

groupHead*string

Capture the group head code

groupHeadNamestring

Capture the group head code name

objectHead*string

Capture the object head code

objectHeadNamestring

Capture the object head code name

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

attributesobject

Request

const response = await fetch('/chartOfAccount/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "chartOfAccounts": [
    {
      "id": "text",
      "coaCode": "text",
      "tenantId": "text",
      "majorHead": "text",
      "majorHeadName": "text",
      "majorHeadType": "Revenue",
      "subMajorHead": "text",
      "subMajorHeadName": "text",
      "minorHead": "text",
      "minorHeadName": "text",
      "subHead": "text",
      "subHeadName": "text",
      "groupHead": "text",
      "groupHeadName": "text",
      "objectHead": "text",
      "objectHeadName": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Get the list COA.

Based on the criteria get the list of COA.

POST/chartOfAccount/v1/_search

Body

RequestHeader meta data.

requestHeader*RequestHeader (object)

tsinteger (int64)

time in epoch

versionstring

The version of the API

msgIdstring

Unique request message id from the caller

userInfoUserInfo (object)

Capture the user information

uuidstring

System Generated User id of the authenticated user.

rolesarray of string

List of roles assigned to a user

itemsstring

tenantsarray of string

List of tenants assigned to a user

itemsstring

attributesobject

correlationIdstring

signaturestring

Hash describing the current RequestHeader

criteria*COASearchCriteria (object)

The object contains all the search criteria of the fund

tenantId*string

Tenant Id

Idsarray of string

List of COA ids

itemsstring

coaCodesarray of string

itemsstring

Chart of account concatinated string

majorHeadstring

Search by major head

subMajorHeadstring

Search by sub major head

minorHeadstring

Search by minor head

subHeadstring

Search by sub head

groupHeadstring

Search by group head

objectHeadstring

Search by object head

Response

Successful response

Body

responseHeaderResponseHeader (object)

tsinteger (int64)

response time in epoch

correlationIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

statusenum

status of request processing

SUCCESSFAILED

signaturestring

Hash describing the current Request

versionstring

The version of the API

chartOfAccountsarray of ChartOfAccount (object)

idstring

Unique system generated UUID

coaCodestring

Chart of account concatinated string

tenantIdstring

Unique tenant identifier

majorHead*string

Capture the major head code

majorHeadNamestring

Capture the major head code name

majorHeadTypestring

Capture the major head code type

Example: "Revenue"

subMajorHead*string

Capture the sub major head code

subMajorHeadNamestring

Capture the sub major head code name

minorHead*string

Capture the minor head code

minorHeadNamestring

Capture the minor head code name

subHead*string

Capture the sub head code

subHeadNamestring

Capture the sub head code name

groupHead*string

Capture the group head code

groupHeadNamestring

Capture the group head code name

objectHead*string

Capture the object head code

objectHeadNamestring

Capture the object head code name

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

UUID (preferred) or userid of the user that created the object

lastModifiedBystring

UUID (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

attributesobject

Request

const response = await fetch('/chartOfAccount/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "criteria": {
        "tenantId": "text"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "chartOfAccounts": [
    {
      "id": "text",
      "coaCode": "text",
      "tenantId": "text",
      "majorHead": "text",
      "majorHeadName": "text",
      "majorHeadType": "Revenue",
      "subMajorHead": "text",
      "subMajorHeadName": "text",
      "minorHead": "text",
      "minorHeadName": "text",
      "subHead": "text",
      "subHeadName": "text",
      "groupHead": "text",
      "groupHeadName": "text",
      "objectHead": "text",
      "objectHeadName": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}