GET api/account/{id}/propertypaymentoverview?propertyAccountId={propertyAccountId}&propertySpecificOnly={propertySpecificOnly}

Get payment overview for a property account

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

propertyAccountId

integer

Required

propertySpecificOnly

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Dezrez.Core.DataContracts.Accounts.Financial.Query.ExtendedAccountPaymentDataContract
NameDescriptionTypeAdditional information
CreditNoteItems

Collection of Dezrez.Core.DataContracts.Accounts.CreditNotes.Query.CreditNoteItemDetailDataContract

None.

InvoiceDeductions

Collection of Dezrez.Core.DataContracts.Accounts.Invoices.Query.InvoiceAmountsDataContract

None.

InvoicePayments

Collection of Dezrez.Core.DataContracts.Accounts.Invoices.Query.InvoiceAmountsDataContract

None.

Receipts

Collection of Dezrez.Core.DataContracts.Accounts.Financial.Query.Receipt.ReceiptDataContract

None.

Refunds

Collection of Dezrez.Core.DataContracts.Accounts.Refunds.Query.RefundDataContract

None.

RefundDeductions

Collection of Dezrez.Core.DataContracts.Accounts.Refunds.Query.RefundDataContract

None.

OpeningBalance

decimal number

None.

PropertyRetentionAmount

decimal number

None.

TotalBalance

decimal number

None.

Name

string

None.

Received

decimal number

None.

TotalUncleared

decimal number

None.

Deductions

decimal number

None.

Total

decimal number

None.

AllDisbursements

decimal number

None.

NumberOfItems

integer

None.

LastStatementDate

date

None.

AssociatedGroupId

integer

None.

IsTenant

boolean

None.

IsLandlord

boolean

None.

IsCompany

boolean

None.

TotalRetentionAmount

decimal number

None.

GroupAccountType

string

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "CreditNoteItems": [
    {
      "Amount": 1.0,
      "InvoiceItemId": 2,
      "CreditNoteId": 3,
      "Reason": "sample string 4",
      "InvoiceNumber": 5,
      "Id": 6
    },
    {
      "Amount": 1.0,
      "InvoiceItemId": 2,
      "CreditNoteId": 3,
      "Reason": "sample string 4",
      "InvoiceNumber": 5,
      "Id": 6
    }
  ],
  "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": "2024-10-04T18:57:29.2897649Z",
      "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": "2024-10-04T18:57:29.2897649Z",
          "Amount": 2.0,
          "Description": "sample string 3",
          "AllocationItems": [
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            },
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            }
          ],
          "Id": 4
        },
        {
          "Date": "2024-10-04T18:57:29.2897649Z",
          "Amount": 2.0,
          "Description": "sample string 3",
          "AllocationItems": [
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            },
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            }
          ],
          "Id": 4
        }
      ],
      "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": "2024-10-04T18:57:29.2897649Z",
      "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": "2024-10-04T18:57:29.2897649Z",
          "Amount": 2.0,
          "Description": "sample string 3",
          "AllocationItems": [
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            },
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            }
          ],
          "Id": 4
        },
        {
          "Date": "2024-10-04T18:57:29.2897649Z",
          "Amount": 2.0,
          "Description": "sample string 3",
          "AllocationItems": [
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            },
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            }
          ],
          "Id": 4
        }
      ],
      "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": "2024-10-04T18:57:29.2897649Z",
      "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": "2024-10-04T18:57:29.2897649Z",
          "Amount": 2.0,
          "Description": "sample string 3",
          "AllocationItems": [
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            },
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            }
          ],
          "Id": 4
        },
        {
          "Date": "2024-10-04T18:57:29.2897649Z",
          "Amount": 2.0,
          "Description": "sample string 3",
          "AllocationItems": [
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            },
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            }
          ],
          "Id": 4
        }
      ],
      "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": "2024-10-04T18:57:29.2897649Z",
      "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": "2024-10-04T18:57:29.2897649Z",
          "Amount": 2.0,
          "Description": "sample string 3",
          "AllocationItems": [
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            },
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            }
          ],
          "Id": 4
        },
        {
          "Date": "2024-10-04T18:57:29.2897649Z",
          "Amount": 2.0,
          "Description": "sample string 3",
          "AllocationItems": [
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            },
            {
              "Date": "2024-10-04T18:57:29.2897649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-04T18:57:29.2897649Z",
              "LandlordProtected": true,
              "Id": 9
            }
          ],
          "Id": 4
        }
      ],
      "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": "2024-10-04T18:57:29.2897649Z",
      "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,
      "Id": 12
    },
    {
      "DateTime": "2024-10-04T18:57:29.2897649Z",
      "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,
      "Id": 12
    }
  ],
  "Refunds": [
    {
      "Amount": 1.0,
      "DateTime": "2024-10-04T18:57:29.2897649Z",
      "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": "2024-10-04T18:57:29.2897649Z",
      "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": "2024-10-04T18:57:29.2897649Z",
      "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": "2024-10-04T18:57:29.2897649Z",
      "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,
  "TotalBalance": 2.0,
  "Name": "sample string 3",
  "Received": 4.0,
  "TotalUncleared": 5.0,
  "Deductions": 6.0,
  "Total": 7.0,
  "AllDisbursements": 8.0,
  "NumberOfItems": 9,
  "LastStatementDate": "2024-10-04T18:57:29.2897649Z",
  "AssociatedGroupId": 10,
  "IsTenant": true,
  "IsLandlord": true,
  "IsCompany": true,
  "TotalRetentionAmount": 1.0,
  "GroupAccountType": "sample string 11",
  "Id": 12
}