POST api/deposit/collections

Get deposit collections

Request Information

URI Parameters

None.

Body Parameters

Collection of integer

Request Formats

application/json, text/json

Sample:
[
  1,
  2
]

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of DepositCollectionDataContract
NameDescriptionTypeAdditional information
Id

integer

None.

TenantRoleId

integer

None.

DepositSchemeId

integer

None.

CreatedDate

date

None.

Allocations

Collection of InvoiceAllocationDataContract

None.

Status

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "TenantRoleId": 2,
    "DepositSchemeId": 3,
    "CreatedDate": "2020-11-25T03:10:39.123544Z",
    "Allocations": [
      {
        "Date": "2020-11-25T03:10:39.123544Z",
        "Amount": 2.0,
        "InvoiceId": 3,
        "InvoiceDescription": "sample string 4",
        "Protected": true,
        "ProtectedDate": "2020-11-25T03:10:39.123544Z",
        "LandlordProtected": true,
        "Id": 8
      },
      {
        "Date": "2020-11-25T03:10:39.123544Z",
        "Amount": 2.0,
        "InvoiceId": 3,
        "InvoiceDescription": "sample string 4",
        "Protected": true,
        "ProtectedDate": "2020-11-25T03:10:39.123544Z",
        "LandlordProtected": true,
        "Id": 8
      }
    ],
    "Status": "sample string 5"
  },
  {
    "Id": 1,
    "TenantRoleId": 2,
    "DepositSchemeId": 3,
    "CreatedDate": "2020-11-25T03:10:39.123544Z",
    "Allocations": [
      {
        "Date": "2020-11-25T03:10:39.123544Z",
        "Amount": 2.0,
        "InvoiceId": 3,
        "InvoiceDescription": "sample string 4",
        "Protected": true,
        "ProtectedDate": "2020-11-25T03:10:39.123544Z",
        "LandlordProtected": true,
        "Id": 8
      },
      {
        "Date": "2020-11-25T03:10:39.123544Z",
        "Amount": 2.0,
        "InvoiceId": 3,
        "InvoiceDescription": "sample string 4",
        "Protected": true,
        "ProtectedDate": "2020-11-25T03:10:39.123544Z",
        "LandlordProtected": true,
        "Id": 8
      }
    ],
    "Status": "sample string 5"
  }
]