POST IncomeVsExpense/Get

Gets the specified Item Category based on the identifier.

Request Information

URI Parameters

None.

Body Parameters

The request.

Income Vs Expense Request Model
NameTypeAdditional informationDescription
FromDate date

None.

Gets or sets From Date.

ToDate date

None.

Gets or sets To Date.

UsePurchases bool

None.

Gets or sets a value indicating whether or not to use purchases.

PeriodGroupingLength integer

None.

Gets or sets the length of the period grouping.

Comparative bool

None.

Gets or sets a value indicating whether this is comparative.

Request Formats

application/json, text/json

Sample:
{
  "UsePurchases": true,
  "PeriodGroupingLength": 2,
  "Comparative": true,
  "FromDate": "2024-04-17T00:00:00+10:00",
  "ToDate": "2024-04-17T00:00:00+10:00"
}

Response Information

Resource Description

Income Vs Expense
NameTypeAdditional informationDescription
FromDate date

None.

Gets or sets From Date.

ToDate date

None.

Gets or sets To Date.

Periods Collection of Income Vs Expenses Period Grouping

None.

Gets or sets the Income Vs Expenses Period Groupings.

IsComparative bool

None.

Gets or sets a value indicating whether this instance is comparative.

UsePurchases bool

None.

Gets or sets a value indicating whether this instance uses Purchases.

Response Formats

application/json, text/json

Sample:
{
  "FromDate": "2024-04-17T00:00:00+10:00",
  "ToDate": "2024-04-17T00:00:00+10:00",
  "Periods": [
    {
      "IncomeAmount": 1.0,
      "ExpenseAmount": 2.0,
      "Description": "Apr 24-Apr 24",
      "StartDate": "2024-04-17T00:00:00+10:00",
      "EndDate": "2024-04-17T00:00:00+10:00",
      "PeriodComparativeType": 0
    },
    {
      "IncomeAmount": 1.0,
      "ExpenseAmount": 2.0,
      "Description": "Apr 24-Apr 24",
      "StartDate": "2024-04-17T00:00:00+10:00",
      "EndDate": "2024-04-17T00:00:00+10:00",
      "PeriodComparativeType": 0
    }
  ],
  "IsComparative": true,
  "UsePurchases": true
}