GET api/deposit/unprotected?pageSize={pageSize}&pageNumber={pageNumber}&sort={sort}&ascending={ascending}

Returns a list of all deposit invoices that have unprotected allocations.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageSize

integer

Default value is 25

pageNumber

integer

Default value is 1

sort

Dezrez.Core.DataContracts.Accounts.Api.Query.SortOrder

Default value is CreatedDate

ascending

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lettings.Query.UnprotectedDepositListDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of Dezrez.Core.DataContracts.External.Api.Lettings.Query.UnprotectedDepositListDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "Address": "sample string 1",
      "ReceivedBy": "sample string 2",
      "TenantRoleId": 3,
      "UnprotectedDepositInvoice": {
        "RecipientAccountId": 1,
        "LiableAccountId": 2,
        "RecipientAccountName": "sample string 3",
        "RecipientGroupId": 4,
        "LiableAccountName": "sample string 5",
        "LiableAccountBalance": 6.0,
        "LiableGroupId": 7.0,
        "Status": "sample string 8",
        "DueDate": "2024-10-30T15:17:09.8479709Z",
        "CreatedDate": "2024-10-30T15:17:09.8479709Z",
        "RentPeriodEndDate": "2024-10-30T15:17:09.8479709Z",
        "InvoiceNumber": 11,
        "Description": "sample string 12",
        "InvoiceType": "sample string 13",
        "InvoiceSubType": "sample string 14",
        "TotalAmount": 15.0,
        "SubTotalAmount": 16.0,
        "TaxTotalAmount": 17.0,
        "DiscountTotalAmount": 18.0,
        "TotalOutstanding": 19.0,
        "TotalPaid": 20.0,
        "Notes": "sample string 21",
        "Payments": [
          {
            "PaymentNumber": "sample string 1",
            "Amount": 2.0,
            "Date": "2024-10-30T15:17:09.8479709Z",
            "Id": 4
          },
          {
            "PaymentNumber": "sample string 1",
            "Amount": 2.0,
            "Date": "2024-10-30T15:17:09.8479709Z",
            "Id": 4
          }
        ],
        "Allocations": [
          {
            "Date": "2024-10-30T15:17:09.8479709Z",
            "Amount": 2.0,
            "Description": "sample string 3",
            "AllocationItems": [
              {
                "Date": "2024-10-30T15:17:09.8479709Z",
                "Amount": 2.0,
                "InvoiceId": 3,
                "InvoiceItemId": 4,
                "InvoiceItemDescription": "sample string 5",
                "Protected": true,
                "ProtectedDate": "2024-10-30T15:17:09.8479709Z",
                "LandlordProtected": true,
                "Id": 9
              },
              {
                "Date": "2024-10-30T15:17:09.8479709Z",
                "Amount": 2.0,
                "InvoiceId": 3,
                "InvoiceItemId": 4,
                "InvoiceItemDescription": "sample string 5",
                "Protected": true,
                "ProtectedDate": "2024-10-30T15:17:09.8479709Z",
                "LandlordProtected": true,
                "Id": 9
              }
            ],
            "Id": 4
          },
          {
            "Date": "2024-10-30T15:17:09.8479709Z",
            "Amount": 2.0,
            "Description": "sample string 3",
            "AllocationItems": [
              {
                "Date": "2024-10-30T15:17:09.8479709Z",
                "Amount": 2.0,
                "InvoiceId": 3,
                "InvoiceItemId": 4,
                "InvoiceItemDescription": "sample string 5",
                "Protected": true,
                "ProtectedDate": "2024-10-30T15:17:09.8479709Z",
                "LandlordProtected": true,
                "Id": 9
              },
              {
                "Date": "2024-10-30T15:17:09.8479709Z",
                "Amount": 2.0,
                "InvoiceId": 3,
                "InvoiceItemId": 4,
                "InvoiceItemDescription": "sample string 5",
                "Protected": true,
                "ProtectedDate": "2024-10-30T15:17:09.8479709Z",
                "LandlordProtected": true,
                "Id": 9
              }
            ],
            "Id": 4
          }
        ],
        "InvoiceItems": [
          {
            "TaxAmount": 1.0,
            "SubTotalAmount": 2.0,
            "TotalOutstanding": 3.0,
            "Amount": 4.0,
            "Name": "sample string 5",
            "IsTaxable": true,
            "TaxitemId": 1,
            "Discount": 7.0,
            "DiscountName": "sample string 8",
            "DiscountDate": "2024-10-30T15:17:09.8479709Z",
            "Type": 0,
            "RelatedEntityId": 9,
            "CreditNoteItems": [
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "CreditNoteId": 3,
                "Reason": "sample string 4",
                "InvoiceNumber": 5,
                "InvoiceId": 6,
                "CreatedDate": "2024-10-30T15:17:09.8479709Z",
                "Id": 8
              },
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "CreditNoteId": 3,
                "Reason": "sample string 4",
                "InvoiceNumber": 5,
                "InvoiceId": 6,
                "CreatedDate": "2024-10-30T15:17:09.8479709Z",
                "Id": 8
              }
            ],
            "RefundItems": [
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "InvoiceId": 3,
                "RefundId": 4,
                "Id": 5
              },
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "InvoiceId": 3,
                "RefundId": 4,
                "Id": 5
              }
            ],
            "Id": 10
          },
          {
            "TaxAmount": 1.0,
            "SubTotalAmount": 2.0,
            "TotalOutstanding": 3.0,
            "Amount": 4.0,
            "Name": "sample string 5",
            "IsTaxable": true,
            "TaxitemId": 1,
            "Discount": 7.0,
            "DiscountName": "sample string 8",
            "DiscountDate": "2024-10-30T15:17:09.8479709Z",
            "Type": 0,
            "RelatedEntityId": 9,
            "CreditNoteItems": [
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "CreditNoteId": 3,
                "Reason": "sample string 4",
                "InvoiceNumber": 5,
                "InvoiceId": 6,
                "CreatedDate": "2024-10-30T15:17:09.8479709Z",
                "Id": 8
              },
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "CreditNoteId": 3,
                "Reason": "sample string 4",
                "InvoiceNumber": 5,
                "InvoiceId": 6,
                "CreatedDate": "2024-10-30T15:17:09.8479709Z",
                "Id": 8
              }
            ],
            "RefundItems": [
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "InvoiceId": 3,
                "RefundId": 4,
                "Id": 5
              },
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "InvoiceId": 3,
                "RefundId": 4,
                "Id": 5
              }
            ],
            "Id": 10
          }
        ],
        "LinkedFees": [
          {
            "LiableAccountId": 1,
            "RecipientAccountId": 2,
            "FeeId": 3,
            "ExternalReference": 4,
            "Id": 5
          },
          {
            "LiableAccountId": 1,
            "RecipientAccountId": 2,
            "FeeId": 3,
            "ExternalReference": 4,
            "Id": 5
          }
        ],
        "PropertyId": 1,
        "TenancyRoleId": 1,
        "Address": "sample string 22",
        "RelatedInvoiceId": 1,
        "CustomInvoiceNumber": "sample string 23",
        "DocumentIds": [
          1,
          2
        ],
        "PropertyAccountId": 1,
        "PreviewReziDocumentRef": "sample string 24",
        "Id": 25
      },
      "Id": 4
    },
    {
      "Address": "sample string 1",
      "ReceivedBy": "sample string 2",
      "TenantRoleId": 3,
      "UnprotectedDepositInvoice": {
        "RecipientAccountId": 1,
        "LiableAccountId": 2,
        "RecipientAccountName": "sample string 3",
        "RecipientGroupId": 4,
        "LiableAccountName": "sample string 5",
        "LiableAccountBalance": 6.0,
        "LiableGroupId": 7.0,
        "Status": "sample string 8",
        "DueDate": "2024-10-30T15:17:09.8479709Z",
        "CreatedDate": "2024-10-30T15:17:09.8479709Z",
        "RentPeriodEndDate": "2024-10-30T15:17:09.8479709Z",
        "InvoiceNumber": 11,
        "Description": "sample string 12",
        "InvoiceType": "sample string 13",
        "InvoiceSubType": "sample string 14",
        "TotalAmount": 15.0,
        "SubTotalAmount": 16.0,
        "TaxTotalAmount": 17.0,
        "DiscountTotalAmount": 18.0,
        "TotalOutstanding": 19.0,
        "TotalPaid": 20.0,
        "Notes": "sample string 21",
        "Payments": [
          {
            "PaymentNumber": "sample string 1",
            "Amount": 2.0,
            "Date": "2024-10-30T15:17:09.8479709Z",
            "Id": 4
          },
          {
            "PaymentNumber": "sample string 1",
            "Amount": 2.0,
            "Date": "2024-10-30T15:17:09.8479709Z",
            "Id": 4
          }
        ],
        "Allocations": [
          {
            "Date": "2024-10-30T15:17:09.8479709Z",
            "Amount": 2.0,
            "Description": "sample string 3",
            "AllocationItems": [
              {
                "Date": "2024-10-30T15:17:09.8479709Z",
                "Amount": 2.0,
                "InvoiceId": 3,
                "InvoiceItemId": 4,
                "InvoiceItemDescription": "sample string 5",
                "Protected": true,
                "ProtectedDate": "2024-10-30T15:17:09.8479709Z",
                "LandlordProtected": true,
                "Id": 9
              },
              {
                "Date": "2024-10-30T15:17:09.8479709Z",
                "Amount": 2.0,
                "InvoiceId": 3,
                "InvoiceItemId": 4,
                "InvoiceItemDescription": "sample string 5",
                "Protected": true,
                "ProtectedDate": "2024-10-30T15:17:09.8479709Z",
                "LandlordProtected": true,
                "Id": 9
              }
            ],
            "Id": 4
          },
          {
            "Date": "2024-10-30T15:17:09.8479709Z",
            "Amount": 2.0,
            "Description": "sample string 3",
            "AllocationItems": [
              {
                "Date": "2024-10-30T15:17:09.8479709Z",
                "Amount": 2.0,
                "InvoiceId": 3,
                "InvoiceItemId": 4,
                "InvoiceItemDescription": "sample string 5",
                "Protected": true,
                "ProtectedDate": "2024-10-30T15:17:09.8479709Z",
                "LandlordProtected": true,
                "Id": 9
              },
              {
                "Date": "2024-10-30T15:17:09.8479709Z",
                "Amount": 2.0,
                "InvoiceId": 3,
                "InvoiceItemId": 4,
                "InvoiceItemDescription": "sample string 5",
                "Protected": true,
                "ProtectedDate": "2024-10-30T15:17:09.8479709Z",
                "LandlordProtected": true,
                "Id": 9
              }
            ],
            "Id": 4
          }
        ],
        "InvoiceItems": [
          {
            "TaxAmount": 1.0,
            "SubTotalAmount": 2.0,
            "TotalOutstanding": 3.0,
            "Amount": 4.0,
            "Name": "sample string 5",
            "IsTaxable": true,
            "TaxitemId": 1,
            "Discount": 7.0,
            "DiscountName": "sample string 8",
            "DiscountDate": "2024-10-30T15:17:09.8479709Z",
            "Type": 0,
            "RelatedEntityId": 9,
            "CreditNoteItems": [
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "CreditNoteId": 3,
                "Reason": "sample string 4",
                "InvoiceNumber": 5,
                "InvoiceId": 6,
                "CreatedDate": "2024-10-30T15:17:09.8479709Z",
                "Id": 8
              },
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "CreditNoteId": 3,
                "Reason": "sample string 4",
                "InvoiceNumber": 5,
                "InvoiceId": 6,
                "CreatedDate": "2024-10-30T15:17:09.8479709Z",
                "Id": 8
              }
            ],
            "RefundItems": [
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "InvoiceId": 3,
                "RefundId": 4,
                "Id": 5
              },
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "InvoiceId": 3,
                "RefundId": 4,
                "Id": 5
              }
            ],
            "Id": 10
          },
          {
            "TaxAmount": 1.0,
            "SubTotalAmount": 2.0,
            "TotalOutstanding": 3.0,
            "Amount": 4.0,
            "Name": "sample string 5",
            "IsTaxable": true,
            "TaxitemId": 1,
            "Discount": 7.0,
            "DiscountName": "sample string 8",
            "DiscountDate": "2024-10-30T15:17:09.8479709Z",
            "Type": 0,
            "RelatedEntityId": 9,
            "CreditNoteItems": [
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "CreditNoteId": 3,
                "Reason": "sample string 4",
                "InvoiceNumber": 5,
                "InvoiceId": 6,
                "CreatedDate": "2024-10-30T15:17:09.8479709Z",
                "Id": 8
              },
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "CreditNoteId": 3,
                "Reason": "sample string 4",
                "InvoiceNumber": 5,
                "InvoiceId": 6,
                "CreatedDate": "2024-10-30T15:17:09.8479709Z",
                "Id": 8
              }
            ],
            "RefundItems": [
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "InvoiceId": 3,
                "RefundId": 4,
                "Id": 5
              },
              {
                "Amount": 1.0,
                "InvoiceItemId": 2,
                "InvoiceId": 3,
                "RefundId": 4,
                "Id": 5
              }
            ],
            "Id": 10
          }
        ],
        "LinkedFees": [
          {
            "LiableAccountId": 1,
            "RecipientAccountId": 2,
            "FeeId": 3,
            "ExternalReference": 4,
            "Id": 5
          },
          {
            "LiableAccountId": 1,
            "RecipientAccountId": 2,
            "FeeId": 3,
            "ExternalReference": 4,
            "Id": 5
          }
        ],
        "PropertyId": 1,
        "TenancyRoleId": 1,
        "Address": "sample string 22",
        "RelatedInvoiceId": 1,
        "CustomInvoiceNumber": "sample string 23",
        "DocumentIds": [
          1,
          2
        ],
        "PropertyAccountId": 1,
        "PreviewReziDocumentRef": "sample string 24",
        "Id": 25
      },
      "Id": 4
    }
  ]
}