Skip to main content
GET
Get profit and loss report

Authorizations

Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id
string<uuid>
required

Business UUID

Query Parameters

detail_level
enum<string>
default:summary

Level of detail: 'summary' or 'detailed'

Available options:
detailed,
summary
end_date
string<date>
required

Report period end date (YYYY-MM-DD)

start_date
string<date>
required

Report period start date (YYYY-MM-DD)

Response

business_id
string<uuid>
required

Business UUID

start_date
string<date>
required

Report period start

end_date
string<date>
required

Report period end

currency
string
required

Business base currency

detail_level
enum<string>
required

'summary' or 'detailed'

  • summary - summary
  • detailed - detailed
Available options:
summary,
detailed
summary
object
required

Calculated P&L totals

revenue
object

Grouped accounts by AccountSubtype.

  • display_name: From AccountSubtype.label
  • total_cents: Sum of all line items
  • line_items: Individual accounts with this subtype
other_operating_income
object

Grouped accounts by AccountSubtype.

  • display_name: From AccountSubtype.label
  • total_cents: Sum of all line items
  • line_items: Individual accounts with this subtype
direct_costs
object

Grouped accounts by AccountSubtype.

  • display_name: From AccountSubtype.label
  • total_cents: Sum of all line items
  • line_items: Individual accounts with this subtype
operating_expenses
object

Grouped accounts by AccountSubtype.

  • display_name: From AccountSubtype.label
  • total_cents: Sum of all line items
  • line_items: Individual accounts with this subtype
finance_income
object

Grouped accounts by AccountSubtype.

  • display_name: From AccountSubtype.label
  • total_cents: Sum of all line items
  • line_items: Individual accounts with this subtype
finance_costs
object

Grouped accounts by AccountSubtype.

  • display_name: From AccountSubtype.label
  • total_cents: Sum of all line items
  • line_items: Individual accounts with this subtype
income_tax
object

Grouped accounts by AccountSubtype.

  • display_name: From AccountSubtype.label
  • total_cents: Sum of all line items
  • line_items: Individual accounts with this subtype