Create/Add new COA on iFix for a tenant
Details for the new COA + RequestHeader (meta data of the API).
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.
time in epoch
The version of the API
Unique request message id from the caller
Capture the user information
System Generated User id of the authenticated user.
List of roles assigned to a user
List of tenants assigned to a user
Hash describing the current RequestHeader
Captures the COA data as map
Unique system generated UUID
Chart of account concatinated string
Unique tenant identifier
Capture the major head code
Capture the major head code name
Capture the major head code type
"Revenue"Capture the sub major head code
Capture the sub major head code name
Capture the minor head code
Capture the minor head code name
Capture the sub head code
Capture the sub head code name
Capture the group head code
Capture the group head code name
Capture the object head code
Capture the object head code name
Collection of audit related fields used by most models
UUID (preferred) or userid of the user that created the object
UUID (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Request has been accepted for processing
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.
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing
Hash describing the current Request
The version of the API
Unique system generated UUID
Chart of account concatinated string
Unique tenant identifier
Capture the major head code
Capture the major head code name
Capture the major head code type
"Revenue"Capture the sub major head code
Capture the sub major head code name
Capture the minor head code
Capture the minor head code name
Capture the sub head code
Capture the sub head code name
Capture the group head code
Capture the group head code name
Capture the object head code
Capture the object head code name
Collection of audit related fields used by most models
UUID (preferred) or userid of the user that created the object
UUID (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Based on the criteria get the list of COA.
RequestHeader meta data.
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.
time in epoch
The version of the API
Unique request message id from the caller
Capture the user information
System Generated User id of the authenticated user.
List of roles assigned to a user
List of tenants assigned to a user
Hash describing the current RequestHeader
The object contains all the search criteria of the fund
Tenant Id
List of COA ids
Chart of account concatinated string
Search by major head
Search by sub major head
Search by minor head
Search by sub head
Search by group head
Search by object head
Successful response
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.
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing
Hash describing the current Request
The version of the API
Unique system generated UUID
Chart of account concatinated string
Unique tenant identifier
Capture the major head code
Capture the major head code name
Capture the major head code type
"Revenue"Capture the sub major head code
Capture the sub major head code name
Capture the minor head code
Capture the minor head code name
Capture the sub head code
Capture the sub head code name
Capture the group head code
Capture the group head code name
Capture the object head code
Capture the object head code name
Collection of audit related fields used by most models
UUID (preferred) or userid of the user that created the object
UUID (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Create/Add new Department Entity on iFix for a tenant
Details for the new Department Entity + RequestHeader (meta data of the API).
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.
time in epoch
The version of the API
Unique request message id from the caller
Capture the user information
System Generated User id of the authenticated user.
List of roles assigned to a user
List of tenants assigned to a user
Hash describing the current RequestHeader
Unique system generated UUID
Unique tenant identifier
Department id from department master
Unique the department entity code
Captures the department entity name
Capture the level of the given department entity
UUID of the child department entity
status of the relationship. In case, the child needs to be removed from the list, mark the status as false.
Collection of audit related fields used by most models
UUID (preferred) or userid of the user that created the object
UUID (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Request has been accepted for processing
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.
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing
Hash describing the current Request
The version of the API
Unique system generated UUID
Unique tenant identifier
Department id from department master
Unique the department entity code
Captures the department entity name
Capture the level of the given department entity
UUID of the child department entity
status of the relationship. In case, the child needs to be removed from the list, mark the status as false.
Collection of audit related fields used by most models
UUID (preferred) or userid of the user that created the object
UUID (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Based on the criteria get the list of department entities.
RequestHeader meta data.
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.
time in epoch
The version of the API
Unique request message id from the caller
Capture the user information
System Generated User id of the authenticated user.
List of roles assigned to a user
List of tenants assigned to a user
Hash describing the current RequestHeader
The object contains all the search criteria of Department Entity
Department Entity Ids
Tenant Id
Department id from department master
Unique the department entity code
Captures the department entity name
Capture the level of department entity
If set to true, it will return all the department entity hierarchy details starting from the root to the specified department entity id.
Successful response
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.
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing
Hash describing the current Request
The version of the API
Unique system generated UUID
Unique tenant identifier
Department id from department master
Unique the department entity code
Captures the department entity name
Capture the level of the given department entity
UUID of the child department entity
status of the relationship. In case, the child needs to be removed from the list, mark the status as false.
Collection of audit related fields used by most models
UUID (preferred) or userid of the user that created the object
UUID (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Create/Add new DepartmentHierarchyLevel on iFix for a tenant
Details for the new DepartmentHierarchyLevel + RequestHeader (meta data of the API).
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.
time in epoch
The version of the API
Unique request message id from the caller
Capture the user information
System Generated User id of the authenticated user.
List of roles assigned to a user
List of tenants assigned to a user
Hash describing the current RequestHeader
This object captures the information for level of the department hierarchy and it's alias
Unique system generated UUID
Unique tenant identifier
Department id from department master
Unique department hierarchy level code
"state, zone, city etc"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.
The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's
2Collection of audit related fields used by most models
UUID (preferred) or userid of the user that created the object
UUID (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Request has been accepted for processing
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.
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing
Hash describing the current Request
The version of the API
Unique system generated UUID
Unique tenant identifier
Department id from department master
Unique department hierarchy level code
"state, zone, city etc"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.
The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's
2Collection of audit related fields used by most models
UUID (preferred) or userid of the user that created the object
UUID (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Based on the criteria get the list of Department Hierarchy Levels.
RequestHeader meta data.
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.
time in epoch
The version of the API
Unique request message id from the caller
Capture the user information
System Generated User id of the authenticated user.
List of roles assigned to a user
List of tenants assigned to a user
Hash describing the current RequestHeader
The object contains all the search criteria of Department Hierarchy Level
Department Hierarchy Level Ids
Tenant Id
Department id from department master
Unique department hierarchy label like state, district, etc.
The level of the department hierarchy level
Successful response
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.
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing
Hash describing the current Request
The version of the API
Unique system generated UUID
Unique tenant identifier
Department id from department master
Unique department hierarchy level code
"state, zone, city etc"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.
The level of current DepartmentHierarchyLevel will be set as 1 greater than it's parent's
2Collection of audit related fields used by most models
UUID (preferred) or userid of the user that created the object
UUID (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Update existing Department Entity on iFix for a tenant
Details for the update Department Entity + RequestHeader (meta data of the API).
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.
time in epoch
The version of the API
Unique request message id from the caller
Capture the user information
System Generated User id of the authenticated user.
List of roles assigned to a user
List of tenants assigned to a user
Hash describing the current RequestHeader
Unique system generated UUID
Unique tenant identifier
Department id from department master
Unique the department entity code
Captures the department entity name
Capture the level of the given department entity
UUID of the child department entity
status of the relationship. In case, the child needs to be removed from the list, mark the status as false.
Collection of audit related fields used by most models
UUID (preferred) or userid of the user that created the object
UUID (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
Request has been accepted for processing
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.
response time in epoch
unique response message id (UUID) - will usually be the correlation id from the server
message id of the request
status of request processing
Hash describing the current Request
The version of the API
Unique system generated UUID
Unique tenant identifier
Department id from department master
Unique the department entity code
Captures the department entity name
Capture the level of the given department entity
UUID of the child department entity
status of the relationship. In case, the child needs to be removed from the list, mark the status as false.
Collection of audit related fields used by most models
UUID (preferred) or userid of the user that created the object
UUID (preferred) or userid of the user that last modified the object
epoch of the time object is created
epoch of the time object is last modified
This object captures the fiscal information of program service to exchange between domains.
| Field | Type | Description |
|---|---|---|
Header to exchange information between different domains
| Field | Type | Description |
|---|---|---|
Captures the codes and type and status of the fiscal message
| Field | Type | Description |
|---|---|---|
The model extends exchangeCode and captures specific attributes used for sanction
| Field | Type | Description |
|---|---|---|
The model extends exchangeCode and captures specific attributes used for sanction
| Field | Type | Description |
|---|---|---|
The model extends exchangeCode and captures specific attributes used for allocation
| Field | Type | Description |
|---|---|---|
The model extends exchangeCode and captures specific attributes used for disbursement
| Field | Type | Description |
|---|---|---|
signature
String
Signature for verification
header
RequestHeader
Header for exchange between different domains.
message
String
Contains the fiscal message.
message_id
String
Unique Identifier
message_ts
String
Message time-stamp
message_type
MessageType
Enum with values: program/on-program sanction/on-sanction allocation/on-allocation disburse/on-disburse
action
Action
Enum with values: create update search
sender_id
String
Id of the service sending message
sender_uri
String
Uri of the sending service
receiver_id
String
Id of the receiver
is_msg_encrypted
boolean
Specifies if message is encrypted
id
String(2, 64)
Unique identifier
type
String(2, 64)
Type of message
function_code
String(2, 64)
Major head code
administration_code
String(2, 64)
Major head name
recipient_segment_code
String(2, 64)
Major head code type
economic_segment_code
String(2, 64)
Sub-Major head code
source_of_fund_code
String(2, 64)
Sub-Major head name
target_segment_code
String(2, 64)
Minor head code
currency_code
String(2, 64)
Minor head name
locale_code
String(2, 64)
Sub-Head code
status
Status
Contains status code and status message.
location_code
String(2, 64)
tenantId
program_code
String(2, 64)
Formatted unique identifier of program
name
String(2, 64)
Name of Program
parent_id
String(2, 64)
parentId of program
description
String(2, 256)
description of program
start_date
long
Start date of program
end_date
long
End date of program
additional_details
JsonNode
any additional details if required
audit_details
AuditDetails
Captures created time, last modified time, created domain and last modified domain
children
Program
Any children program
location_code
String(2, 64)
tenant id
program_code
String(2, 64)
Code of the applicable program
net_amount
Double
Sanctioned net amount
gross_amount
Double
Sanctioned gross amount
allocatedAmount
Double
Allocated amount
availableAmount
Double
Available amount
additional_details
JsonNode
any additional details if required
audit_details
AuditDetails
Captures created time, last modified time, created domain and last modified domain
children
List<Sanction>
List of children Sanctions
location_code
String(2, 64)
tenant id
program_code
String(2, 64)
Formatted unique identifier of program
sanction_id
String(2, 64)
Unique identifier of sanction
net_amount
Double
Net allocated amount
gross_amount
Double
Gross allocated amount
allocation_type
AllocationType
Can be Allocation or Deduction
additional_details
JsonNode
Any additional details if required
audit_details
AuditDetails
Captures created time, last modified time, created domain and last modified domain
children
List<Allocation>
List of children allocations
location_code
String(2, 64)
tenat id
program_code
String(2, 64)
Formatted unique identifier of program
target_id
String(2, 64)
Reference to payment number.
parent_id
String(2, 64)
Parent disbursement id
sanction_id
String(2, 64)
Id of the sanction the given disbursement belongs.
transaction_id
String(2, 64)
Reference to unique identifier received from ifms system
account_code
String(2, 64)
Account number and ifsc to disburse to
net_amount
Double
Net disbursement amount
gross_amount
Double
Gross disbursement amount
individual
Individual
Captures individual details such as name, phone, etc
additional_details
JsonNode
Any additional details if required
audit_details
AuditDetails
Captures created time, last modified time, created domain and last modified domain
children
List<Disbursement>
List of children disbursement