1 of 3

Technical Specification

Information Model

Government
Department
Department Entity (For example, Ropar Water Department)
Chart of Account
Expenditure
Project
Fiscal Event

APIs (v 0.1)

Business Services
Fiscal Event
- Post-Fiscal Event
- Search Fiscal Event

All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

Information Model

Government

This object captures the fiscal information of external systems.

Field

Type

Description

Department

Captures the department attributes.

Field

Type

Description

Chart of Account

Captures the COA data as a map.

Field

Type

Description

Expenditure

Captures the Expenditure attributes - encapsulates all scheme and non-scheme expenditure details.

Field

Type

Description

Project

Captures the Project attributes.

Field

Type

Description

Amount

Field

Type

Description

Fiscal Event

APIs

iFIX Fiscal Event Service APIs

iFIX Master Data APIs

Technical Specification

Information Model

Government
Department
Department Entity (For example, Ropar Water Department)
Chart of Account
Expenditure
Project
Fiscal Event

APIs (v 0.1)

Business Services
Fiscal Event
- Post-Fiscal Event
- Search Fiscal Event

All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

APIs

iFIX Fiscal Event Service APIs

Create(publish) new fiscal event on iFix

Create the new fiscal event

POSThttps://<server_address>/fiscal-event-service/fiscal/events/v1/_publish

Body

Details for the new fiscal event + 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

fiscalEventarray of FiscalEvent (object)

versionstring

Version of the Data Model Definition

Example: "1.0.0"

idstring

System generated UUID.

Example: "fecbbf1d-d6e3-4f24-9935-02c33b9248e0"

tenantId*string

Tenant Id

Example: "pb"

senderstring

Client id of the registered source system(Get the client id from the request header)

receiversarray of string

Client ids of the registered data receivers system

itemsstring

eventType*string

Captures the event type (eg- 1.a. DEMAND, 1.b. BILL, 2.a. RECEIPT, 2.b. PAYMENT, 2.c. INTER_TRANSFER, 2.d. INTRA_TRANSFER, 3.a. SANCTION, 3.b. APPROPRIATION, 3.c. ALLOCATION)

Example: "Appropriation"

eventTimeinteger (int64)

when the event occured at source system level

Example: 1628177497000

ingestionTimeinteger (int64)

when the event arrived in ifix

Example: 1628177497000

referenceId*string

reference unique id(transaction id) of the caller system

Example: "013e9c56-8207-4dac-9f4d-f1e20bd824e7"

linkedEventIdnullable string

If this is a follow up event then it will refer to the parent event using this reference id.

Example: "7d476bb0-bc9f-48e2-8ad4-5a4a36220779"

linkedReferenceIdnullable string

If this is a follow up event then it will refer to the parent event in source system using this reference id.

Example: "77f23efe-879d-407b-8f23-7b8dd5b2ecb1"

amountDetails*array of Amount (object)

idstring

System generated UUID

Example: "51c9c03c-1607-4dd5-9e0e-93bbf860f6f7"

amount*number

Transaction Amount

Example: 10234.5

coaCode*string

Chart of account code. Publish request should contain coaCode, but search response will not contain it.

Example: "1234-123-123-12-12-12"

coaIdstring

Unique system generated Chart of Account UUID

Example: "e9f940d4-69aa-4bbb-aa82-111b8948a6b6"

fromBillingPeriodinteger (int64)

Start date of the billing period for which transaction is applicable

Example: 1622907239000

toBillingPeriodinteger (int64)

Start date of the billing period for which transaction is applicable

Example: 1628177643000

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

locationLocation (object)

Capture the location where fiscal event happened. This object represent geographical hierarchy

codestring

location code

hierarchyTypestring

location hierarchy type

Example: "State, District etc"

namestring

location name

childLocation (object)

Capture the location where fiscal event happened. This object represent geographical hierarchy

Circular reference to Location (object) ↩

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

Capture the extra information as a json

Response

Event published successfully

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

fiscalEventarray of FiscalEvent (object)

versionstring

Version of the Data Model Definition

Example: "1.0.0"

idstring

System generated UUID.

Example: "fecbbf1d-d6e3-4f24-9935-02c33b9248e0"

tenantId*string

Tenant Id

Example: "pb"

senderstring

Client id of the registered source system(Get the client id from the request header)

receiversarray of string

Client ids of the registered data receivers system

itemsstring

eventType*string

Captures the event type (eg- 1.a. DEMAND, 1.b. BILL, 2.a. RECEIPT, 2.b. PAYMENT, 2.c. INTER_TRANSFER, 2.d. INTRA_TRANSFER, 3.a. SANCTION, 3.b. APPROPRIATION, 3.c. ALLOCATION)

Example: "Appropriation"

eventTimeinteger (int64)

when the event occured at source system level

Example: 1628177497000

ingestionTimeinteger (int64)

when the event arrived in ifix

Example: 1628177497000

referenceId*string

reference unique id(transaction id) of the caller system

Example: "013e9c56-8207-4dac-9f4d-f1e20bd824e7"

linkedEventIdnullable string

If this is a follow up event then it will refer to the parent event using this reference id.

Example: "7d476bb0-bc9f-48e2-8ad4-5a4a36220779"

linkedReferenceIdnullable string

If this is a follow up event then it will refer to the parent event in source system using this reference id.

Example: "77f23efe-879d-407b-8f23-7b8dd5b2ecb1"

amountDetails*array of Amount (object)

idstring

System generated UUID

Example: "51c9c03c-1607-4dd5-9e0e-93bbf860f6f7"

amount*number

Transaction Amount

Example: 10234.5

coaCode*string

Chart of account code. Publish request should contain coaCode, but search response will not contain it.

Example: "1234-123-123-12-12-12"

coaIdstring

Unique system generated Chart of Account UUID

Example: "e9f940d4-69aa-4bbb-aa82-111b8948a6b6"

fromBillingPeriodinteger (int64)

Start date of the billing period for which transaction is applicable

Example: 1622907239000

toBillingPeriodinteger (int64)

Start date of the billing period for which transaction is applicable

Example: 1628177643000

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

locationLocation (object)

Capture the location where fiscal event happened. This object represent geographical hierarchy

codestring

location code

hierarchyTypestring

location hierarchy type

Example: "State, District etc"

namestring

location name

childLocation (object)

Capture the location where fiscal event happened. This object represent geographical hierarchy

Circular reference to Location (object) ↩

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

Capture the extra information as a json

Request

Response

Get the list fiscal events.

Based on the criteria get the list of events.

POSThttps://<server_address>/fiscal-event-service/fiscal/events/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

criteriaCriteria (object)

The object contains all the search criteria of the fiscal events

Idsarray of string

List of event ids

itemsstring

tenantId*string

Tenant Id

eventType*string

Captures the event type(eg- bill, receipt, expenditure)

fromEventTimeinteger (int64)

Search events b/w transaction time(Start date)

toEventTimeinteger (int64)

Search events b/w transaction time(End date)

referenceIdarray of string

itemsstring

receiverstring

Client id of the registered data receiver system

Example: "mGramSeva"

fromIngestionTimeinteger (int64)

Search events b/w ingestion time(the time when event published)

toIngestionTimeinteger (int64)

Search events b/w ingestion time(the time when event published)

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

fiscalEventarray of FiscalEvent (object)

versionstring

Version of the Data Model Definition

Example: "1.0.0"

idstring

System generated UUID.

Example: "fecbbf1d-d6e3-4f24-9935-02c33b9248e0"

tenantId*string

Tenant Id

Example: "pb"

senderstring

Client id of the registered source system(Get the client id from the request header)

receiversarray of string

Client ids of the registered data receivers system

itemsstring

eventType*string

Captures the event type (eg- 1.a. DEMAND, 1.b. BILL, 2.a. RECEIPT, 2.b. PAYMENT, 2.c. INTER_TRANSFER, 2.d. INTRA_TRANSFER, 3.a. SANCTION, 3.b. APPROPRIATION, 3.c. ALLOCATION)

Example: "Appropriation"

eventTimeinteger (int64)

when the event occured at source system level

Example: 1628177497000

ingestionTimeinteger (int64)

when the event arrived in ifix

Example: 1628177497000

referenceId*string

reference unique id(transaction id) of the caller system

Example: "013e9c56-8207-4dac-9f4d-f1e20bd824e7"

linkedEventIdnullable string

If this is a follow up event then it will refer to the parent event using this reference id.

Example: "7d476bb0-bc9f-48e2-8ad4-5a4a36220779"

linkedReferenceIdnullable string

If this is a follow up event then it will refer to the parent event in source system using this reference id.

Example: "77f23efe-879d-407b-8f23-7b8dd5b2ecb1"

amountDetails*array of Amount (object)

idstring

System generated UUID

Example: "51c9c03c-1607-4dd5-9e0e-93bbf860f6f7"

amount*number

Transaction Amount

Example: 10234.5

coaCode*string

Chart of account code. Publish request should contain coaCode, but search response will not contain it.

Example: "1234-123-123-12-12-12"

coaIdstring

Unique system generated Chart of Account UUID

Example: "e9f940d4-69aa-4bbb-aa82-111b8948a6b6"

fromBillingPeriodinteger (int64)

Start date of the billing period for which transaction is applicable

Example: 1622907239000

toBillingPeriodinteger (int64)

Start date of the billing period for which transaction is applicable

Example: 1628177643000

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

locationLocation (object)

Capture the location where fiscal event happened. This object represent geographical hierarchy

codestring

location code

hierarchyTypestring

location hierarchy type

Example: "State, District etc"

namestring

location name

childLocation (object)

Capture the location where fiscal event happened. This object represent geographical hierarchy

Circular reference to Location (object) ↩

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

Capture the extra information as a json

Request

Response

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)

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

Response

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

Response

Information Model

Government

This object captures the fiscal information of external systems.

Field

Type

Description

Department

Captures the department attributes.

Field

Type

Description

Chart of Account

Captures the COA data as a map.

Field

Type

Description

Expenditure

Captures the Expenditure attributes - encapsulates all scheme and non-scheme expenditure details.

Field

Type

Description

Project

Captures the Project attributes.

Field

Type

Description

Amount

Field

Type

Description

Fiscal Event

Field

Type

Description

All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

Create(publish) new fiscal event on iFix

Create the new fiscal event

POSThttps://<server_address>/fiscal-event-service/fiscal/events/v1/_publish

Body

Details for the new fiscal event + 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

fiscalEventarray of FiscalEvent (object)

versionstring

Version of the Data Model Definition

Example: "1.0.0"

idstring

System generated UUID.

Example: "fecbbf1d-d6e3-4f24-9935-02c33b9248e0"

tenantId*string

Tenant Id

Example: "pb"

senderstring

Client id of the registered source system(Get the client id from the request header)

receiversarray of string

Client ids of the registered data receivers system

itemsstring

eventType*string

Captures the event type (eg- 1.a. DEMAND, 1.b. BILL, 2.a. RECEIPT, 2.b. PAYMENT, 2.c. INTER_TRANSFER, 2.d. INTRA_TRANSFER, 3.a. SANCTION, 3.b. APPROPRIATION, 3.c. ALLOCATION)

Example: "Appropriation"

eventTimeinteger (int64)

when the event occured at source system level

Example: 1628177497000

ingestionTimeinteger (int64)

when the event arrived in ifix

Example: 1628177497000

referenceId*string

reference unique id(transaction id) of the caller system

Example: "013e9c56-8207-4dac-9f4d-f1e20bd824e7"

linkedEventIdnullable string

If this is a follow up event then it will refer to the parent event using this reference id.

Example: "7d476bb0-bc9f-48e2-8ad4-5a4a36220779"

linkedReferenceIdnullable string

If this is a follow up event then it will refer to the parent event in source system using this reference id.

Example: "77f23efe-879d-407b-8f23-7b8dd5b2ecb1"

amountDetails*array of Amount (object)

idstring

System generated UUID

Example: "51c9c03c-1607-4dd5-9e0e-93bbf860f6f7"

amount*number

Transaction Amount

Example: 10234.5

coaCode*string

Chart of account code. Publish request should contain coaCode, but search response will not contain it.

Example: "1234-123-123-12-12-12"

coaIdstring

Unique system generated Chart of Account UUID

Example: "e9f940d4-69aa-4bbb-aa82-111b8948a6b6"

fromBillingPeriodinteger (int64)

Start date of the billing period for which transaction is applicable

Example: 1622907239000

toBillingPeriodinteger (int64)

Start date of the billing period for which transaction is applicable

Example: 1628177643000

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

locationLocation (object)

Capture the location where fiscal event happened. This object represent geographical hierarchy

codestring

location code

hierarchyTypestring

location hierarchy type

Example: "State, District etc"

namestring

location name

childLocation (object)

Capture the location where fiscal event happened. This object represent geographical hierarchy

Circular reference to Location (object) ↩

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

Capture the extra information as a json

Response

Event published successfully

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

fiscalEventarray of FiscalEvent (object)

versionstring

Version of the Data Model Definition

Example: "1.0.0"

idstring

System generated UUID.

Example: "fecbbf1d-d6e3-4f24-9935-02c33b9248e0"

tenantId*string

Tenant Id

Example: "pb"

senderstring

Client id of the registered source system(Get the client id from the request header)

receiversarray of string

Client ids of the registered data receivers system

itemsstring

eventType*string

Captures the event type (eg- 1.a. DEMAND, 1.b. BILL, 2.a. RECEIPT, 2.b. PAYMENT, 2.c. INTER_TRANSFER, 2.d. INTRA_TRANSFER, 3.a. SANCTION, 3.b. APPROPRIATION, 3.c. ALLOCATION)

Example: "Appropriation"

eventTimeinteger (int64)

when the event occured at source system level

Example: 1628177497000

ingestionTimeinteger (int64)

when the event arrived in ifix

Example: 1628177497000

referenceId*string

reference unique id(transaction id) of the caller system

Example: "013e9c56-8207-4dac-9f4d-f1e20bd824e7"

linkedEventIdnullable string

If this is a follow up event then it will refer to the parent event using this reference id.

Example: "7d476bb0-bc9f-48e2-8ad4-5a4a36220779"

linkedReferenceIdnullable string

If this is a follow up event then it will refer to the parent event in source system using this reference id.

Example: "77f23efe-879d-407b-8f23-7b8dd5b2ecb1"

amountDetails*array of Amount (object)

idstring

System generated UUID

Example: "51c9c03c-1607-4dd5-9e0e-93bbf860f6f7"

amount*number

Transaction Amount

Example: 10234.5

coaCode*string

Chart of account code. Publish request should contain coaCode, but search response will not contain it.

Example: "1234-123-123-12-12-12"

coaIdstring

Unique system generated Chart of Account UUID

Example: "e9f940d4-69aa-4bbb-aa82-111b8948a6b6"

fromBillingPeriodinteger (int64)

Start date of the billing period for which transaction is applicable

Example: 1622907239000

toBillingPeriodinteger (int64)

Start date of the billing period for which transaction is applicable

Example: 1628177643000

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

locationLocation (object)

Capture the location where fiscal event happened. This object represent geographical hierarchy

codestring

location code

hierarchyTypestring

location hierarchy type

Example: "State, District etc"

namestring

location name

childLocation (object)

Capture the location where fiscal event happened. This object represent geographical hierarchy

Circular reference to Location (object) ↩

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

Capture the extra information as a json

Request

Response

Get the list fiscal events.

Based on the criteria get the list of events.

POSThttps://<server_address>/fiscal-event-service/fiscal/events/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

criteriaCriteria (object)

The object contains all the search criteria of the fiscal events

Idsarray of string

List of event ids

itemsstring

tenantId*string

Tenant Id

eventType*string

Captures the event type(eg- bill, receipt, expenditure)

fromEventTimeinteger (int64)

Search events b/w transaction time(Start date)

toEventTimeinteger (int64)

Search events b/w transaction time(End date)

referenceIdarray of string

itemsstring

receiverstring

Client id of the registered data receiver system

Example: "mGramSeva"

fromIngestionTimeinteger (int64)

Search events b/w ingestion time(the time when event published)

toIngestionTimeinteger (int64)

Search events b/w ingestion time(the time when event published)

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

fiscalEventarray of FiscalEvent (object)

versionstring

Version of the Data Model Definition

Example: "1.0.0"

idstring

System generated UUID.

Example: "fecbbf1d-d6e3-4f24-9935-02c33b9248e0"

tenantId*string

Tenant Id

Example: "pb"

senderstring

Client id of the registered source system(Get the client id from the request header)

receiversarray of string

Client ids of the registered data receivers system

itemsstring

eventType*string

Captures the event type (eg- 1.a. DEMAND, 1.b. BILL, 2.a. RECEIPT, 2.b. PAYMENT, 2.c. INTER_TRANSFER, 2.d. INTRA_TRANSFER, 3.a. SANCTION, 3.b. APPROPRIATION, 3.c. ALLOCATION)

Example: "Appropriation"

eventTimeinteger (int64)

when the event occured at source system level

Example: 1628177497000

ingestionTimeinteger (int64)

when the event arrived in ifix

Example: 1628177497000

referenceId*string

reference unique id(transaction id) of the caller system

Example: "013e9c56-8207-4dac-9f4d-f1e20bd824e7"

linkedEventIdnullable string

If this is a follow up event then it will refer to the parent event using this reference id.

Example: "7d476bb0-bc9f-48e2-8ad4-5a4a36220779"

linkedReferenceIdnullable string

If this is a follow up event then it will refer to the parent event in source system using this reference id.

Example: "77f23efe-879d-407b-8f23-7b8dd5b2ecb1"

amountDetails*array of Amount (object)

idstring

System generated UUID

Example: "51c9c03c-1607-4dd5-9e0e-93bbf860f6f7"

amount*number

Transaction Amount

Example: 10234.5

coaCode*string

Chart of account code. Publish request should contain coaCode, but search response will not contain it.

Example: "1234-123-123-12-12-12"

coaIdstring

Unique system generated Chart of Account UUID

Example: "e9f940d4-69aa-4bbb-aa82-111b8948a6b6"

fromBillingPeriodinteger (int64)

Start date of the billing period for which transaction is applicable

Example: 1622907239000

toBillingPeriodinteger (int64)

Start date of the billing period for which transaction is applicable

Example: 1628177643000

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

locationLocation (object)

Capture the location where fiscal event happened. This object represent geographical hierarchy

codestring

location code

hierarchyTypestring

location hierarchy type

Example: "State, District etc"

namestring

location name

childLocation (object)

Capture the location where fiscal event happened. This object represent geographical hierarchy

Circular reference to Location (object) ↩

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

Capture the extra information as a json

Request

Response

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

Response

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

Response

const response = await fetch('https://<server_address>/fiscal-event-service/fiscal/events/v1/_publish', {
    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"
  },
  "fiscalEvent": [
    {
      "version": "1.0.0",
      "id": "fecbbf1d-d6e3-4f24-9935-02c33b9248e0",
      "tenantId": "pb",
      "sender": "text",
      "receivers": [
        "text"
      ],
      "eventType": "Appropriation",
      "eventTime": 1628177497000,
      "ingestionTime": 1628177497000,
      "referenceId": "013e9c56-8207-4dac-9f4d-f1e20bd824e7",
      "linkedEventId": "7d476bb0-bc9f-48e2-8ad4-5a4a36220779",
      "linkedReferenceId": "77f23efe-879d-407b-8f23-7b8dd5b2ecb1",
      "amountDetails": [
        {
          "id": "51c9c03c-1607-4dd5-9e0e-93bbf860f6f7",
          "amount": 10234.5,
          "coaCode": "1234-123-123-12-12-12",
          "coaId": "e9f940d4-69aa-4bbb-aa82-111b8948a6b6",
          "fromBillingPeriod": 1622907239000,
          "toBillingPeriod": 1628177643000,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "location": {
        "code": "text",
        "hierarchyType": "State, District etc",
        "name": "text"
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

const response = await fetch('https://<server_address>/fiscal-event-service/fiscal/events/v1/_search', {
    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"
  },
  "fiscalEvent": [
    {
      "version": "1.0.0",
      "id": "fecbbf1d-d6e3-4f24-9935-02c33b9248e0",
      "tenantId": "pb",
      "sender": "text",
      "receivers": [
        "text"
      ],
      "eventType": "Appropriation",
      "eventTime": 1628177497000,
      "ingestionTime": 1628177497000,
      "referenceId": "013e9c56-8207-4dac-9f4d-f1e20bd824e7",
      "linkedEventId": "7d476bb0-bc9f-48e2-8ad4-5a4a36220779",
      "linkedReferenceId": "77f23efe-879d-407b-8f23-7b8dd5b2ecb1",
      "amountDetails": [
        {
          "id": "51c9c03c-1607-4dd5-9e0e-93bbf860f6f7",
          "amount": 10234.5,
          "coaCode": "1234-123-123-12-12-12",
          "coaId": "e9f940d4-69aa-4bbb-aa82-111b8948a6b6",
          "fromBillingPeriod": 1622907239000,
          "toBillingPeriod": 1628177643000,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "location": {
        "code": "text",
        "hierarchyType": "State, District etc",
        "name": "text"
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

{
  "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"
      }
    }
  ]
}

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();

{
  "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"
      }
    }
  ]
}