Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Operation

Information of the operation

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.billing

Style
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
}
Div
style background-color: green; color: white; display: inline-block; padding: 5px; border-radius: 3px;

GET

Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/deposit

Request

PropertyTypeRequiredType parameterDefault valueDescriptionchainIdIntegertruepath parameterUnique identificator of the chain.propertyIdIntegertruepath parameterUnique identificator of the property.depositStatusTypeIdIntegerfalserequest parameterUnique identificator of the DepositStatusType.

Operation

Information of the operation

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.billing


Style
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
}



Div
style background-color: green; color: white; display: inline-block; padding: 5px; border-radius: 3px;

GET



Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/deposit



Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
depositStatusTypeIdIntegerfalserequest parameter
Unique identificator of the DepositStatusType.
createdDateFromdateTimefalserequest parameter
Date of creation of the deposit (not paid yet)
createdDateTodateTimefalserequest parameter
Date of creation of the deposit (not paid yet)
consumedDateFromdateTimefalserequest parameter
Date of consumption of the deposit
consumedDateTodateTimefalserequest parameter
Date of consumption of the deposit
paidDateFromdateTimefalserequest parameter
Date of payment of the deposit
paidDateTodateTimefalserequest parameter
Date of payment of the deposit
refundDateFromdateTimefalserequest parameter
Date of refund of the deposit
refundDateTodateTimefalserequest parameter
Date of refund of the deposit
cancellationDateFromdateTimefalserequest parameter
Date of cancellation of the deposit (not paid)
cancelationDateTodateTimefalserequest parameter
Date of refund of the deposit(not paid)
offsetIntegerfalserequest parameter0Offset of the array of results.
limitIntegerfalserequest parameter10Limit of results.
sortStringfalserequest parameteridProperty of the entity to sort by.
sortModeStringfalserequest parameterAscMode of sorting.


Example request

Code Block
languagepowershell
themeDJango
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/deposit



Response

PropertyTypeRequiredDescription
PagePagetrue
Entity


Insert excerpt
Deposit
Deposit
nopaneltrue

Example response

Code Block
themeDJango
{
	"count": 7,
	"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": 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",
				"profileType": {
	 				"code": "1",
   	 				"name": "Customer",
     				"nameI18n": "Customer",
     				"colorCode": "#00ACC1"
   				}
			},
			"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",
				"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,
			"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",
				"profileType": {
	 				"code": "1",
   	 				"name": "Customer",
     				"nameI18n": "Customer",
     				"colorCode": "#00ACC1"
   				}
			},
			"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",
				"profileType": {
	 				"code": "3",
   	 				"name": "TravelAgent",
     				"nameI18n": "Travel agent",
     				"colorCode": "#00ACC1"
   				}
			},
			"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",
				"profileType": {
	 				"code": "1",
   	 				"name": "Customer",
     				"nameI18n": "Customer",
     				"colorCode": "#00ACC1"
   				}
			},
			"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",
				"profileType": {
	 				"code": "3",
   	 				"name": "TravelAgent",
     				"nameI18n": "Travel agent",
     				"colorCode": "#00ACC1"
   				}
			},
			"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"
			}
		}
	]
}