Information Model

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