Operation
Information of the operation
| Rw ui textbox macro | ||
|---|---|---|
| ||
Only accessible with permission of pms.integration.billing |
| Style |
|---|
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
} |
| Div | ||
|---|---|---|
| ||
GET |
| Div | ||
|---|---|---|
| ||
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/deposit |
Request
| Property | Type | Required | Type parameter | Default value | Description |
|---|---|---|---|---|---|
| chainId | Integer | true | path parameter | Unique identificator of the chain. | |
| propertyId | Integer | true | path parameter | Unique identificator of the property. | |
| reservationId | Integer | false | request parameter | Unique identificator of reservation | |
| reservationRoomStayId | Integer | false | request parameter | Unique identificator of reservationRoomStay | |
| reservationGroupId | Integer | false | request parameter | Unique identificator of reservationGroup | |
| depositStatusTypeId | Integer | false | request parameter | Unique identificator of the DepositStatusType. | |
| createdDateFrom | dateTimeLocalDate | false | request parameter | Date of creation of the deposit (not paid yet) | |
| createdDateTo | dateTimeLocalDate | false | request parameter | Date of creation of the deposit (not paid yet) | |
| consumedDateFrom | dateTimeLocalDate | false | request parameter | Date of consumption of the deposit | |
| consumedDateTo | dateTimeLocalDate | false | request parameter | Date of consumption of the deposit | |
| paidDateFrom | dateTimeLocalDate | false | request parameter | Date of payment of the deposit | |
| paidDateTo | dateTimeLocalDate | false | request parameter | Date of payment of the deposit | |
| refundDateFrom | dateTimeLocalDate | false | request parameter | Date of refund of the deposit | |
| refundDateTo | dateTimeLocalDate | false | request parameter | Date of refund of the deposit | |
| cancellationDateFrom | dateTimeLocalDate | false | request parameter | Date of cancellation of the deposit (not paid) | |
| cancelationDateTo | dateTimeLocalDate | false | request parameter | Date of refund of the deposit(not paid) | |
| offset | Integer | false | request parameter | 0 | Offset of the array of results. |
| limit | Integer | false | request parameter | 10 | Limit of results. |
| sort | String | false | request parameter | id | Property of the entity to sort by. |
| sortMode | String | false | request parameter | Asc | Mode of sorting. |
Example request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/deposit |
Response
| Property | Type | Required | Description |
|---|---|---|---|
| Page | Page | true |
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Example response
| Code Block | ||
|---|---|---|
| ||
{
"count": 3,
"offset": 0,
"limit": 10,
"list": [{
"id": 2,
"name": "dcb58",
"company": null,
"customer": {
"id": 8,
"name": "Antonio Bérengère Chapman",
"profileType": {
"code": "1",
"name": "Customer",
"nameI18n": "Customer",
"colorCode": "#00ACC1"
}
},
"travelAgent": null,
"productModel": {
"id": 589,
"chainProductId": 129,
"code": "DEPR",
"name": "Depósito Recibo",
"productType": {
"id": 4,
"code": "DEP",
"name": "Deposit"
}
},
"consumptionDate": "2019-02-07",
"price": 311,
"spent": 0,
"refund": 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",
"profileType": {
"code": "1",
"name": "Customer",
"nameI18n": "Customer",
"colorCode": "#00ACC1"
}
},
"travelAgent": null,
"productModel": {
"id": 588,
"chainProductId": 128,
"code": "DEP1",
"name": "Depósito 10%",
"productType": {
"id": 4,
"code": "DEP",
"name": "Deposit"
}
},
"consumptionDate": "2019-02-01",
"price": 405,
"spent": 0,
"refund":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",
"profileType": {
"code": "1",
"name": "Customer",
"nameI18n": "Customer",
"colorCode": "#00ACC1"
}
},
"travelAgent": null,
"productModel": {
"id": 530,
"code":"DEP21",
"name": "Deposit 21"
},
"consumptionDate": "2019-02-09",
"price": 179,
"spent": 0,
"refund": 0,
"remaining": 0,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"depositStatusTypeModel": {
"id": 1,
"name": "Pending Payment",
"code": "PENPAY"
}
}
]
} |