In the application, summary information is available on a selected address book record under the Summary Information tab — total invoiced amount, unpaid amount, due date, and the like. The same statistics on the financial balance with a business partner are also available in the REST API.
Constructing the URL
The request is sent using the GET method to the summary sub-evidence of a specific record from the address book:
GET https://demo.flexibee.eu/c/demo/adresar/123/summary.json
GET https://demo.flexibee.eu/c/demo/adresar/code:ABRA/summary.xml
⚠️ A company can be addressed by numeric ID or by identifier code:ZKRATKA. Filtering in parentheses does not work here — a request for /adresar/(kod='ABRA')/summary returns 404 with the message Can't find record identified by (kod='ABRA').
Response
The response is an overview of summary information, the same as in the application:
{
"winstrom": {
"adresarSummary": {
"celkFakt": "1.2290034529E8",
"limitFakt": "0.0",
"neuzNap": "0.0",
"neuzNav": "24306.55",
"neuzObp": "80952.43",
"neuzObv": "134.31",
"neuzPpp": "0.0",
"neuzPpv": "0.0",
"nezaplaceno": "1.2283741422E8",
"nezaplacenoPoDatSplat": "1.2284548008E8",
"prumProdleva": "-12.75",
"splatText": ""
}
}
}Property | Meaning |
| Total invoiced |
| Invoicing limit |
| Open received quotes |
| Open issued quotes |
| Uninvoiced received orders |
| Unstocked issued orders |
| Open received inquiries |
| Open issued inquiries |
| Unpaid |
| Unpaid overdue |
| Average payment delay |
| Defined due date |
Failed requests
Situation | Response |
The specified company does not exist |
|
ID is not a valid identifier — for example |
|
HTTP method other than |
|
FAQ
How do I run the "Update all" and "Update from internet" services via the API?
This is described in the article Updating companies from ARES via API.
How do I filter by relationship type in the address book?
You can find the procedure in the article API Address Book - Relationship Type, Filters.