GET api/account/{id}/propertypaymentoverview?propertyAccountId={propertyAccountId}&propertySpecificOnly={propertySpecificOnly}
Get payment overview for a property account Processes this account API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The unique identifier of the requested resource. |
integer |
Required |
| propertyAccountId |
The unique identifier of the property account resource. |
integer |
Required |
| propertySpecificOnly |
The property specific only value supplied with the request. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
ExtendedAccountPaymentDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| CreditNoteItems |
The collection of credit note items. |
Collection of CreditNoteItemDetailDataContract |
None. |
| InvoiceDeductions |
The collection of invoice deductions. |
Collection of InvoiceAmountsDataContract |
None. |
| InvoicePayments |
The collection of invoice payments. |
Collection of InvoiceAmountsDataContract |
None. |
| Receipts |
The collection of receipts. |
Collection of ReceiptDataContract |
None. |
| Refunds |
The collection of refunds. |
Collection of RefundDataContract |
None. |
| RefundDeductions |
The collection of refund deductions. |
Collection of RefundDataContract |
None. |
| OpeningBalance |
The opening balance value. |
decimal number |
None. |
| PropertyRetentionAmount |
The property retention amount value. |
decimal number |
None. |
| GroupRetentionDetails |
The collection of group retention details. |
Collection of PropertyRetentionDetailDataContract |
None. |
| TotalBalance |
The total balance value. |
decimal number |
None. |
| UnallocatedCashBalance |
The unallocated cash balance value. |
decimal number |
None. |
| Name |
The name value. |
string |
None. |
| Received |
The received value. |
decimal number |
None. |
| TotalUncleared |
The total uncleared value. |
decimal number |
None. |
| Deductions |
The deductions value. |
decimal number |
None. |
| Total |
The total value. |
decimal number |
None. |
| AllDisbursements |
The all disbursements value. |
decimal number |
None. |
| NumberOfItems |
The number of items value. |
integer |
None. |
| LastStatementDate |
The last statement date, expressed as a date and time. |
date |
None. |
| AssociatedGroupId |
The unique identifier of the related associated group resource. |
integer |
None. |
| IsTenant |
Indicates whether this item is tenant. |
boolean |
None. |
| IsLandlord |
Indicates whether this item is landlord. |
boolean |
None. |
| IsCompany |
Indicates whether this item is company. |
boolean |
None. |
| TotalRetentionAmount |
The total retention amount value. |
decimal number |
None. |
| GroupAccountType |
The group account type value. |
string |
None. |
| TransactionReference |
The transaction reference value. |
string |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-21T21:21:04.4235936Z",
"Id": 8
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-21T21:21:04.4235936Z",
"Id": 8
}
],
"InvoiceDeductions": [
{
"PropertyAccountId": 1,
"Description": "sample string 1",
"TotalAmount": 2.0,
"SubTotalAmount": 3.0,
"TaxTotalAmount": 4.0,
"DiscountTotalAmount": 5.0,
"TotalOutstanding": 6.0,
"TotalPaid": 7.0,
"CreatedDate": "2026-07-21T21:21:04.4235936Z",
"InvoiceSubTypeName": "sample string 9",
"InvoiceItems": [
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
},
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
}
],
"AllocationCollections": [
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"Regarding": "sample string 3",
"Description": "sample string 4",
"AllocationItems": [
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 5
},
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"Regarding": "sample string 3",
"Description": "sample string 4",
"AllocationItems": [
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 5
}
],
"RelatedEntities": [
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
},
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
}
],
"PaymentLines": [
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
},
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
}
],
"AllocationIdentifier": 1,
"InvoiceNumber": 10,
"Id": 11
},
{
"PropertyAccountId": 1,
"Description": "sample string 1",
"TotalAmount": 2.0,
"SubTotalAmount": 3.0,
"TaxTotalAmount": 4.0,
"DiscountTotalAmount": 5.0,
"TotalOutstanding": 6.0,
"TotalPaid": 7.0,
"CreatedDate": "2026-07-21T21:21:04.4235936Z",
"InvoiceSubTypeName": "sample string 9",
"InvoiceItems": [
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
},
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
}
],
"AllocationCollections": [
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"Regarding": "sample string 3",
"Description": "sample string 4",
"AllocationItems": [
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 5
},
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"Regarding": "sample string 3",
"Description": "sample string 4",
"AllocationItems": [
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 5
}
],
"RelatedEntities": [
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
},
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
}
],
"PaymentLines": [
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
},
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
}
],
"AllocationIdentifier": 1,
"InvoiceNumber": 10,
"Id": 11
}
],
"InvoicePayments": [
{
"PropertyAccountId": 1,
"Description": "sample string 1",
"TotalAmount": 2.0,
"SubTotalAmount": 3.0,
"TaxTotalAmount": 4.0,
"DiscountTotalAmount": 5.0,
"TotalOutstanding": 6.0,
"TotalPaid": 7.0,
"CreatedDate": "2026-07-21T21:21:04.4235936Z",
"InvoiceSubTypeName": "sample string 9",
"InvoiceItems": [
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
},
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
}
],
"AllocationCollections": [
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"Regarding": "sample string 3",
"Description": "sample string 4",
"AllocationItems": [
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 5
},
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"Regarding": "sample string 3",
"Description": "sample string 4",
"AllocationItems": [
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 5
}
],
"RelatedEntities": [
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
},
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
}
],
"PaymentLines": [
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
},
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
}
],
"AllocationIdentifier": 1,
"InvoiceNumber": 10,
"Id": 11
},
{
"PropertyAccountId": 1,
"Description": "sample string 1",
"TotalAmount": 2.0,
"SubTotalAmount": 3.0,
"TaxTotalAmount": 4.0,
"DiscountTotalAmount": 5.0,
"TotalOutstanding": 6.0,
"TotalPaid": 7.0,
"CreatedDate": "2026-07-21T21:21:04.4235936Z",
"InvoiceSubTypeName": "sample string 9",
"InvoiceItems": [
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
},
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
}
],
"AllocationCollections": [
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"Regarding": "sample string 3",
"Description": "sample string 4",
"AllocationItems": [
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 5
},
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"Regarding": "sample string 3",
"Description": "sample string 4",
"AllocationItems": [
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-21T21:21:04.4235936Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 5
}
],
"RelatedEntities": [
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
},
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
}
],
"PaymentLines": [
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
},
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
}
],
"AllocationIdentifier": 1,
"InvoiceNumber": 10,
"Id": 11
}
],
"Receipts": [
{
"DateTime": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"PaymentType": 0,
"BankAccountId": 3,
"BankAccountName": "sample string 4",
"AccountId": 5,
"AccountName": "sample string 6",
"PropertyAccountId": 1,
"IsDeposited": true,
"DepositId": 1,
"Description": "sample string 8",
"OriginalAmount": 9.0,
"LedgerEntryId": 10,
"IsReversed": true,
"RetentionAmount": 12.0,
"Regarding": "sample string 13",
"Id": 14
},
{
"DateTime": "2026-07-21T21:21:04.4235936Z",
"Amount": 2.0,
"PaymentType": 0,
"BankAccountId": 3,
"BankAccountName": "sample string 4",
"AccountId": 5,
"AccountName": "sample string 6",
"PropertyAccountId": 1,
"IsDeposited": true,
"DepositId": 1,
"Description": "sample string 8",
"OriginalAmount": 9.0,
"LedgerEntryId": 10,
"IsReversed": true,
"RetentionAmount": 12.0,
"Regarding": "sample string 13",
"Id": 14
}
],
"Refunds": [
{
"Amount": 1.0,
"DateTime": "2026-07-21T21:21:04.439222Z",
"Description": "sample string 3",
"InvoiceId": 4,
"InvoiceNumber": 5,
"IssuingAccountId": 6,
"RecipientAccountId": 7,
"PropertyAccountId": 1,
"RefundItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"InvoiceId": 3,
"RefundId": 4,
"Id": 5
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"InvoiceId": 3,
"RefundId": 4,
"Id": 5
}
],
"Id": 8
},
{
"Amount": 1.0,
"DateTime": "2026-07-21T21:21:04.439222Z",
"Description": "sample string 3",
"InvoiceId": 4,
"InvoiceNumber": 5,
"IssuingAccountId": 6,
"RecipientAccountId": 7,
"PropertyAccountId": 1,
"RefundItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"InvoiceId": 3,
"RefundId": 4,
"Id": 5
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"InvoiceId": 3,
"RefundId": 4,
"Id": 5
}
],
"Id": 8
}
],
"RefundDeductions": [
{
"Amount": 1.0,
"DateTime": "2026-07-21T21:21:04.439222Z",
"Description": "sample string 3",
"InvoiceId": 4,
"InvoiceNumber": 5,
"IssuingAccountId": 6,
"RecipientAccountId": 7,
"PropertyAccountId": 1,
"RefundItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"InvoiceId": 3,
"RefundId": 4,
"Id": 5
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"InvoiceId": 3,
"RefundId": 4,
"Id": 5
}
],
"Id": 8
},
{
"Amount": 1.0,
"DateTime": "2026-07-21T21:21:04.439222Z",
"Description": "sample string 3",
"InvoiceId": 4,
"InvoiceNumber": 5,
"IssuingAccountId": 6,
"RecipientAccountId": 7,
"PropertyAccountId": 1,
"RefundItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"InvoiceId": 3,
"RefundId": 4,
"Id": 5
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"InvoiceId": 3,
"RefundId": 4,
"Id": 5
}
],
"Id": 8
}
],
"OpeningBalance": 1.0,
"PropertyRetentionAmount": 1.0,
"GroupRetentionDetails": [
{
"GroupId": 1,
"PropertyId": 2,
"PropertyAccountId": 3,
"FullAddress": "sample string 4",
"RetentionAmount": 1.0,
"AmountToRetain": 1.0,
"ReceivedAmount": 1.0,
"AvailableBalance": 1.0,
"TotalBalance": 1.0,
"UnallocatedCashBalance": 5.0
},
{
"GroupId": 1,
"PropertyId": 2,
"PropertyAccountId": 3,
"FullAddress": "sample string 4",
"RetentionAmount": 1.0,
"AmountToRetain": 1.0,
"ReceivedAmount": 1.0,
"AvailableBalance": 1.0,
"TotalBalance": 1.0,
"UnallocatedCashBalance": 5.0
}
],
"TotalBalance": 2.0,
"UnallocatedCashBalance": 3.0,
"Name": "sample string 4",
"Received": 5.0,
"TotalUncleared": 6.0,
"Deductions": 7.0,
"Total": 8.0,
"AllDisbursements": 9.0,
"NumberOfItems": 10,
"LastStatementDate": "2026-07-21T21:21:04.439222Z",
"AssociatedGroupId": 11,
"IsTenant": true,
"IsLandlord": true,
"IsCompany": true,
"TotalRetentionAmount": 1.0,
"GroupAccountType": "sample string 12",
"TransactionReference": "sample string 13",
"Id": 14
}