POST api/invoice/invoiceoverview

Get a summary of invoices outstanding, paid and funds available for an account.

Request Information

URI Parameters

None.

Body Parameters

A filter for returning invoices

Name	Type	Additional information
Name	string	None.
LiableAccountId	integer	None.
RecipientAccountId	integer	None.
LiableGroupId	integer	None.
RecipientGroupId	integer	None.
TenancyRoleId	integer	None.
Types	Collection of InvoiceType	None.
Statuses	Collection of InvoiceStatusType	None.
FromDate	date	None.
ToDate	date	None.
Ascending	boolean	None.
Order	InvoiceOrder	None.
SearchCriteria	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": "2025-11-16T02:21:42.845101Z",
  "ToDate": "2025-11-16T02:21:42.845101Z",
  "Ascending": true,
  "Order": 0,
  "SearchCriteria": {
    "SearchTerm": "sample string 1",
    "SubTypes": [
      0,
      0
    ],
    "ExcludeSubTypes": [
      0,
      0
    ]
  }
}

Response Information

Resource Description

InvoiceOverviewDataContract

Name	Type	Additional information
Paid	decimal number	None.
ClearedAvailable	decimal number	None.
UnclearedAvailable	decimal number	None.
Due	decimal number	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Paid": 1.0,
  "ClearedAvailable": 2.0,
  "UnclearedAvailable": 3.0,
  "Due": 4.0,
  "Id": 5
}