{"_id":"5de85dbbb0b885003ddf3352","project":"56e3719a591f620e00bf5095","user":"56e371538b32a10e00f79750","githubsync":"","version":{"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"Domain","version_clean":"1.5.0","version":"1.5"},"__v":4,"category":{"_id":"5de85dbbb0b885003ddf3334","pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"project":"56e3719a591f620e00bf5095","__v":19,"version":"5de85dbbb0b885003ddf339f","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"editedParams":true,"editedParams2":true,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-25T00:59:42.079Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"id\": 23,\n  \"name\" : \"Driver\",\n  \"amount\" : 50,\n  \"isOptional\" : true,\n  \"amountType\" : \"AMOUNT\",\n  \"scope\" : \"PER_STAY\"\n}","language":"json","status":200},{"name":"","code":"Orbirental API - Bad request.","language":"text","status":400},{"code":"Orbirental API - Property not found.","language":"text","status":409}]},"settings":"","examples":{"codes":[]},"method":"post","auth":"required","params":[{"_id":"56f48d7e6bd7a20e00d22b37","ref":"","in":"body","required":true,"desc":"Unique id of the property","default":"","type":"string","name":"propertyUid"},{"_id":"56f48d7e6bd7a20e00d22b36","ref":"","in":"body","required":true,"desc":"Name of the custom fee","default":"","type":"string","name":"name"},{"_id":"56f48d7e6bd7a20e00d22b35","ref":"","in":"body","required":false,"desc":"Amount of the custom fee","default":"0.0","type":"double","name":"amount"},{"_id":"56f48d7e6bd7a20e00d22b34","ref":"","in":"body","required":false,"desc":"","default":"true","type":"boolean","name":"isOptional"},{"_id":"5cbef624c3b28a0045954443","ref":"","in":"body","required":false,"desc":"Amount type (TAX or AMOUNT). Use TAX if you essentially want to define a percentage, even if this is not a tax per say.","default":"AMOUNT","type":"string","name":"amountType"},{"_id":"5cd20dcc038f5f001423b196","ref":"","in":"body","required":false,"desc":"The type of scope for this fee. Can be; PER_STAY, PER_NIGHT, PER_GUEST, PER_GUEST_PER_NIGHT","default":"PER_STAY","type":"string","name":"scope"}],"url":"/customfees/"},"isReference":false,"order":19,"body":"","excerpt":"Create a custom fee","slug":"customfees-1","type":"endpoint","title":"/customfees/"}

post/customfees/

Create a custom fee

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

propertyUid:
required
string
Unique id of the property
name:
required
string
Name of the custom fee
amount:
double0.0
Amount of the custom fee
isOptional:
booleantrue
amountType:
stringAMOUNT
Amount type (TAX or AMOUNT). Use TAX if you essentially want to define a percentage, even if this is not a tax per say.
scope:
stringPER_STAY
The type of scope for this fee. Can be; PER_STAY, PER_NIGHT, PER_GUEST, PER_GUEST_PER_NIGHT

Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}