MIP Cloud API
The MIP Cloud API is a service for programmatically accessing and modifying MIP Fund Accounting data. It provides a vocabulary of requests and responses that program code uses to "talk" securely to MIP Fund Accounting.
Use the MIP API for:
- Incorporating MIP Fund Accounting functionality and up-to-the-minute data in your own application or website.
- Writing custom integration software for transferring data between MIP Fund Accounting and other third-party applications, such as charting or reporting programs.
- Building your own custom user interface.
Please be aware that although the MIP Cloud API aims to be intuitive to use, developers should have a good understanding of HTTP request methods, JSON, and REST services before making requests that update or delete data.
As the MIP Cloud API is updated, certain undocumented functionality may be visible in the API. While it is important that developers have a good understanding to use the API documented in the MIP Cloud API Reference Guide, using any undocumented API features would be at the risk of the developer.
Moving Data
In the past, moving data between MIP and other programs has been essentially a manual process. To integrate MIP Fund Accounting data into another program, you might export a report in CSV (Comma-Separated Values) format from the Fund Accounting user interface, then use a custom import utility to reformat the result and load it into your application. To update MIP Fund Accounting from another program, you would use a similar procedure in reverse. In either case, a significant amount of user intervention was required every time a data transfer occurred.
Using the MIP API, by contrast, your software can communicate directly with MIP Fund Accounting without any user involvement at all. The API provides a versatile toolset of data operations that can be called directly from applications in a variety of programming languages. With these tools, your program can request or modify your MIP Fund Accounting data in real time, any time.
How APIs Work
The MIP API is based on Representational State Transfer (REST) architecture. In simple terms, it is implemented as a set of web endpoints (URIs), each of which provides one or more related MIP Fund Accounting data operations. To invoke an operation, your program simply sends an HTTP request with any necessary parameters to the appropriate endpoint. The MIP Advance server receives the request, performs the operation, and sends an HTTP response back. The response contains a status code indicating the success or failure of the operation, as well as any output produced.
The MIP API supports four HTTP request types that follow the CRUD model of data operations:
| POST | Creates data |
| GET | Retrieves data |
| PUT | Updates data |
| DELETE | Deletes data |
MIP Advance API Features
The MIP API offers a variety of functionality, and is continuing to grow and evolve with each release of MIP. Its current capabilities include operations for each of the following:
Transactions
- Accounts Payable > Electronic Payments
- Accounts Payable > Credits
- Accounts Payable > Invoices
- Accounts Payable > Manual Checks
- Accounts Payable > Pay Invoices
- Accounts Receivable > Credits
- Accounts Receivable > Invoices
- Accounts Receivable > Receipts
- General Ledger > Cash Disbursements
- General Ledger > Cash Receipts
- General Ledger > Journal Vouchers
- General Ledger > Void Checks
- General Ledger > Write Checks
- General Ledge > Write Receipts
- Encumbrance > Enter Encumbrances
- Encumbrance > Enter Encumbrance Liquidations
- Transaction Entry > Apply Distribution Codes
- Transaction Entry > Manage Sessions
Maintenance
- Accounts Payable > Vendors
- Accounts Receivable > Customers
- General Ledger > Account Code Combinations
- General Ledger > Chart of Accounts
- General Ledger > Closing Accounts
- General Ledger > Distribution Codes
- General Ledger > Report Groups
- General Ledger > Offset Assignments
- Fixed Assets > Designation Codes
- Fixed Assets > Custom Depreciation Codes
- Fixed Assets > Assets
- Fixed Assets > Asset Types
Operations
- Accounts Payable > Vendor Balances
- Accounts Receivable > Customer Balances
- Budget > Available Budget Balances
- General Ledger > Account Balances
- Display Encumbrances > Encumbrance Balances
Administration
- Organization Settings > Attachments
- Organization Settings > Budget Versions
- Organization Settings > User Defined Fields
- Organization Settings > Manage Users
- Organization Settings > Account Level Security
- Organization Settings > Audit Trails
- Organization Settings > Fixed Assets