POST api/deposit/collections

Get deposit collections Processes this deposit API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The tenant role ids value supplied with the request.

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

The response returned after the operation completes.

Collection of DepositCollectionDataContract

Name	Description	Type	Additional information
Id	The unique identifier of this resource.	integer	None.
TenantRoleId	The unique identifier of the related tenant role resource.	integer	None.
DepositSchemeId	The unique identifier of the related deposit scheme resource.	integer	None.
CreatedDate	The created date, expressed as a date and time.	date	None.
Allocations	The collection of allocations.	Collection of InvoiceAllocationDataContract	None.
Status	The status value.	string	None.
Notes	The notes value.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "TenantRoleId": 2,
    "DepositSchemeId": 3,
    "CreatedDate": "2026-07-23T08:17:22.556025Z",
    "Allocations": [
      {
        "Date": "2026-07-23T08:17:22.556025Z",
        "Amount": 2.0,
        "InvoiceId": 3,
        "InvoiceItemId": 4,
        "InvoiceItemDescription": "sample string 5",
        "Protected": true,
        "ProtectedDate": "2026-07-23T08:17:22.556025Z",
        "LandlordProtected": true,
        "Id": 9
      },
      {
        "Date": "2026-07-23T08:17:22.556025Z",
        "Amount": 2.0,
        "InvoiceId": 3,
        "InvoiceItemId": 4,
        "InvoiceItemDescription": "sample string 5",
        "Protected": true,
        "ProtectedDate": "2026-07-23T08:17:22.556025Z",
        "LandlordProtected": true,
        "Id": 9
      }
    ],
    "Status": "sample string 5",
    "Notes": "sample string 6"
  },
  {
    "Id": 1,
    "TenantRoleId": 2,
    "DepositSchemeId": 3,
    "CreatedDate": "2026-07-23T08:17:22.556025Z",
    "Allocations": [
      {
        "Date": "2026-07-23T08:17:22.556025Z",
        "Amount": 2.0,
        "InvoiceId": 3,
        "InvoiceItemId": 4,
        "InvoiceItemDescription": "sample string 5",
        "Protected": true,
        "ProtectedDate": "2026-07-23T08:17:22.556025Z",
        "LandlordProtected": true,
        "Id": 9
      },
      {
        "Date": "2026-07-23T08:17:22.556025Z",
        "Amount": 2.0,
        "InvoiceId": 3,
        "InvoiceItemId": 4,
        "InvoiceItemDescription": "sample string 5",
        "Protected": true,
        "ProtectedDate": "2026-07-23T08:17:22.556025Z",
        "LandlordProtected": true,
        "Id": 9
      }
    ],
    "Status": "sample string 5",
    "Notes": "sample string 6"
  }
]