Skip to main content
A Profit and Loss object represents a profit and loss report that has been generated for a Business. Profit and Loss reports are generated for a specific time range and only contain information for categorized transactions that have been journaled to the general ledger.

​
Attributes

​
business_id
string
ID of the Business the profit and loss report was generated for.
​
type
string
Resource type. Value will be “Profit_And_Loss”
​
start_date
ISO8601 timestamp
Start date for data included in the report.
​
end_date
ISO8601 timestamp
End date for data included in the report.
​
income
Line Item object
A Line Item object representing the income line items in the report.
​
cost_of_goods_sold
Line Item object
A Line Item object representing the cost of goods sold line items in the report.
​
gross_profit
integer
Gross profit in cents. Calculated by subtracting total cost_of_sales line items from total income line items.
​
expenses
Line Item object
A Line Item object representing the expense line items in the report.
​
profit_before_taxes
integer
Net profit before taxes in cents. Calculated by subtracting total expenses line items from gross_profit.
​
taxes
Line Item object
A Line Item object representing the tax line items in the report.
​
net_profit
integer
Net profit in cents. Calculated by subtracting total taxes line items from profit_before_taxes
​
custom_line_items
array of Line Item objects
An optional array of Line Item objects representing additional line items below the net profit line in the report. This will be used when alternative P&L structures and groupings have been configured.
​
other_outflows
Line Item object
A Line Item object representing business outflow transactions that are not part of the profit and loss statement.
​
personal_expenses
Line Item object
A Line Item object representing personal expense transactions that are not part of the profit and loss statement.
​
fully_categorized
boolean
A boolean representing whether all imported transactions within the report date range have been categorized. If FALSE, there are uncategorized transactions within the selected date range, indicating the provided report data may be incomplete.

​
Line Item object

​
name
enum
Enum name for the line item. Ex. “REVENUE”
​
display_name
string
Display name for the line item. Ex. “Revenue”
​
value
integer
The value of the line item in cents.
​
child_items
array of Line Item objects
An array of Line Item objects representing child line items within the report section.

​
Ledger Entry Source Object

The LedgerEntrySource represents the source of a ledger entry. This is a polymorphic type that can be any of the following:
  • Transaction Ledger Entry Source: Represents entries originating from bank transactions.
  • Invoice Ledger Entry Source: Represents entries related to specific invoices.
  • Invoice Write-Off Ledger Entry Source: Details entries for write-offs associated with invoices.
  • Manual Ledger Entry Source: Represents manually created ledger entries.
  • Invoice Payment Ledger Entry Source: Represents payments made against invoices.
  • Refund Ledger Entry Source: Represents refund transactions.
  • Opening Balance Ledger Entry Source: Used to represent the initial balances when setting up accounts.
  • Payout Ledger Entry Source: Represents payouts processed through external payment processors.
{
  "data":{
    "type":"Profit_And_Loss",
    "business_id":"d2f6d97f-3345-4299-9ec2-468738c5d536",
    "start_date":"2023-01-01T06:00:00Z",
    "end_date":"2023-12-01T06:00:00Z",
    "income":{
      "name":"REVENUE",
      "display_name":"Revenue",
      "value":49397,
      "line_items":[
        {
          "name":"SERVICES_REVENUE",
          "display_name":"Service Revenue",
          "value":46897,
          "line_items":null
        },
        {
          "name":"GOODS_REVENUE",
          "display_name":"Sale of Goods Revenue",
          "value":0,
          "line_items":null
        },
        {
          "name":"DISCOUNTS",
          "display_name":"Discounts & Refunds",
          "value":2500,
          "line_items":null
        }
      ]
    },
    "cost_of_goods_sold":{
      "name":"COGS",
      "display_name":"Cost of Goods Sold",
      "value":8026,
      "line_items":[
        {
          "name":"JOB_SUPPLIES",
          "display_name":"Job supplies",
          "value":8026,
          "line_items":null
        }
      ]
    },
    "gross_profit":41371,
    "expenses":{
      "name":"OPERATING_EXPENSES",
      "display_name":"Operating Expenses",
      "value":0,
      "line_items":[
        {
          "name":"INSURANCE",
          "display_name":"Insurance",
          "value":0,
          "line_items":null
        },
        {
          "name":"RENT_EXPENSE",
          "display_name":"Rent",
          "value":0,
          "line_items":null
        },
        {
          "name":"UTILITIES",
          "display_name":"Utilities",
          "value":0,
          "line_items":null
        },
        {
          "name":"EQUIPMENT",
          "display_name":"Equipment & Tools",
          "value":0,
          "line_items":null
        },
        {
          "name":"ADVERTISING",
          "display_name":"Advertising",
          "value":0,
          "line_items":null
        },
        {
          "name":"VEHICLE_EXPENSES",
          "display_name":"Vehicle Expenses",
          "value":0,
          "line_items":null
        }
      ]
    },
    "profit_before_taxes":41371,
    "taxes":{
      "name":"TAXES",
      "display_name":"Taxes",
      "value":0,
      "line_items":null
    },
    "net_profit":41371,
    "other_outflows":null,
    "personal_expenses":null,
    "fully_categorized":true
  }
}