Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
reports
/
profit-and-loss-summary
Fetch P&L summary
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/reports/profit-and-loss-summary \
  --header 'Authorization: Bearer <token>'
{
  "start_date": "2024-01-01T00:00:00Z",
  "end_date": "2024-12-31T23:59:59Z",
  "income": 1050000,
  "costOfGoodsSold": 350000,
  "grossProfit": 700000,
  "operatingExpenses": 300000,
  "profitBeforeTaxes": 400000,
  "taxes": 100000,
  "netProfit": 300000,
  "totalExpenses": 750000,
  "uncategorizedInflows": 500,
  "uncategorizedOutflows": 300,
  "fullyCategorized": false,
  "uncategorized_transactions": 5,
  "categorized_transactions": 42
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Content-Type
string

Content-Type must be set to application/json.

Path Parameters

​
businessId
string
required

The UUID of the business to fetch the profit and loss summary for.

Query Parameters

​
start_date
string<date-time>

The start of the period (ISO 8601 instant, e.g. 2024-01-01T00:00:00Z). If omitted, defaults to the business activation date.

​
end_date
string<date-time>

The end of the period (ISO 8601 instant, e.g. 2024-12-31T23:59:59Z). If omitted, defaults to the current time.

​
reporting_basis
enum<string>

Accounting basis for the report. Defaults to the business default or ACCRUAL if not set.

Available options:
ACCRUAL,
CASH
​
structure
string

P&L structure template to use.

​
tag_key
string

Tag key to filter results by (use together with tag_values).

​
tag_values
string

Comma-separated tag values to filter results by (use together with tag_key).

Response

A profit and loss summary for an arbitrary date range. Unlike MonthlyPnlSummary which represents a single calendar month, this object can represent any time period including all-time when both dates are null.

​
start_date
string<date-time> | null

The start of the period (ISO 8601 instant). Null indicates all-time from business activation.

Example:

"2024-01-01T00:00:00Z"

​
end_date
string<date-time> | null

The end of the period (ISO 8601 instant). Null indicates up to the current time.

Example:

"2024-12-31T23:59:59Z"

​
income
integer<int64>

The business's total income for the period, in cents.

Example:

1050000

​
costOfGoodsSold
integer<int64>

The business's cost of goods sold for the period, in cents.

Example:

350000

​
grossProfit
integer<int64>

The business's gross profit for the period, in cents. Calculated as income minus cost of goods sold.

Example:

700000

​
operatingExpenses
integer<int64>

The business's operating expenses for the period, in cents.

Example:

300000

​
profitBeforeTaxes
integer<int64>

The business's pre-tax profit for the period, in cents.

Example:

400000

​
taxes
integer<int64>

The business's taxes for the period, in cents.

Example:

100000

​
netProfit
integer<int64>

The business's net profit for the period, in cents.

Example:

300000

​
totalExpenses
integer<int64>

The sum of all business expenses (cost of goods sold + operating expenses + taxes) for the period, in cents.

Example:

750000

​
uncategorizedInflows
integer<int64>

The sum of positive uncategorized transactions for the period, in cents.

Example:

500

​
uncategorizedOutflows
integer<int64>

The sum of negative uncategorized transactions for the period, in cents.

Example:

300

​
fullyCategorized
boolean

Whether all transactions within the period have been categorized.

Example:

false

​
uncategorized_transactions
integer<int32>

The count of uncategorized transactions within the period.

Example:

5

​
categorized_transactions
integer<int32>

The count of categorized transactions within the period.

Example:

42