APIs

iFIX Fiscal Event Service APIs

Create(publish) new fiscal event on iFix

post

Create the new fiscal event

Body

Fiscal event request along with request metadata

Responses

202

Event published successfully

*/*

400

Failed to process the request

*/*

post

HTTPcURLJavaScriptPython

POST /fiscal-event-service/fiscal/events/v1/_publish HTTP/1.1
Host: <server_address>
Content-Type: application/json
Accept: */*
Content-Length: 768

{
  "requestHeader": {
    "ts": 1,
    "version": "text",
    "msgId": "text",
    "signature": "text"
  },
  "fiscalEvent": [
    {
      "tenantId": "pb",
      "receivers": [
        "text"
      ],
      "eventType": "Appropriation",
      "eventTime": 1628177497000,
      "referenceId": "013e9c56-8207-4dac-9f4d-f1e20bd824e7",
      "linkedEventId": "7d476bb0-bc9f-48e2-8ad4-5a4a36220779",
      "linkedReferenceId": "77f23efe-879d-407b-8f23-7b8dd5b2ecb1",
      "amountDetails": [
        {
          "amount": 10234.5,
          "coaCode": "1234-123-123-12-12-12",
          "fromBillingPeriod": 1622907239000,
          "toBillingPeriod": 1628177643000
        }
      ],
      "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]"
          }
        }
      },
      "attributes": {}
    }
  ]
}

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

Get the list fiscal events.

post

Based on the criteria get the list of events.

Body

Fiscal event request along with request metadata

Responses

200

Successful response

*/*

400

Invalid input.

*/*

post

HTTPcURLJavaScriptPython

POST /fiscal-event-service/fiscal/events/v1/_search HTTP/1.1
Host: <server_address>
Content-Type: application/json
Accept: */*
Content-Length: 264

{
  "requestHeader": {
    "ts": 1,
    "version": "text",
    "msgId": "text",
    "signature": "text"
  },
  "criteria": {
    "Ids": [
      "text"
    ],
    "tenantId": "text",
    "eventType": "text",
    "fromEventTime": 1,
    "toEventTime": 1,
    "referenceId": [
      "text"
    ],
    "receiver": "mGramSeva",
    "fromIngestionTime": 1,
    "toIngestionTime": 1
  }
}

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

iFIX Master Data APIs

Create/Add new COA on iFix for a tenant

post

Create/Add new COA on iFix for a tenant

Body

COA request along with request metadata

Responses

202

Request has been accepted for processing

*/*

400

Failed to process the request

*/*

500

Internal server error

*/*

post

HTTPcURLJavaScriptPython

POST /chartOfAccount/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 412

{
  "requestHeader": {
    "ts": 1,
    "version": "text",
    "msgId": "text",
    "signature": "text"
  },
  "chartOfAccount": {
    "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",
    "attributes": {}
  }
}

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

Get the list COA.

post

Based on the criteria get the list of COA.

Body

COA search request along with request metadata. Defoult operator b/w multiple criteria is AND.

Responses

200

Successful response

*/*

400

Invalid input.

*/*

500

Internal server error

*/*

post

HTTPcURLJavaScriptPython

POST /chartOfAccount/v1/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 259

{
  "requestHeader": {
    "ts": 1,
    "version": "text",
    "msgId": "text",
    "signature": "text"
  },
  "criteria": {
    "tenantId": "text",
    "Ids": [
      "text"
    ],
    "coaCodes": [
      "text"
    ],
    "majorHead": "text",
    "subMajorHead": "text",
    "minorHead": "text",
    "subHead": "text",
    "groupHead": "text",
    "objectHead": "text"
  }
}

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