ProfitAndLossStandard
Creates year-to-date Profit and Loss comparison reports, offering insights into financial performance over time.
Columns
| Name | Type | References | Description |
| Label | String | The label or title of each row in the Profit and Loss Standard report, providing context for the associated data, such as account names or categories. | |
| Amount | Double | The numerical value in the Profit and Loss Standard report, representing monetary amounts such as revenue, expenses, or totals. | |
| RowType | String | The classification of the row in the report, indicating whether it contains text, numerical data, subtotals, or 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 | The date range for the report, specified in the format fromdate:todate. Either value may be omitted for open-ended ranges (for example, 2024-12-25:). Dates must be in the format yyyy-MM-dd. | |
| ReportDateRangeMacro | String | A predefined macro for selecting the report date range, 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 | The type of account to include in the report, such as 'Income', 'Expense', or 'Cost of Goods Sold'.
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. When specified, AccountListType must also have a value. | |
| AccountListType | String | Indicates the type of accounts in the AccountList, such as 'Name' or 'ID', to filter the report.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. | |
| EntityType | String | The type of entity to include in the report, 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. When specified, EntityListType must also have a value. | |
| EntityListType | String | Specifies the format of the entities in EntityList, such as 'Name' or 'ID'.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. | |
| ItemType | String | The type of item to include in the report, 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. When specified, ItemListType must also have a value. | |
| ItemListType | String | Defines the format of the items in ItemList, such as 'Name' or 'ID'.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. | |
| ClassList | String | A comma-separated list of class names or IDs to filter the report. Specify ClassListType to define the format. | |
| ClassListType | String | Defines the format of the classes in ClassList, such as 'Name' or 'ID'.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. | |
| TransactionTypes | String | A list of transaction types to include in the report, separated by commas. Examples include 'Invoice', 'Bill', and 'SalesReceipt'. Specify 'ALL' for all types. | |
| ModifiedDateRange | String | Filters records by modification date within the specified range, in the format fromdate:todate. Either value can be omitted for open-ended ranges (for example, 2024-12-25:). Dates must follow the format yyyy-MM-dd. | |
| ModifiedDateRangeMacro | String | A predefined macro for filtering records by modified date, such as 'Last 7 Days' or 'This Month'.
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 | Determines 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 by posting status, allowing 'Posting', 'NonPosting', or 'Both'.
The allowed values are EITHER, NONPOSTING, POSTING. | |
| ReportAsOf | String | Sets a specific date to calculate open balance information in the report, such as '2024-12-31'.
The allowed values are REPORTENDDATE, TODAY. | |
| SummarizeColumnsBy | String | Specifies how columns are calculated and labeled, such as by 'Month', 'Quarter', or 'Year'.
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, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. | |
| IncludeSubColumns | String | A boolean value that indicates whether to include subcolumns in the report. Set to 'true' to include subcolumns or 'false' to exclude them. | |
| ReportBasis | String | Defines the accounting basis for the report: 'Cash', 'Accrual', or 'None'. Cash basis considers when money changes hands, while accrual basis uses the date of invoices or bills. | |
| ReturnColumns | String | Specifies the type of columns to return: 'Active' for columns with active information, 'Nonzero' for nonzero values, or 'All' for all columns.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. | |
| ReturnRows | String | Specifies the type of rows to include: 'Active' for rows with active information, 'Nonzero' for nonzero values, or 'All' for all rows.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. | |
| ReportCalendar | String | Defines the type of calendar used in the report, such as 'Fiscal Year' or 'Calendar Year'.
The allowed values are NONE, CALENDARYEAR, FISCALYEAR, TAXYEAR. |