DepositsGetResultResponse

Response wrapping a paginated list of deposits

data object[]required

List of deposits

Array [

organizationCodestringrequired

Organization code

Default value:

Example: ORG123

codestringrequired

Deposit code

Default value:

Example: DEP456

naturestringrequired

Nature of the deposit

Default value:

Example: BANKING

contractCodestringrequired

Code of the contract this deposit belongs to

Default value:

Example: CONT456

initialAmountdoublerequired

Initial deposit amount

Default value:

Example: 1200

updatedAmountdoublenullable

Updated deposit amount

Default value:

Example: 1250

numberOfMonthsOfRentint32nullable

Number of months of rent the deposit represents

Default value:

Example: 3

integrationDatedate-timerequired

Date when the deposit was integrated into the system

Default value:

]

paginate objectrequired

Pagination information. The cursor field is null when iteration has reached the end.

sizeint32

Number of results

Possible values: <= 2000

Default value: 50

cursorstring | nullnullable

A marker indicating the position in a dataset, used to determine where to continue fetching results in paginated data

Default value: 0

DepositsGetResultResponse

{
  "data": [
    {
      "organizationCode": "ORG123",
      "code": "DEP456",
      "nature": "BANKING",
      "contractCode": "CONT456",
      "initialAmount": 1200,
      "updatedAmount": 1250,
      "numberOfMonthsOfRent": 3,
      "integrationDate": ""
    }
  ],
  "paginate": {
    "size": 50,
    "cursor": "0"
  }
}