POST api/deposit/collections

Get deposit collections

Request Information

URI Parameters

None.

Body Parameters

Collection of integer

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

[
  1,
  2
]

Response Information

Resource Description

Collection of DepositCollectionDataContract

Name	Type	Additional information
Id	integer	None.
TenantRoleId	integer	None.
DepositSchemeId	integer	None.
CreatedDate	date	None.
Allocations	Collection of InvoiceAllocationDataContract	None.
Status	string	None.
Notes	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "TenantRoleId": 2,
    "DepositSchemeId": 3,
    "CreatedDate": "2025-07-02T03:59:49.3679525Z",
    "Allocations": [
      {
        "Date": "2025-07-02T03:59:49.3679525Z",
        "Amount": 2.0,
        "InvoiceId": 3,
        "InvoiceItemId": 4,
        "InvoiceItemDescription": "sample string 5",
        "Protected": true,
        "ProtectedDate": "2025-07-02T03:59:49.3679525Z",
        "LandlordProtected": true,
        "Id": 9
      },
      {
        "Date": "2025-07-02T03:59:49.3679525Z",
        "Amount": 2.0,
        "InvoiceId": 3,
        "InvoiceItemId": 4,
        "InvoiceItemDescription": "sample string 5",
        "Protected": true,
        "ProtectedDate": "2025-07-02T03:59:49.3679525Z",
        "LandlordProtected": true,
        "Id": 9
      }
    ],
    "Status": "sample string 5",
    "Notes": "sample string 6"
  },
  {
    "Id": 1,
    "TenantRoleId": 2,
    "DepositSchemeId": 3,
    "CreatedDate": "2025-07-02T03:59:49.3679525Z",
    "Allocations": [
      {
        "Date": "2025-07-02T03:59:49.3679525Z",
        "Amount": 2.0,
        "InvoiceId": 3,
        "InvoiceItemId": 4,
        "InvoiceItemDescription": "sample string 5",
        "Protected": true,
        "ProtectedDate": "2025-07-02T03:59:49.3679525Z",
        "LandlordProtected": true,
        "Id": 9
      },
      {
        "Date": "2025-07-02T03:59:49.3679525Z",
        "Amount": 2.0,
        "InvoiceId": 3,
        "InvoiceItemId": 4,
        "InvoiceItemDescription": "sample string 5",
        "Protected": true,
        "ProtectedDate": "2025-07-02T03:59:49.3679525Z",
        "LandlordProtected": true,
        "Id": 9
      }
    ],
    "Status": "sample string 5",
    "Notes": "sample string 6"
  }
]