ProfitAndLossDetail
Generates detailed Profit and Loss reports, providing in-depth financial analysis.
Columns
| Name | Type | References | Description |
| Label | String | The label or category for each row in the Profit and Loss Detail report, typically representing account names or other identifying information. | |
| Type | String | Specifies the type of transaction or entry in the report, such as 'Invoice', 'Expense', or 'Payment'. | |
| Date | Date | The date of the transaction associated with the row, formatted as yyyy-MM-dd. | |
| Num | String | The transaction number or reference identifier for the entry, useful for tracking specific transactions. | |
| Name | String | The name of the entity (such as a customer, vendor, or employee) linked to the transaction. | |
| Memo | String | Additional details or notes provided for the transaction, often used for context or explanation. | |
| Class | String | The class assigned to the transaction, used for categorization or tracking across accounts. | |
| Clr | String | Indicates whether the transaction is cleared or uncleared in the bank reconciliation process. | |
| Split | String | The account that is offset by the transaction (where the funds are transferred to or from). | |
| Amount | Double | The monetary value of the transaction or line item, reflecting income or expense amounts. | |
| Balance | Double | The running balance of the account after the transaction is applied. | |
| RowType | String | Identifies the type of data in the row, such as 'Text' for labels, 'Data' for transactions, or 'Total' for subtotals and grand totals. |
Pseudo-Columns
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| ReportPeriod | String | Defines the date range for the report in the format fromdate:todate. Open-ended ranges can be specified by omitting a value (for example, 2024-02-01:). | |
| ReportDateRangeMacro | String | A predefined macro to simplify date range selection, such as 'This Month' or 'Last Fiscal Year'.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. | |
| AccountType | String | Filters the report to include only specified types of accounts, such as 'Income', 'Expense', or 'Liabilities'.
The allowed values are NONE, ACCOUNTSPAYABLE, ACCOUNTSRECEIVABLE, ALLOWEDFOR1099, APANDSALESTAX, APORCREDITCARD, ARANDAP, ASSET, BALANCESHEET, BANK, BANKANDARANDAPANDUF, BANKANDUF, COSTOFSALES, CREDITCARD, CURRENTASSET, CURRENTASSETANDEXPENSE, CURRENTLIABILITY, EQUITY, EQUITYANDINCOMEANDEXPENSE, EXPENSEANDOTHEREXPENSE, FIXEDASSET, INCOMEANDEXPENSE, INCOMEANDOTHERINCOME, LIABILITY, LIABILITYANDEQUITY, LONGTERMLIABILITY, NONPOSTING, ORDINARYEXPENSE, ORDINARYINCOME, ORDINARYINCOMEANDCOGS, ORDINARYINCOMEANDEXPENSE, OTHERASSET, OTHERCURRENTASSET, OTHERCURRENTLIABILITY, OTHEREXPENSE, OTHERINCOME, OTHERINCOMEOREXPENSE. | |
| AccountList | String | A list of account names or IDs to include in the report, separated by commas. The format must match AccountListType. | |
| AccountListType | String | Specifies the format of accounts in AccountList, such as 'Name' or 'ID'.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. | |
| EntityType | String | Filters the report to include only specified types of entities, such as 'Customer', 'Vendor', or 'Employee'.
The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. | |
| EntityList | String | A comma-separated list of entity names or IDs to filter the report. Requires EntityListType for format specification. | |
| EntityListType | String | Defines the format for entities in EntityList, such as 'Name' or 'ID'.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. | |
| ItemType | String | Filters the report to include only specific item types, such as 'Product', 'Service', or 'Inventory'.
The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. | |
| ItemList | String | A list of item names or IDs to filter the report, separated by commas. Requires ItemListType for format specification. | |
| ItemListType | String | Defines the format of items in ItemList, such as 'Name' or 'ID'.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. | |
| ClassList | String | A list of class names or IDs to filter the report. Specify ClassListType to determine format. | |
| ClassListType | String | Specifies the format of classes in ClassList, such as 'Name' or 'ID'.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. | |
| TransactionTypes | String | A comma-separated list of transaction types to include in the report. Values include ALL, ARREFUNDCREDITCARD, BILL, BILLPAYMENTCHECK, BILLPAYMENTCREDITCARD, BUILDASSEMBLY, CHARGE, CHECK, CREDITCARDCHARGE, CREDITCARDCREDIT, CREDITMEMO, DEPOSIT, ESTIMATE, INVENTORYADJUSTMENT, INVOICE, ITEMRECEIPT, JOURNALENTRY, LIABILITYADJUSTMENT, PAYCHECK, PAYROLLLIABILITYCHECK, PURCHASEORDER, RECEIVEPAYMENT, SALESORDER, SALESRECEIPT, SALESTAXPAYMENTCHECK, TRANSFER, VENDORCREDIT, YTDADJUSTMENT. | |
| ModifiedDateRange | String | Filters records by modification date within the specified range, formatted as fromdate:todate. Open-ended ranges are supported. | |
| ModifiedDateRangeMacro | String | A macro to filter records based on predefined modification date ranges, such as 'Last Week' or 'This Quarter'.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. | |
| DetailLevel | String | Specifies the level of detail in the report, such as 'Summary', 'Detail', or 'All'.
The allowed values are ALL, ALLEXCEPTSUMMARY, SUMMARYONLY. | |
| PostingStatus | String | Filters the report to include only 'Posting', 'NonPosting', or both types of transactions.
The allowed values are EITHER, NONPOSTING, POSTING. | |
| ReportAsOf | String | Sets a specific date to calculate balances or other data as of a particular point in time.
The allowed values are REPORTENDDATE, TODAY. | |
| IncludeAccounts | String | Determines whether to include all accounts or only those currently in use. Useful for focusing the report.
The allowed values are ALL, INUSE. | |
| ReportBasis | String | Specifies whether the report is prepared on a 'Cash' basis (based on payment dates) or 'Accrual' basis (based on transaction dates). | |
| IncludeColumns | String | A comma-separated list of columns to include in the report. Supported values include ACCOUNT, AGING, AMOUNT, AMOUNTDIFFERENCE, AVERAGECOST, BILLEDDATE, BILLINGSTATUS, CALCULATEDAMOUNT, CLASS, CLEAREDSTATUS, COSTPRICE, CREDIT, CURRENCY, DATE, DEBIT, DELIVERYDATE, DUEDATE, ESTIMATEACTIVE, EXCHANGERATE, FOB, INCOMESUBJECTTOTAX, INVOICED, ITEM, ITEMDESC, LASTMODIFIEDBY, LATESTORPRIORSTATE, MEMO, MODIFIEDTIME, NAME, NAMEACCOUNTNUMBER, NAMEADDRESS, NAMECITY, NAMECONTACT, NAMEEMAIL, NAMEFAX, NAMEPHONE, NAMESTATE, NAMEZIP, OPENBALANCE, ORIGINALAMOUNT, PAIDAMOUNT, PAIDSTATUS, PAIDTHROUGHDATE, PAYMENTMETHOD, PAYROLLITEM, PONUMBER, PRINTSTATUS, PROGRESSAMOUNT, PROGRESSPERCENT, QUANTITY, QUANTITYAVAILABLE, QUANTITYONHAND, QUANTITYONSALESORDER, RECEIVEDQUANTITY, REFNUMBER, RUNNINGBALANCE, SALESREP, SALESTAXCODE, SHIPDATE, SHIPMETHOD, SOURCENAME, SPLITACCOUNT, SSNORTAXID, TAXLINE, TAXTABLEVERSION, TERMS, TXNID, TXNNUMBER, TXNTYPE, UNITPRICE, USEREDIT, VALUEONHAND, WAGEBASE, WAGEBASETIPS. | |
| SummarizeRowsBy | String | Groups and summarizes rows by a specific category, such as 'Account', 'Customer', or 'Class'. For example, if you set the value to Account, the reports row labels might be Checking, Savings, and so on.
The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TAXLINE, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. |