POST ProfitAndLoss/Get
Retrieves a Profit And Loss report.
Request Information
URI Parameters
None.
Body Parameters
Profit And Loss Statement Request Model| Name | Type | Additional information | Description |
|---|---|---|---|
| FromDate | date |
None. |
Gets or sets From Date. |
| ToDate | date |
None. |
Gets or sets To Date. |
| UsePurchases | bool |
None. |
|
| DisplayReportingGroupDetail | bool |
None. |
Use Account Reporting Groups to view either a summary of grouped accounts or the individual accounts making up a group total on your financial statement reports. |
| Comparative | bool |
None. |
Comparative by Last Year. |
| BudgetId | nullable integer |
None. |
Valid BudgetId will always override Compative by Last Year. |
| ShowVariance | bool |
None. |
Budget Variance |
Request Formats
application/json, text/json
Sample:
{
"UsePurchases": true,
"DisplayReportingGroupDetail": true,
"Comparative": true,
"BudgetId": 1,
"ShowVariance": true,
"FromDate": "2025-12-21",
"ToDate": "2025-12-21"
}
Response Information
Resource Description
Collection of Profit And Loss Reporting Level| Name | Type | Additional information | Description |
|---|---|---|---|
| ID | integer |
None. |
|
| Description | string |
Required String length: inclusive between 0 and 100 |
|
| Category | string |
None. |
|
| CategoryId | integer |
None. |
|
| AccountTypeId | integer |
None. |
|
| Children | Collection of Profit And Loss Reporting Level |
None. |
|
| ReportingLevelType | Reporting Level Type |
None. |
|
| AccountCategoryId | integer |
None. |
|
| AccountCategoryOrder | integer |
None. |
|
| AccountNumber | string |
None. |
|
| ItemReportingGroupTypeId | integer |
None. |
|
| Total | Collection of nullable decimal |
None. |
|
| Variance | nullable decimal |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Total": [
1.0,
1.0
],
"Variance": 1.0,
"ID": 2,
"Description": "sample string 3",
"Category": "sample string 4",
"CategoryId": 5,
"AccountTypeId": 6,
"Children": [],
"ReportingLevelType": 1,
"AccountCategoryId": 7,
"AccountCategoryOrder": 8,
"AccountNumber": "sample string 10",
"ItemReportingGroupTypeId": 11
},
{
"Total": [
1.0,
1.0
],
"Variance": 1.0,
"ID": 2,
"Description": "sample string 3",
"Category": "sample string 4",
"CategoryId": 5,
"AccountTypeId": 6,
"Children": [],
"ReportingLevelType": 1,
"AccountCategoryId": 7,
"AccountCategoryOrder": 8,
"AccountNumber": "sample string 10",
"ItemReportingGroupTypeId": 11
}
]