APIs

iFIX Fiscal Event Service APIs

iFIX Master Data APIs

PreviousInformation Model NextArchitecture

Last updated 1 year ago

Was this helpful?

Create/Add new COA on iFix for a tenant

post

/chartOfAccount/v1/_create

Body

requestHeaderobjectrequired

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.

chartOfAccountobject

Captures the COA data as map

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/chartOfAccount/v1/_create' \
  --header 'Content-Type: application/json'

202

400

500

{
  "responseHeader": {
    "ts": 1,
    "correlationId": "text",
    "msgId": "text",
    "signature": "text",
    "version": "text",
    "status": "SUCCESS"
  },
  "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",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "attributes": {}
    }
  ]
}

Request has been accepted for processing

Get the list COA.

Based on the criteria get the list of COA.

post

/chartOfAccount/v1/_search

Body

requestHeaderobjectrequired

criteriaobjectrequired

The object contains all the search criteria of the fund

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/chartOfAccount/v1/_search' \
  --header 'Content-Type: application/json'

200

400

500

{
  "responseHeader": {
    "ts": 1,
    "correlationId": "text",
    "msgId": "text",
    "signature": "text",
    "version": "text",
    "status": "SUCCESS"
  },
  "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",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "attributes": {}
    }
  ]
}

Successful response

Create(publish) new fiscal event on iFix

Create the new fiscal event

post

/fiscal/events/v1/_publish

Body

requestHeaderobjectrequired

fiscalEventobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://<server_address>/fiscal-event-service/fiscal/events/v1/_publish' \
  --header 'Content-Type: application/json'

202

400

{
  "responseHeader": {
    "ts": 1,
    "correlationId": "text",
    "msgId": "text",
    "signature": "text",
    "version": "text",
    "status": "SUCCESS"
  },
  "fiscalEvent": [
    {
      "version": "1.0.0",
      "id": "fecbbf1d-d6e3-4f24-9935-02c33b9248e0",
      "tenantId": "pb",
      "sender": "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",
      "location": {
        "code": "text",
        "hierarchyType": "State, District etc",
        "name": "text",
        "child": {
          "code": "text",
          "hierarchyType": "State, District etc",
          "name": "text",
          "child": {
            "code": "text",
            "hierarchyType": "State, District etc",
            "name": "text",
            "child": "[Circular Reference]"
          }
        }
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "attributes": {},
      "receivers": [
        "text"
      ],
      "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",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ]
    }
  ]
}

Event published successfully

Get the list fiscal events.

Based on the criteria get the list of events.

post

/fiscal/events/v1/_search

Body

requestHeaderobjectrequired

criteriaobject

The object contains all the search criteria of the fiscal events

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://<server_address>/fiscal-event-service/fiscal/events/v1/_search' \
  --header 'Content-Type: application/json'

200

400

{
  "responseHeader": {
    "ts": 1,
    "correlationId": "text",
    "msgId": "text",
    "signature": "text",
    "version": "text",
    "status": "SUCCESS"
  },
  "fiscalEvent": [
    {
      "version": "1.0.0",
      "id": "fecbbf1d-d6e3-4f24-9935-02c33b9248e0",
      "tenantId": "pb",
      "sender": "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",
      "location": {
        "code": "text",
        "hierarchyType": "State, District etc",
        "name": "text",
        "child": {
          "code": "text",
          "hierarchyType": "State, District etc",
          "name": "text",
          "child": {
            "code": "text",
            "hierarchyType": "State, District etc",
            "name": "text",
            "child": "[Circular Reference]"
          }
        }
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "attributes": {},
      "receivers": [
        "text"
      ],
      "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",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ]
    }
  ]
}

Successful response