GET api/IncomeReport/{id}?type={type}&year={year}

Gets a list of income report item.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Organization Id.	integer	Required
type	List Type.	string	Required
year	Year.	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of IncomeReport

Name	Type	Additional information
OrderId	integer	None.
FinancialAccountId	integer	None.
FinancialAccount	string	None.
OrderProcessedDate	date	None.
OrderTotal	decimal number	None.
CustomerId	integer	None.
CustomerDisplayName	string	None.
IncomeCategoryId	integer	None.
Category	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "OrderId": 1,
    "FinancialAccountId": 1,
    "FinancialAccount": "sample string 2",
    "OrderProcessedDate": "2025-01-16T07:05:57.1357941+00:00",
    "OrderTotal": 1.0,
    "CustomerId": 1,
    "CustomerDisplayName": "sample string 3",
    "IncomeCategoryId": 1,
    "Category": "sample string 4"
  },
  {
    "OrderId": 1,
    "FinancialAccountId": 1,
    "FinancialAccount": "sample string 2",
    "OrderProcessedDate": "2025-01-16T07:05:57.1357941+00:00",
    "OrderTotal": 1.0,
    "CustomerId": 1,
    "CustomerDisplayName": "sample string 3",
    "IncomeCategoryId": 1,
    "Category": "sample string 4"
  }
]

application/xml, text/xml

Sample:

<ArrayOfIncomeReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CustomersdbWebShared.Models">
  <IncomeReport>
    <Category>sample string 4</Category>
    <CustomerDisplayName>sample string 3</CustomerDisplayName>
    <CustomerId>1</CustomerId>
    <FinancialAccount>sample string 2</FinancialAccount>
    <FinancialAccountId>1</FinancialAccountId>
    <IncomeCategoryId>1</IncomeCategoryId>
    <OrderId>1</OrderId>
    <OrderProcessedDate>2025-01-16T07:05:57.1357941+00:00</OrderProcessedDate>
    <OrderTotal>1</OrderTotal>
  </IncomeReport>
  <IncomeReport>
    <Category>sample string 4</Category>
    <CustomerDisplayName>sample string 3</CustomerDisplayName>
    <CustomerId>1</CustomerId>
    <FinancialAccount>sample string 2</FinancialAccount>
    <FinancialAccountId>1</FinancialAccountId>
    <IncomeCategoryId>1</IncomeCategoryId>
    <OrderId>1</OrderId>
    <OrderProcessedDate>2025-01-16T07:05:57.1357941+00:00</OrderProcessedDate>
    <OrderTotal>1</OrderTotal>
  </IncomeReport>
</ArrayOfIncomeReport>