@tillhub/schemas 6.419.0 → 6.421.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.
- package/CHANGELOG.md +14 -0
- package/lib/v0/analytics/reports/index.js +3 -1
- package/lib/v0/analytics/reports/payments/export.js +79 -0
- package/lib/v0/analytics/reports/payments/index.js +3 -0
- package/lib/v0/analytics/reports/vat/export.js +46 -0
- package/lib/v0/analytics/reports/vat/index.js +3 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,17 @@
|
|
|
1
|
+
# [6.421.0](https://github.com/tillhub/schemas/compare/v6.420.0...v6.421.0) (2026-02-11)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Features
|
|
5
|
+
|
|
6
|
+
* **UNTIL-18709:** add VAT export module and schema ([#1110](https://github.com/tillhub/schemas/issues/1110)) ([f49942a](https://github.com/tillhub/schemas/commit/f49942a))
|
|
7
|
+
|
|
8
|
+
# [6.420.0](https://github.com/tillhub/schemas/compare/v6.419.0...v6.420.0) (2026-02-10)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Features
|
|
12
|
+
|
|
13
|
+
* **UNTIL-18708:** add payments report module ([#1109](https://github.com/tillhub/schemas/issues/1109)) ([30ab360](https://github.com/tillhub/schemas/commit/30ab360))
|
|
14
|
+
|
|
1
15
|
# [6.419.0](https://github.com/tillhub/schemas/compare/v6.418.1...v6.419.0) (2026-02-09)
|
|
2
16
|
|
|
3
17
|
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
module.exports.request = {
|
|
2
|
+
$id: 'https://schemas.tillhub.com/v0/analytics.reports.payments.export.request.schema.json',
|
|
3
|
+
$schema: 'http://json-schema.org/draft-07/schema#',
|
|
4
|
+
type: 'object',
|
|
5
|
+
// Keep this permissive: Tillhub API report queries include many filters.
|
|
6
|
+
// Validation here is focused on export-pipeline metadata.
|
|
7
|
+
additionalProperties: true,
|
|
8
|
+
required: ['format', 'documentType', 'email'],
|
|
9
|
+
properties: {
|
|
10
|
+
// timeframe
|
|
11
|
+
start: {
|
|
12
|
+
oneOf: [
|
|
13
|
+
{ type: 'string', format: 'date' },
|
|
14
|
+
{ type: 'string', format: 'date-time' }
|
|
15
|
+
]
|
|
16
|
+
},
|
|
17
|
+
end: {
|
|
18
|
+
oneOf: [
|
|
19
|
+
{ type: 'string', format: 'date' },
|
|
20
|
+
{ type: 'string', format: 'date-time' }
|
|
21
|
+
]
|
|
22
|
+
},
|
|
23
|
+
|
|
24
|
+
// report/query filters (optional but validated when present)
|
|
25
|
+
limit: { type: 'string', maxLength: 10 },
|
|
26
|
+
offset: { type: 'string', maxLength: 10 },
|
|
27
|
+
page: { type: 'string', maxLength: 10 },
|
|
28
|
+
size: { type: 'string', maxLength: 10 },
|
|
29
|
+
pageSize: { type: 'string', maxLength: 10 },
|
|
30
|
+
cursor: { type: 'string' },
|
|
31
|
+
cursor_field: { type: 'string' },
|
|
32
|
+
legacy: { enum: ['true', 'false', true, false] },
|
|
33
|
+
context_locations: { type: 'string', minLength: 1, maxLength: 64 },
|
|
34
|
+
|
|
35
|
+
payment_option: { type: 'string' },
|
|
36
|
+
payment_type: { type: 'string' },
|
|
37
|
+
customer_number: { type: 'string' },
|
|
38
|
+
cashier_number: { type: 'string' },
|
|
39
|
+
transaction_number: { type: 'string' },
|
|
40
|
+
balance_number: { type: 'string' },
|
|
41
|
+
branch_number: { type: 'string' },
|
|
42
|
+
branch_group: {
|
|
43
|
+
oneOf: [
|
|
44
|
+
{ type: 'string', minLength: 1, maxLength: 64 },
|
|
45
|
+
{ type: 'array', items: { type: 'string', minLength: 1, maxLength: 64 } }
|
|
46
|
+
]
|
|
47
|
+
},
|
|
48
|
+
register_number: { type: 'string' },
|
|
49
|
+
q: { type: 'string' },
|
|
50
|
+
change: {
|
|
51
|
+
type: 'object',
|
|
52
|
+
properties: {
|
|
53
|
+
from: { type: 'string' },
|
|
54
|
+
to: { type: 'string' }
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
amount: {
|
|
58
|
+
type: 'object',
|
|
59
|
+
properties: {
|
|
60
|
+
from: { type: 'string' },
|
|
61
|
+
to: { type: 'string' }
|
|
62
|
+
}
|
|
63
|
+
},
|
|
64
|
+
|
|
65
|
+
// export pipeline metadata
|
|
66
|
+
format: { type: 'string', enum: ['csv', 'xls'] },
|
|
67
|
+
delimiter: { type: 'string', enum: ['comma', 'semicolon'] },
|
|
68
|
+
enclosure: { type: 'string', enum: ['single', 'double'] },
|
|
69
|
+
show_column_name: { type: 'string', enum: ['true', 'false'] },
|
|
70
|
+
column_selection: { type: 'array', items: { type: 'string' } },
|
|
71
|
+
|
|
72
|
+
documentType: { type: 'string', enum: ['PaymentsExport'] },
|
|
73
|
+
email: { type: 'string', minLength: 5 },
|
|
74
|
+
lang: { type: 'string' },
|
|
75
|
+
scheduled_id: { type: 'string', minLength: 1, maxLength: 64 },
|
|
76
|
+
existingId: { type: 'string', format: 'uuid' },
|
|
77
|
+
correlationId: { type: 'string', format: 'uuid' }
|
|
78
|
+
}
|
|
79
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
module.exports.request = {
|
|
2
|
+
$id: 'https://schemas.tillhub.com/v0/analytics.reports.vat.export.request.schema.json',
|
|
3
|
+
$schema: 'http://json-schema.org/draft-07/schema#',
|
|
4
|
+
type: 'object',
|
|
5
|
+
// Keep this permissive: Tillhub API report queries include many filters.
|
|
6
|
+
// Validation here is focused on export-pipeline metadata.
|
|
7
|
+
additionalProperties: true,
|
|
8
|
+
required: ['format', 'documentType', 'email'],
|
|
9
|
+
properties: {
|
|
10
|
+
// timeframe
|
|
11
|
+
start: { type: 'string', format: 'date-time' },
|
|
12
|
+
end: { type: 'string', format: 'date-time' },
|
|
13
|
+
|
|
14
|
+
// report/query filters (optional but validated when present)
|
|
15
|
+
legacy: { enum: ['true', 'false', true, false] },
|
|
16
|
+
context_locations: { type: 'string', minLength: 1, maxLength: 64 },
|
|
17
|
+
branch_custom_id: { type: 'string' },
|
|
18
|
+
branch_group: {
|
|
19
|
+
anyOf: [
|
|
20
|
+
{ type: 'string', minLength: 1, maxLength: 64 },
|
|
21
|
+
{ type: 'array', items: { type: 'string', minLength: 1, maxLength: 64 } }
|
|
22
|
+
]
|
|
23
|
+
},
|
|
24
|
+
timezone: { type: 'string' },
|
|
25
|
+
filename_prefix: { type: 'string' },
|
|
26
|
+
limit: { type: 'string', maxLength: 10 },
|
|
27
|
+
offset: { type: 'string', maxLength: 10 },
|
|
28
|
+
page: { type: 'string', maxLength: 10 },
|
|
29
|
+
size: { type: 'string', maxLength: 10 },
|
|
30
|
+
pageSize: { type: 'string', maxLength: 10 },
|
|
31
|
+
|
|
32
|
+
// export pipeline metadata
|
|
33
|
+
format: { type: 'string', enum: ['csv', 'xls'] },
|
|
34
|
+
delimiter: { type: 'string', enum: ['comma', 'semicolon'] },
|
|
35
|
+
enclosure: { type: 'string', enum: ['single', 'double'] },
|
|
36
|
+
show_column_name: { type: 'string', enum: ['true', 'false'] },
|
|
37
|
+
column_selection: { type: 'array', items: { type: 'string' } },
|
|
38
|
+
|
|
39
|
+
documentType: { type: 'string', enum: ['VatExport'] },
|
|
40
|
+
email: { type: 'string', minLength: 5 },
|
|
41
|
+
lang: { type: 'string' },
|
|
42
|
+
scheduled_id: { type: 'string', minLength: 1, maxLength: 64 },
|
|
43
|
+
existingId: { type: 'string', format: 'uuid' },
|
|
44
|
+
correlationId: { type: 'string', format: 'uuid' }
|
|
45
|
+
}
|
|
46
|
+
}
|