Saving money can be funny
Web service documentation
This web service is used by our Windows client. If you want to create your own client you can use following documentation or you can download ready to use web service client here.
Introduction
This brief documentation can be helpful if you want to implement your own sMoneybox client. Web service is designed to be as simple as possible and is targeted only for adding new records.
Authentication
User credentials are authenticated every request by HTTP authentication, therefore using of HTTPS is strongly recommended. For successful login is also necessary to enable access for external applications in user profile menu.
WSDL
https://www.smoneybox.com/service/service.wsdl
Pre-generated C# class for accessing sMoneybox web service can be downloaded here.
Classes
ServiceUser
Useful information about logged user is retrieved using this class by calling client function.
| Attributes | Type | Description |
|---|---|---|
default_account_id |
int | ID of default user account. |
currency_symbol |
string | String containing symbol of logged user selected currency. Maximum size is 10 characters. |
ServiceAccount
Information about logged user accounts is retrieved using this class by calling accounts function.
| Attributes | Type | Description |
|---|---|---|
id |
int | ID of account. |
name |
string | Name of account. Maximum size is 100 characters. |
description |
string | Description of account. Maximum size is 255 characters. |
ServiceCategory
Information about logged user categories is retrieved using this class by calling categories function.
| Attributes | Type | Description |
|---|---|---|
id |
int | ID of category. |
name |
string | Name of category. Maximum size is 100 characters. |
level |
int | Indicates level of category in category tree. Starting with level 0. |
color |
int | RGB color value of category. |
ServiceRecord
New records are created by sending record information using this class by calling add_record function.
| Attributes | Type | Description |
|---|---|---|
account_id |
int | ID of desired user account. Must be valid user account ID. |
category_id |
int | ID of desired user category. Must be valid user category ID or 0 which stands for root category. |
amount |
double | Amount in user currency. Can be negative for expenses or positive for earnings. Value of 0 is also allowed. This attribute is mandatory for adding new record. |
date |
date | Date of record. Dates before 1.1.1990 are not allowed. Date is also limited to the future by maximum of 5 years. This attribute is mandatory for adding new record. |
description |
string | Description of record. Maximum allowed length is 255 characters. |
ServiceClient
This class is used internally by our official client and is not intended to be used by custom applications. Attributes of this class, same as client function, may be also changed or removed without further notice.
Functions
| Function | Returns | Description |
|---|---|---|
User() |
ServiceUser |
Returns information about logged user. |
Account() |
Array of ServiceAccount |
Returns array of logged user accounts. At least one account will be returned. Accounts are sorted by name. |
Categories() |
Array of ServiceCategory |
Returns array of logged user categories. Categories are sorted descendent by position in category tree. |
AddRecord(record:ServiceRecord) |
bool |
Creates new record using information passed by record argument. Success is indicated by return value. |
Client(version:double) |
ServiceClient |
This function is used internally by our official client and is not intended to be used by custom applications. Function may be also changed or removed without further notice. |
Please address your comments, ideas and questions to our forum.