GET api/AccountBalance
Retrieve Accounts balances (posted)
Request Information
URI Parameters
None.
Body Parameters
AccountBalReqName | Description | Type | Additional information |
---|---|---|---|
Company |
The company name |
string |
String length: inclusive between 0 and 6 |
AccountCode |
The account code |
string |
None. |
YearFrom |
Optional filter: Get balance from given year |
integer |
None. |
YearTo |
Optional filter: Get balance until given year |
integer |
None. |
PeriodFrom |
Optional filter: Get balance from given Period |
integer |
Range: inclusive between 0 and 12 |
PeriodTo |
Optional filter: Get balance until given Period |
integer |
Range: inclusive between 0 and 12 |
Request Formats
application/json, text/json
Sample:
{ "Company": "DEMO", "AccountCode": "2102020", "YearFrom": 0, "YearTo": 0, "PeriodFrom": 0, "PeriodTo": 0 }
Response Information
Resource Description
AccountBalResName | Description | Type | Additional information |
---|---|---|---|
AccountCode |
The account code |
string |
None. |
AccountBalance |
The account balance |
decimal number |
None. |
AccountBalanceStock |
The account stock balance (saved Invoices and Receipts total amount) |
decimal number |
None. |
MsgControl |
Contains information about the response |
MsgControl |
None. |
Response Formats
application/json, text/json
Sample:
{ "AccountCode": "", "AccountBalance": 0.0, "AccountBalanceStock": 0.0, "MsgControl": { "result": 0, "Message": "Corresponding success and error message", "MethodName": "api/AccBalance GET", "AppName": "EsoftWebApi", "EsoftUser": "ESOFT", "User": "Username", "Password": "Password", "SystemDate": "2025-01-06T22:32:15.2033729+02:00", "GenList": [], "GenMsg1": "", "GenMsg2": "", "GenMsg3": "" } }