rv_create_pos_extras

rv_create_pos_extras

Description

Creates extras for a given transaction.

Version

Available from version 5.20.0.

Access

Writes new data, master access not required, available to internal users only.

Parameters

Number	Name	O/R	Version	Usage
1	Auth	Required	5.20.0+	Authentication structure.*
2	Till id or code	Required		Identify the till making the transaction. May use the till id or till code/revenue centre. Rejected if no entries or multiple entries match.
3	Reservation	Required		Reservation to bill. Used for validation against the group.
4	Room	Required		Room to bill. Used for validation against the group.
5	Group	Required		The room group to bill
6	Guest	Required		The guest to bill. May be a valid guest or empty, ‘0’ or ‘cash’ to bill to a cash folio.
7	Reference	Optional		Reference number from the third-party POS system. [Applied to all items]
8	Note	Optional		Free format, multi-line text field for general notes about the transaction. [Applied to all items]
9	Memo	Optional		Free format, multi-line text field for internal memos about the transaction. [Applied to all items]
10	Property	Optional		Bill to a different property. If this is empty the reservation property is used. This is not (necessarily) the billing unit. The billing unit will be looked up based on the chosen property.
11	Items	Required		List of items in transaction. An array or structure may be used.

11. Item array structures:

Number	Name	O/R	Version	Usage
1	Amount	Required	5.20.0+	The amount for the item inclusive of taxes and in the currency of the chosen extra. This will be multiplied by the quantity to give the final total. If using a structure the key is ‘amount’.
2	Quantity	Optional		The quantity of items purchased. Must be a positive integer. If empty a quantity of 1 is assumed. If using a structure the key is ‘quantity’.
3	Id	Optional		If a valid mapping/category code is specified then the extra for this mapping will be used, otherwise the default extra for the till will be used. Must resolve to a general extra – activities, travel and accommodation are not allowed. If using a structure the key is ‘id’.
4	Reference	Optional		Override the reference field for this item. May be left empty then the general reference will be used. If using a structure the key is ‘reference’.
5	Note	Optional		Override the note field for this item. May be left empty then the general note will be used. If using a structure the key is ‘note’.
6	Memo	Optional		Override the memo field for this item. May be left empty then the general memo will be used. If using a structure the key is ‘memo’.

*See call structure explanation.

Response

If successful, a list of extra ids (rv_extra.rv_extra_ix) will be returned.

Example

Request

{
    "method": "rv_get_room",
    "params": [
    	{
    		"{{username}}",
    		"{{password}}",
    		"{{principal}}",
    		"{{environment}}"
    	},
        "WB2"
    ],
    "id": null
}

Response

{
   "id": null,
   "error": null,
   "result": [
       "11e9ef1f50686f7090b1029cd253c1d1"
   ]
}

rv_create_pos_extras

Description

Version

Access

Parameters

Response

Example

Keep up to date with us

Menu

Visit our website

ResRequest Modules