Get retainedEarningsStatement

  • Article

Retrieve the properties and relationships of a retained earnings statement report object for Business Central.

HTTP request

Replace the URL prefix for Business Central depending on environment following the guideline.

GET businesscentralPrefix/companies({id})/retainedEarningsStatements

Request headers

Header Value
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a retainedEarningsStatement object in the response body.

Example

Request

Here is an example of the request.

GET https://{businesscentralPrefix}/api/v2.0/companies({id})/retainedEarningsStatements?$orderby=lineNumber&$filter=dateFilter ge 2019-01-01 and dateFilter le 2020-12-31

Response

Here is an example of the response.

Note

The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

{
    "id": "f7fbf171-44e3-ea11-bb43-000d3a2feca1",
    "lineNumber": 10000,
    "display": "Retained Earnings, Period Start",
    "netChange": 69723.14,
    "lineType": "detail",
    "indentation": 0,
    "dateFilter": "2020-08-21"
}

Tips for working with the APIs
retainedearningsstatement