Skip to main content
GET
/
v0
/
business
/
{business_id}
/
reports
/
profit-and-loss
Retrieve the Profit & Loss Report
curl --request GET \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/reports/profit-and-loss \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "period": "<string>",
      "records": [
        {
          "name": "<string>",
          "amount": 123,
          "total_amount": 123,
          "has_entries": false,
          "ledger_id": "<string>",
          "children": [
            {
              "amount": 100,
              "children": [],
              "ledger_id": "<string>",
              "name": "<string>",
              "total_amount": 150
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Accept
(enum<string> | string)[] | null
Available options:
application/json,
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Path Parameters

​
business_id
string<biz_string>
required

The ID of the Business The ID of the Business

Query Parameters

​
start_datetime
string<date-time>
required

The start date (inclusive) in ISO-8601 format. The start date (inclusive) in ISO-8601 format.

​
end_datetime
string<date-time>
required

The end date (inclusive) in ISO-8601 format. The end date (inclusive) in ISO-8601 format.

​
period
enum<string> | null
default:all

The period used to partition the report details. The period used to partition the report details.

Available options:
month,
quarter,
year,
all

Response

Successful Response

​
data
PLPeriodReport · object[]
required