GET api/account/payments/overview

Get an overview of account amounts and totals Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

AccountPaymentOverviewDataContract
NameDescriptionTypeAdditional information
TotalAmount

The total amount value.

decimal number

None.

TotalCount

The total count value.

integer

None.

LandlordTotal

The landlord total value.

decimal number

None.

LandlordCount

The landlord count value.

integer

None.

SupplierTotal

The supplier total value.

decimal number

None.

SupplierCount

The supplier count value.

integer

None.

TenantTotal

The tenant total value.

decimal number

None.

TenantCount

The tenant count value.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalAmount": 1.0,
  "TotalCount": 2,
  "LandlordTotal": 3.0,
  "LandlordCount": 4,
  "SupplierTotal": 5.0,
  "SupplierCount": 6,
  "TenantTotal": 7.0,
  "TenantCount": 8
}