Wiki

Clone wiki

dist-sunriise / sunriise-spring - REST service

Download

Start

  • Put a copy of a *.mny where you have the sunriise-spring-*-exec.jar
  • Double click on the jar file
  • OR run it as command line
    java -jar sunriise-spring-0.0.2-SNAPSHOT-exec.jar
    
  • To specify the file location and password
    java -jar sunriise-spring-0.0.2-SNAPSHOT-exec.jar  --file=sample.mny --password=qwerty1234
    

Resources

Swagger

  • Swagger API documentation - http://localhost:8080/swagger-ui.html

Accounts

  • List of accounts - http://localhost:8080/api/msmoney/accounts
  • Once you have the list of ids, to query an account detail id==2 - http://localhost:8080/api/msmoney/account/2

For list of accounts, you can limit the number of accounts with the following query parameters

parameter value notes
name string limit to accounts with account name matching 'name' (substring)
status string limit to accounts with account status: OPEN, CLOSE, ALL
type string limit to accounts with account type: BANKING, CREDIT_CARD, CASH, ASSET, LIABILITY, INVESTMENT, LOAN, UNKNOWN

Examples

  • http://localhost:8080/api/msmoney/accounts?name=Brokerage&status=ALL
  • http://localhost:8080/api/msmoney/accounts?name=Brokerage&status=ALL&type=BANKING

Transactions

  • Transactions for a given account id==2 - http://localhost:8080/api/msmoney/account/2/transactions
  • Then detail for a given transaction id==660 - http://localhost:8080/api/msmoney/account/2/transaction/660

For list of transactions, you can limit the number of transactions with the following query parameters

parameter value notes
fromDate date Limit transaction created after than this date. Format yyyy-MM-dd, for example 2010-06-15.
toDate date Limit transaction created before than this date. Format yyyy-MM-dd, for example 2010-06-15.
fromAmount double Limit transaction with amount greater than or equal to fromAmount.
toAmount double Limit transaction with amount less than or equal to toAmount.
text string Search for this substring in account.name, category.name, payee.name
regex string Similar to text but is regular expression.

Examples

  • http://localhost:8080/api/msmoney/account/42/transactions?fromDate=2001-02-01&toDate=2002-12-31
  • http://localhost:8080/api/msmoney/account/42/transactions?fromDate=2001-02-01&text=Automobile%3A&toAmount=0.00&toDate=2002-12-31

Updated