APIs

iFIX Department Entity APIs

iFIX Fiscal Event Service APIs

iFIX Master Data APIs

Create/Add new tenant on iFix

Create/Add the new tenant

POSThttps://virtserver.swaggerhub.com/rushang.dhanesha/iFIX-Master-Data/2.0.0/government/v1/_create

Body

application/json

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.

government*Government (object)

This object captures the fiscal information of external systems.

Response

202400500

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.

governmentarray of Government (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/rushang.dhanesha/iFIX-Master-Data/2.0.0/government/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "government": {
        "id": "text",
        "name": "text"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

202400500

{
  "responseHeader": {
    "ts": 0,
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "government": [
    {
      "id": "text",
      "name": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 0,
        "lastModifiedTime": 0
      }
    }
  ]
}

Get the list COA.

Based on the criteria get the list of COA.

POSThttps://virtserver.swaggerhub.com/rushang.dhanesha/iFIX-Master-Data/2.0.0/chartOfAccount/v1/_search

Body

application/json

RequestHeader meta data.

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.

criteria*COASearchCriteria (object)

The object contains all the search criteria of the fund

Response

200400500

Successful response

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.

chartOfAccountsarray of ChartOfAccount (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/rushang.dhanesha/iFIX-Master-Data/2.0.0/chartOfAccount/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "criteria": {
        "tenantId": "text"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

200400500

{
  "responseHeader": {
    "ts": 0,
    "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",
        "createdTime": 0,
        "lastModifiedTime": 0
      }
    }
  ]
}