@tillhub/schemas 6.459.0 → 6.460.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
module.exports.request = {
|
|
2
|
+
$id: 'https://schemas.tillhub.com/v0/analytics.reports.payment_options.get.all.query.schema.json',
|
|
3
|
+
$schema: 'http://json-schema.org/draft-07/schema#',
|
|
4
|
+
type: 'object',
|
|
5
|
+
additionalProperties: true,
|
|
6
|
+
required: [],
|
|
7
|
+
properties: {
|
|
8
|
+
cursor_field: {
|
|
9
|
+
type: 'string',
|
|
10
|
+
description: 'which column to cursor on. To indicate the sorting order, add a `+` or `-` for asc/desc order'
|
|
11
|
+
},
|
|
12
|
+
legacy: {
|
|
13
|
+
type: 'boolean',
|
|
14
|
+
desciption: 'flags to us legacy table fr_transaction_payment'
|
|
15
|
+
},
|
|
16
|
+
format: {
|
|
17
|
+
type: 'string',
|
|
18
|
+
description: 'to get data in any other format then JSON straight away, you can set `format=csv`'
|
|
19
|
+
},
|
|
20
|
+
context_locations: {
|
|
21
|
+
type: 'string',
|
|
22
|
+
description: 'context locations id as a filter for transactions'
|
|
23
|
+
},
|
|
24
|
+
branch_number: {
|
|
25
|
+
oneOf: [
|
|
26
|
+
{
|
|
27
|
+
type: 'integer',
|
|
28
|
+
description: 'Filter by branch number if legacy parameter set or filter by branch UUID otherwise'
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
type: 'string',
|
|
32
|
+
format: 'uuid',
|
|
33
|
+
example: '9d110eb2-2245-4e14-9574-49b502f3a9b3'
|
|
34
|
+
}
|
|
35
|
+
]
|
|
36
|
+
},
|
|
37
|
+
branch_group: {
|
|
38
|
+
oneOf: [
|
|
39
|
+
{
|
|
40
|
+
type: 'string',
|
|
41
|
+
description: 'filter by branches within branch group. Not applied if branch_number parameter received'
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
type: 'array',
|
|
45
|
+
items: {
|
|
46
|
+
type: 'string'
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
]
|
|
50
|
+
},
|
|
51
|
+
staff_id: {
|
|
52
|
+
type: 'string',
|
|
53
|
+
format: 'uuid',
|
|
54
|
+
description: 'filter by staff id',
|
|
55
|
+
example: '9d110eb2-2245-4e14-9574-49b502f3a9b3'
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
}
|