POST api/list/stats/invoice

Invoice. Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The filters value supplied with the request.

Collection of InvoiceFilterDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
LiableAccountId	The unique identifier of the related liable account resource.	integer	None.
RecipientAccountId	The unique identifier of the related recipient account resource.	integer	None.
LiableGroupId	The unique identifier of the related liable group resource.	integer	None.
RecipientGroupId	The unique identifier of the related recipient group resource.	integer	None.
TenancyRoleId	The unique identifier of the related tenancy role resource.	integer	None.
Types	The collection of types.	Collection of InvoiceType	None.
Statuses	The collection of statuses.	Collection of InvoiceStatusType	None.
FromDate	The from date, expressed as a date and time.	date	None.
ToDate	The to date, expressed as a date and time.	date	None.
Ascending	Indicates whether ascending is true.	boolean	None.
Order	The order classification.	InvoiceOrder	None.
SearchCriteria	The search criteria value.	InvoiceSearchCriteriaDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

[
  {
    "Name": "sample string 1",
    "LiableAccountId": 1,
    "RecipientAccountId": 1,
    "LiableGroupId": 1,
    "RecipientGroupId": 1,
    "TenancyRoleId": 1,
    "Types": [
      0,
      0
    ],
    "Statuses": [
      0,
      0
    ],
    "FromDate": "2026-08-05T00:19:52.5347921Z",
    "ToDate": "2026-08-05T00:19:52.5347921Z",
    "Ascending": true,
    "Order": 0,
    "SearchCriteria": {
      "SearchTerm": "sample string 1",
      "SubTypes": [
        0,
        0
      ],
      "ExcludeSubTypes": [
        0,
        0
      ]
    }
  },
  {
    "Name": "sample string 1",
    "LiableAccountId": 1,
    "RecipientAccountId": 1,
    "LiableGroupId": 1,
    "RecipientGroupId": 1,
    "TenancyRoleId": 1,
    "Types": [
      0,
      0
    ],
    "Statuses": [
      0,
      0
    ],
    "FromDate": "2026-08-05T00:19:52.5347921Z",
    "ToDate": "2026-08-05T00:19:52.5347921Z",
    "Ascending": true,
    "Order": 0,
    "SearchCriteria": {
      "SearchTerm": "sample string 1",
      "SubTypes": [
        0,
        0
      ],
      "ExcludeSubTypes": [
        0,
        0
      ]
    }
  }
]

Response Information

Resource Description

The response returned after the operation completes.

Collection of ListStatsDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
Value	The value represented by this field.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Name": "sample string 1",
    "Value": 2
  },
  {
    "Name": "sample string 1",
    "Value": 2
  }
]