Operation
Information of the operation
GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/deposit
Request
| Property | Type | Required | Default value | Description |
|---|---|---|---|---|
| chainId | Integer | true | Unique identificator of the chain. | |
| propertyId | Integer | true | Unique identificator of the property. | |
| depositStatusTypeId | Integer | false | Unique identificator of the DepositStatusType. | |
| offset | Integer | false | 0 | Offset of the array of results. |
| limit | Integer | false | 10 | Limit of results. |
| sort | String | false | id | Property of the entity to sort by. |
| sortMode | String | false | Asc | Mode of sorting. |
Example request
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/deposit
Response
| Property | Type | Required | Description |
|---|---|---|---|
| Page | Page | true |
| Field | Type | Required | Description |
|---|---|---|---|
| id | Integer | true | Unique identifier for the Deposit. |
| name | String | true | Name of the Deposit. |
| company | Company | false | Company associated to this Deposit |
| customer | Customer | false | Customer associated to this Deposit |
| travelAgent | TravelAgent | false | TravelAgent associated to this Deposit |
| product | Product | true | Product associated to this Deposit |
| consumptionDate | LocalDate | true | Date when the Deposit was created |
| price | BigDecimal | true | Amount of this Deposit |
| spent | BigDecimal | true | |
| refund | BigDecimal | true | |
| remaining | BigDecimal | true | |
| currency | Currency | true | Currency associated to this Deposit |
| depositStatusType | DepositStatusType | true | StatusType of this Deposit |
| reservationRoomStaySummary | ReservationRoomStaySummary | false | |
| reservationSummary | ReservationSummary | false | |
| reservationGroup | ReservationGroup | false |
Example response
{
"count": 7,
"offset": 0,
"limit": 10,
"list": [{
"id": 2,
"name": "dcb58",
"company": null,
"customer": {
"id": 8,
"name": "Antonio Bérengère Chapman"
},
"travelAgent": null,
"productModel": {
"id": 519,
"code":"DEP0",
"name": "Deposit 10"
},
"consumptionDate": "2019-02-07",
"price": 311,
"spent": 0,
"remaining": 0,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"depositStatusTypeModel": {
"id": 1,
"name": "Pending Payment",
"code": "PENPAY"
}
},
{
"id": 3,
"name": "da908",
"company": null,
"customer": {
"id": 8,
"name": "Antonio Bérengère Chapman"
},
"travelAgent": null,
"productModel": {
"id": 519,
"code":"DEP10",
"name": "Deposit 10"
},
"consumptionDate": "2019-02-01",
"price": 405,
"spent": 0,
"remaining": 405,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"depositStatusTypeModel": {
"id": 1,
"name": "Pending To Apply",
"code": "PENAPL"
}
},
{
"id": 4,
"name": "0f4ed",
"company": null,
"customer": {
"id": 10,
"name": "Juan Athéna Ward"
},
"travelAgent": null,
"productModel": {
"id": 530,
"code":"DEP21",
"name": "Deposit 21"
},
"consumptionDate": "2019-02-09",
"price": 179,
"spent": 0,
"remaining": 0,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"depositStatusTypeModel": {
"id": 1,
"name": "Pending Payment",
"code": "PENPAY"
}
},
{
"id": 5,
"name": "a63c4",
"company": null,
"customer": {
"id": 4,
"name": "Irene Maïté Duncan"
},
"travelAgent": null,
"productModel": {
"id": 530,
"code":"DEP21",
"name": "Deposit 21"
},
"consumptionDate": "2019-02-07",
"price": 254,
"spent": 0,
"remaining": 254,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"depositStatusTypeModel": {
"id": 1,
"name": "Pending To Apply",
"code": "PENAPL"
}
},
{
"id": 6,
"name": "80153",
"company": null,
"customer": null,
"travelAgent": {
"id": 132,
"name": "Jamia"
},
"productModel": {
"id": 530,
"code":"DEP21",
"name": "Deposit 21"
},
"consumptionDate": "2019-02-12",
"price": 343,
"spent": 0,
"remaining": 343,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"depositStatusTypeModel": {
"id": 1,
"name": "Pending To Apply",
"code": "PENAPL"
}
},
{
"id": 7,
"name": "e361d",
"company": null,
"customer": {
"id": 2,
"name": "Carolyn Göran Freeman"
},
"travelAgent": null,
"productModel": {
"id": 519,
"code":"DEP10",
"name": "Deposit 10"
},
"consumptionDate": "2019-02-07",
"price": 87,
"spent": 0,
"remaining": 87,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"depositStatusTypeModel": {
"id": 1,
"name": "Pending To Apply",
"code": "PENAPL"
}
},
{
"id": 8,
"name": "b784a",
"company": null,
"customer": null,
"travelAgent": {
"id": 121,
"name": "Zoomcast"
},
"productModel": {
"id": 530,
"code":"DEP21",
"name": "Deposit 21"
},
"consumptionDate": "2019-02-10",
"price": 134,
"spent": 0,
"remaining": 134,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"depositStatusTypeModel": {
"id": 1,
"name": "Pending To Apply",
"code": "PENAPL"
}
}
]
}