welcome to the ZimpleMoney API
The ZimpleMoney system is a simple yet powerful way to create loans, automate payments, and manage your loan portfolio.
This API enables secure and authenticated access to the information in the ZimpleMoney system.
The API uses standard "REST" semantics. The data in the system are organized into "endpoints", which reflect the kinds of data managed by the system. Requests are posted to api.zimplemoney.com, using standard HTTP commands GET, PUT (=update), POST (=add/execute), and DELETE. The system responds with standard HTTP response codes (e.g. 200 success, 4xx error).
This documentation gives a detailed overview of the API, including authentication, request/response usage, the various endpoints supported by the API and how to use them, and explains how errors are handled.
To facilitate third-party development and usage of the API, we've included a "sandbox" world which can be used to test out the API, including the ability to create loans, make payments, perform adjustments, as well as to do various inquiries. Details on using the sandbox world including registering a test account are available here.
The API is defined using an Open API (fka Swagger) specification. The API is fully defined in this YAML file. We eagerly invite questions and feedback about the API, you can contact us here.
Next: Worlds