DIGIT Public Finance Management
PlatformDomainsAcademyDesign SystemFeedback
v2.2
v2.2
  • Introducing Public Finance Management (iFIX)
  • Platform
    • Release Notes
      • iFIX Core Release Notes
        • iFIX Core Build Updates
        • iFIX Core Test Cases
      • iFIX Adaptor Release Notes
        • iFIX Adaptor Build Updates
        • iFIX Adaptor Test Cases
    • Specification
      • Functional Specifications
      • Technical Specification
        • Information Model
        • APIs
    • Architecture
      • Technology
    • Services
    • Setup
      • iFIX Service Setup
      • Infrastructure Setup
        • Quickstart/Local Setup
        • On AWS
        • On Azure
      • Deploy Services
        • Deploy from your local machine
        • CI/CD
      • API Access Key
    • Configuration
      • Core Service Documents
        • Master Data Setup
          • Domain Services
            • iFIX Core Master Data Service
            • iFIX Core Fiscal Event Service
            • iFIX Core Fiscal Event Post-Processor
        • iFIX Core Data Cleanup
        • iFix Department Entity Service
        • iFix Client Management Service
          • Keycloak Setup
      • Configuring Master Data
      • Promotion Docs
        • Master Data Service Promotion Doc
        • mGramSeva iFIX Adapter
        • Department Entity Service Promotion
        • Fiscal Event And Fiscal Event Post-processor Service Promotion
        • MongoDB Migration
  • Products
    • mGramSeva
      • Functionalities
        • Login and Forgot Password
        • User Roles and Home Screen
        • Create Consumer
        • Search Consumer
        • Edit Consumer
        • View Consumer
        • Billing - Bulk Demand Generation
        • Billing - Metered Connection
        • Revenue Collection - Offline
        • Expenditure - Add Expense
        • Expenditure - Modify Expense
        • User Onboarding - Bulk Upload
        • User Onboarding/Walkthrough
        • Feedback - Post Payment
        • SMS Notifications
        • Home Page Notifications
        • Edit User Profile
        • Bill and Receipt PDF
        • Update Expense Search
        • Bulk Demand Generation for Non Metered
        • Demand/Bill Generation for Metered Connection
        • Household Register
        • Tabular Dashboard - Expense
        • Tabular Dashboard - Collection
        • Download Bills and Receipt
      • Architecture
        • Technology
      • Source Code
      • Documents
        • User Manual
        • Demo video
        • UI Mockups
        • mGramSeva UI
          • Application Permissions & Dependencies
        • Tech User Manual
          • Language Selection
          • Login
          • Update Password FTL
          • Forgot Password
          • Home
          • Edit Profile
          • Change Password
          • Generate Bill
          • Search Connection
          • Consumer Details
            • Create Consumer
            • Update Consumer
          • Expenses
            • Add Expenses
            • Search Expense Bills
            • Modify Expenses
          • Dashboard
            • Monthly Dashboard
            • Collections Dashboard
            • Expenditure Dashboard
          • Collect Payment
          • Consumer Feedback
          • Household Register
          • Bluetooth Thermal Printer Integration
          • Application Structure
        • Application Structure
        • Integration Testing
        • Integration Testing With Github Actions
        • Firebase Analytics Integration
        • Backend Services
          • mGramSeva - Water Services
          • mGramSeva - Water Service Calculator
          • mGramSeva e-Challan Service
          • mGramSeva - User Service
          • mGramSeva - Billing Service
          • mGramSeva - User OTP
          • iFix Adapter Integration Service
          • mGramSeva - Rollout Dashboard
          • mGramSeva Scheduler
          • mGramSeva- Services Re-Indexing
          • mGramSeva Dashboard
    • iFIX Adapter
      • Adapter Service Documents
        • iFIX Adapter Master Data Setup
        • mGramSeva iFIX Adapter Service
        • iFIX Adapter Master Data Service
        • iFix Adapter Services
      • Source Code
      • Installation
        • Local Setup
        • CI/CD
    • iFIX Dashboard
      • Features
      • Architecture
        • Technology
      • Source Code
      • Installation
        • Local Setup
        • CI/CD
      • Documents
        • iFIX Reference Dashboard
          • iFIX Fiscal Event Aggregator
  • Community
    • Ecosystem
      • News and Events
    • Roadmap
    • PFM Blogs
      • Why PFM Needs Fiscal Information Exchange Standards
    • Source Code
    • Discussions
    • Issues
Powered by GitBook

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

On this page

Was this helpful?

  1. Platform
  2. Specification
  3. Technical Specification

APIs

PreviousInformation ModelNextArchitecture

Last updated 2 years ago

Was this helpful?

iFIX Department Entity APIs

iFIX Fiscal Event Service APIs

iFIX Master Data APIs

All content on this page by is licensed under a .

​
eGov Foundation
Creative Commons Attribution 4.0 International License
Creative Commons License

Create/Add new tenant on iFix

post

Create/Add the new tenant

Body

Tenant request along with request metadata

Responses
202
Request has been accepted for processing
*/*
400
Failed to process the request
*/*
500
Internal server error
*/*
post
POST /rushang.dhanesha/iFIX-Master-Data/2.0.0/government/v1/_create HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "requestHeader": {
    "ts": 1,
    "version": "text",
    "msgId": "text",
    "signature": "text"
  },
  "government": {
    "id": "text",
    "name": "text",
    "attributes": {}
  }
}
{
  "responseHeader": {
    "ts": 1,
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "government": [
    {
      "id": "text",
      "name": "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
POST /rushang.dhanesha/iFIX-Master-Data/2.0.0/chartOfAccount/v1/_search HTTP/1.1
Host: virtserver.swaggerhub.com
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": {}
    }
  ]
}