GET api/Income/{id}?type={type}
Gets a list of income.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Organization Id. |
integer |
Required |
| type |
List Type. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of Income| Name | Description | Type | Additional information |
|---|---|---|---|
| UpdateType | string |
None. |
|
| OrderId | integer |
None. |
|
| OrderNumber | integer |
None. |
|
| OrderStatusId | integer |
None. |
|
| OrderStatus | string |
None. |
|
| OrderTypeId | integer |
None. |
|
| OrderType | string |
None. |
|
| CustomerId | integer |
None. |
|
| CustomerDisplayName | string |
None. |
|
| OrderTotal | decimal number |
None. |
|
| IsPaid | boolean |
None. |
|
| OrderProcessedDate | date |
None. |
|
| CreatedBy | string |
None. |
|
| CreatedByName | string |
None. |
|
| CreatedDate | date |
None. |
|
| UpdatedBy | string |
None. |
|
| UpdatedByName | string |
None. |
|
| UpdatedDate | date |
None. |
|
| GlobalId | string |
None. |
|
| IsIncome | boolean |
None. |
|
| IncomeToFinancialAccountId | integer |
None. |
|
| FinancialAccount | string |
None. |
|
| FinancialAccountGlobalId | string |
None. |
|
| AccountingYear | integer |
None. |
|
| OrderNote | string |
None. |
|
| IncomeReferenceNumber | string |
None. |
|
| IncomeCategoryId | integer |
None. |
|
| IncomeCategory | string |
None. |
|
| OrganizationId | integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"UpdateType": "sample string 1",
"OrderId": 2,
"OrderNumber": 1,
"OrderStatusId": 1,
"OrderStatus": "sample string 3",
"OrderTypeId": 1,
"OrderType": "sample string 4",
"CustomerId": 1,
"CustomerDisplayName": "sample string 5",
"OrderTotal": 1.0,
"IsPaid": true,
"OrderProcessedDate": "2025-12-13T00:57:33.2754638+00:00",
"CreatedBy": "sample string 6",
"CreatedByName": "sample string 7",
"CreatedDate": "2025-12-13T00:57:33.2754638+00:00",
"UpdatedBy": "sample string 8",
"UpdatedByName": "sample string 9",
"UpdatedDate": "2025-12-13T00:57:33.2754638+00:00",
"GlobalId": "sample string 10",
"IsIncome": true,
"IncomeToFinancialAccountId": 1,
"FinancialAccount": "sample string 11",
"FinancialAccountGlobalId": "sample string 12",
"AccountingYear": 1,
"OrderNote": "sample string 13",
"IncomeReferenceNumber": "sample string 14",
"IncomeCategoryId": 1,
"IncomeCategory": "sample string 15",
"OrganizationId": 1
},
{
"UpdateType": "sample string 1",
"OrderId": 2,
"OrderNumber": 1,
"OrderStatusId": 1,
"OrderStatus": "sample string 3",
"OrderTypeId": 1,
"OrderType": "sample string 4",
"CustomerId": 1,
"CustomerDisplayName": "sample string 5",
"OrderTotal": 1.0,
"IsPaid": true,
"OrderProcessedDate": "2025-12-13T00:57:33.2754638+00:00",
"CreatedBy": "sample string 6",
"CreatedByName": "sample string 7",
"CreatedDate": "2025-12-13T00:57:33.2754638+00:00",
"UpdatedBy": "sample string 8",
"UpdatedByName": "sample string 9",
"UpdatedDate": "2025-12-13T00:57:33.2754638+00:00",
"GlobalId": "sample string 10",
"IsIncome": true,
"IncomeToFinancialAccountId": 1,
"FinancialAccount": "sample string 11",
"FinancialAccountGlobalId": "sample string 12",
"AccountingYear": 1,
"OrderNote": "sample string 13",
"IncomeReferenceNumber": "sample string 14",
"IncomeCategoryId": 1,
"IncomeCategory": "sample string 15",
"OrganizationId": 1
}
]
application/xml, text/xml
Sample:
<ArrayOfIncome xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CustomersdbWebShared.Models">
<Income>
<AccountingYear>1</AccountingYear>
<CreatedBy>sample string 6</CreatedBy>
<CreatedByName>sample string 7</CreatedByName>
<CreatedDate>2025-12-13T00:57:33.2754638+00:00</CreatedDate>
<CustomerDisplayName>sample string 5</CustomerDisplayName>
<CustomerId>1</CustomerId>
<FinancialAccount>sample string 11</FinancialAccount>
<FinancialAccountGlobalId>sample string 12</FinancialAccountGlobalId>
<GlobalId>sample string 10</GlobalId>
<IncomeCategory>sample string 15</IncomeCategory>
<IncomeCategoryId>1</IncomeCategoryId>
<IncomeReferenceNumber>sample string 14</IncomeReferenceNumber>
<IncomeToFinancialAccountId>1</IncomeToFinancialAccountId>
<IsIncome>true</IsIncome>
<IsPaid>true</IsPaid>
<OrderId>2</OrderId>
<OrderNote>sample string 13</OrderNote>
<OrderNumber>1</OrderNumber>
<OrderProcessedDate>2025-12-13T00:57:33.2754638+00:00</OrderProcessedDate>
<OrderStatus>sample string 3</OrderStatus>
<OrderStatusId>1</OrderStatusId>
<OrderTotal>1</OrderTotal>
<OrderType>sample string 4</OrderType>
<OrderTypeId>1</OrderTypeId>
<OrganizationId>1</OrganizationId>
<UpdateType>sample string 1</UpdateType>
<UpdatedBy>sample string 8</UpdatedBy>
<UpdatedByName>sample string 9</UpdatedByName>
<UpdatedDate>2025-12-13T00:57:33.2754638+00:00</UpdatedDate>
</Income>
<Income>
<AccountingYear>1</AccountingYear>
<CreatedBy>sample string 6</CreatedBy>
<CreatedByName>sample string 7</CreatedByName>
<CreatedDate>2025-12-13T00:57:33.2754638+00:00</CreatedDate>
<CustomerDisplayName>sample string 5</CustomerDisplayName>
<CustomerId>1</CustomerId>
<FinancialAccount>sample string 11</FinancialAccount>
<FinancialAccountGlobalId>sample string 12</FinancialAccountGlobalId>
<GlobalId>sample string 10</GlobalId>
<IncomeCategory>sample string 15</IncomeCategory>
<IncomeCategoryId>1</IncomeCategoryId>
<IncomeReferenceNumber>sample string 14</IncomeReferenceNumber>
<IncomeToFinancialAccountId>1</IncomeToFinancialAccountId>
<IsIncome>true</IsIncome>
<IsPaid>true</IsPaid>
<OrderId>2</OrderId>
<OrderNote>sample string 13</OrderNote>
<OrderNumber>1</OrderNumber>
<OrderProcessedDate>2025-12-13T00:57:33.2754638+00:00</OrderProcessedDate>
<OrderStatus>sample string 3</OrderStatus>
<OrderStatusId>1</OrderStatusId>
<OrderTotal>1</OrderTotal>
<OrderType>sample string 4</OrderType>
<OrderTypeId>1</OrderTypeId>
<OrganizationId>1</OrganizationId>
<UpdateType>sample string 1</UpdateType>
<UpdatedBy>sample string 8</UpdatedBy>
<UpdatedByName>sample string 9</UpdatedByName>
<UpdatedDate>2025-12-13T00:57:33.2754638+00:00</UpdatedDate>
</Income>
</ArrayOfIncome>