ac_get_pos

ac_get_pos

Description

Returns a list of POS till structures containing “id”, “code”, “name”, “environment” and any available mappings (categories).

Version

Available from version 5.30.0.

Access

Read-only, 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	Name	Optional	5.20.0+	Search by till name. May use * or % as wildcard characters.
3	Environment	Optional	5.20.0+	Search by environment code (eg. WB). May use * or % as wildcard characters.

Response

An array of structures containing the following fields

Name	Type	Description
id	String	Primary key for the POS till entry
code	String	Mapping code / revenue centre
name	String	Till name within Enterprise
environment	String	Environment code of the POS till
mappings	Array	Mappings (categories) available for this POS till
code	String	Code to use the mapping
extra_id	String	Id of the extra linked to the mapping
extra_name	String	Name of the extra linked to the mapping

*See call structure explanation.

Example

Request

{
	"method": "ac_get_pos",
	"params": [
		"{{username}}",
		"{{password}}",
		"{{principal}}",
		"{{name}}",
		"{{environment}}"
	],
	"id": null
}

Response

{
   "id": null,
   "error": null,
   "result": [
       {
           "id": "11e9cfe93fc9929695d3029cd253c1d1",
           "code": "REV-01",
           "name": "Central till",
           "environment": "WB",
           "mappings": [
               {
                   "code": "01",
                   "extra_id": "11e9882a8a9efd31b349ac1f6b1c0882",
                   "extra_name": "Bar purchase"
               },
               {
                   "code": "02",
                   "extra_id": "WB31",
                   "extra_name": "Curio shop purchase"
               }
           ]
       },
       {
           "id": "11e9cfe9531144c695d3029cd253c1d1",
           "code": "REV-99",
           "name": "Back office till",
           "environment": "WB",
           "mappings": []
       }
   ]
}

ac_get_pos

Description

Version

Access

Parameters

Response

Example

Keep up to date with us

Menu

Visit our website

ResRequest Modules