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

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 }}