You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: output/apidocs/eva/services/ApprovePayment.json
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -77,9 +77,9 @@
77
77
{
78
78
"name": "PaymentTransactionID",
79
79
"deprecation_notice": null,
80
-
"description": "This is the ID of a \u0060PaymentTransaction\u0060\n\n**Required since 794:** Field PaymentTransactionID is required and will be enforced as such in 2.0.826.\n\n**Will be enforced in 810**",
81
-
"type": "integer | null",
82
-
"required": false,
80
+
"description": "This is the ID of a \u0060PaymentTransaction\u0060",
Copy file name to clipboardExpand all lines: output/apidocs/eva/services/CancelPayment.json
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -77,9 +77,9 @@
77
77
{
78
78
"name": "PaymentTransactionID",
79
79
"deprecation_notice": null,
80
-
"description": "This is the ID of a \u0060PaymentTransaction\u0060\n\n**Required since 794:** Field PaymentTransactionID is required and will be enforced as such in 2.0.826.\n\n**Will be enforced in 810**",
81
-
"type": "integer | null",
82
-
"required": false,
80
+
"description": "This is the ID of a \u0060PaymentTransaction\u0060",
Copy file name to clipboardExpand all lines: output/apidocs/eva/services/DataLakeBackfill.json
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
"name": "DataLakeBackfill",
3
3
"method": "POST",
4
4
"path": "/message/DataLakeBackfill",
5
-
"description": "Manually re-export specific DataLake documents.\n\nThese types are currently supported;\n\n* \u0060FinancialPeriods\u0060 = 1\n* \u0060Orders\u0060 = 2\n* \u0060Invoices\u0060 = 3\n* \u0060Users\u0060 = 4\n* \u0060Discounts\u0060 = 5\n* \u0060UserBatches\u0060 = 6 (can only be used with \u0060From\u0060 and \u0060To\u0060)\n* \u0060Cases\u0060 = 7\n* \u0060Shipments\u0060 = 8\n* \u0060ZonedCycleCounts\u0060 = 9\n* \u0060UserTasks\u0060 = 10\n* \u0060StockMutations\u0060 = 11\n* \u0060UserLoyaltyPointMutations\u0060 = 12 (can only be used with the \u0060ID\u0060 or \u0060IDs\u0060. These need to be the user ID\u0027s of which the loyalty point mutation will be exported.)\n* \u0060LoyaltyProgramGroups\u0060 = 13 (can only be used with the \u0060ID\u0060 or \u0060IDs\u0060.)\n* \u0060LoyaltyPrograms\u0060 = 14 (can only be used with the \u0060ID\u0060 or \u0060IDs\u0060.)\n* \u0060FullStockCounts\u0060 = 15 (can only be used with the \u0060ID\u0060 or \u0060IDs\u0060.)\n* \u0060StockNotifications\u0060 = 16 (can only be used with the \u0060ID\u0060 or \u0060IDs\u0060.)\n* \u0060ProductSubscriptions\u0060 = 17 (can only be used with \u0060From\u0060 and \u0060To\u0060)\n\nSpecify either a single \u0060ID\u0060, a list of \u0060IDs\u0060, or a datetime range \u0060From\u0060 and \u0060To\u0060 (inclusive).\n\nFor the following types, you can optionally specify an \u0060OrganizationUnitID\u0060 to filter results within a datetime range:\n\u0060FinancialPeriods\u0060, \u0060Orders\u0060, \u0060Invoices\u0060, \u0060Discounts\u0060, \u0060Cases\u0060, \u0060Shipments\u0060, \u0060ZonedCycleCounts\u0060, \u0060UserTasks\u0060, \u0060StockMutations\u0060, \u0060StockNotifications\u0060.\n\nFor the following types: \u0060Discounts\u0060, the \u0060OrganizationUnitID\u0060 must be a setID\n\nAs mandatory safety feature, specify the \u0060MaxNumberOfDocuments\u0060 you\u0027d like to run this for. When the amount of documents through above\nselection exceeds this number, this service will export NOTHING and return to you an error with the amount of documents it prevented you\nfrom exporting, so you can adjust your selection or expand your max.\n\n:warning: Triggering large amounts of data may impact system performance!\n\n:point_right: The \u0060ID\u0060 you are returned can be used in subsequent services \u0060DataLakeBackfillStatus\u0060 and \u0060DataLakeBackfillCancel\u0060.",
5
+
"description": "Manually re-export specific DataLake documents.\n\nThese types are currently supported;\n\n* \u0060FinancialPeriods\u0060 = 1\n* \u0060Orders\u0060 = 2\n* \u0060Invoices\u0060 = 3\n* \u0060Users\u0060 = 4\n* \u0060Discounts\u0060 = 5\n* \u0060UserBatches\u0060 = 6 (can only be used with \u0060From\u0060 and \u0060To\u0060)\n* \u0060Cases\u0060 = 7\n* \u0060Shipments\u0060 = 8\n* \u0060ZonedCycleCounts\u0060 = 9\n* \u0060UserTasks\u0060 = 10\n* \u0060StockMutations\u0060 = 11\n* \u0060UserLoyaltyPointMutations\u0060 = 12 (can only be used with the \u0060ID\u0060 or \u0060IDs\u0060. These need to be the user ID\u0027s of which the loyalty point mutation will be exported.)\n* \u0060LoyaltyProgramGroups\u0060 = 13 (can only be used with the \u0060ID\u0060 or \u0060IDs\u0060.)\n* \u0060LoyaltyPrograms\u0060 = 14 (can only be used with the \u0060ID\u0060 or \u0060IDs\u0060.)\n* \u0060FullStockCounts\u0060 = 15 (can only be used with the \u0060ID\u0060 or \u0060IDs\u0060.)\n* \u0060StockNotifications\u0060 = 16 (can only be used with the \u0060ID\u0060 or \u0060IDs\u0060.)\n* \u0060ProductSubscriptions\u0060 = 17 (can only be used with \u0060From\u0060 and \u0060To\u0060)\n* \u0060TransputJobs\u0060 = 18\n\nSpecify either a single \u0060ID\u0060, a list of \u0060IDs\u0060, or a datetime range \u0060From\u0060 and \u0060To\u0060 (inclusive).\n\nFor the following types, you can optionally specify an \u0060OrganizationUnitID\u0060 to filter results within a datetime range:\n\u0060FinancialPeriods\u0060, \u0060Orders\u0060, \u0060Invoices\u0060, \u0060Discounts\u0060, \u0060Cases\u0060, \u0060Shipments\u0060, \u0060ZonedCycleCounts\u0060, \u0060UserTasks\u0060, \u0060StockMutations\u0060, \u0060StockNotifications\u0060.\n\nFor the following types: \u0060Discounts\u0060, the \u0060OrganizationUnitID\u0060 must be a setID\n\nAs mandatory safety feature, specify the \u0060MaxNumberOfDocuments\u0060 you\u0027d like to run this for. When the amount of documents through above\nselection exceeds this number, this service will export NOTHING and return to you an error with the amount of documents it prevented you\nfrom exporting, so you can adjust your selection or expand your max.\n\n:warning: Triggering large amounts of data may impact system performance!\n\n:point_right: The \u0060ID\u0060 you are returned can be used in subsequent services \u0060DataLakeBackfillStatus\u0060 and \u0060DataLakeBackfillCancel\u0060.",
6
6
"auth_description": "Requires a user of type \u0060Employee\u0060 or \u0060Api\u0060 with functionality \u0060DataLakeBackfill:None\u0060",
"description": "Get all unsued company requirement properties for the given country and company type. For existing requirements, use \u0060GetCompanyRequirements\u0060.",
6
+
"auth_description": "Requires a user of type \u0060Employee\u0060 or \u0060Api\u0060 with functionality \u0060CompanyRequirements:View\u0060",
7
+
"headers": [
8
+
{
9
+
"name": "EVA-User-Agent",
10
+
"type": "string",
11
+
"description": "The user agent that is making these calls. Don\u0027t make this specific per device/browser but per application. This should be of the form: \u0060MyFirstUserAgent/1.0.0\u0060",
12
+
"required": true,
13
+
"default": null
14
+
},
15
+
{
16
+
"name": "EVA-Requested-OrganizationUnitID",
17
+
"type": "integer",
18
+
"description": "The ID of the organization unit to run this request in.",
19
+
"required": false,
20
+
"default": null
21
+
},
22
+
{
23
+
"name": "EVA-Requested-OrganizationUnit-Query",
24
+
"type": "string",
25
+
"description": "The query that selects the organization unit to run this request in.",
"sample": "{\n\u0022Error\u0022: {\n\u0022Code\u0022: \u0022COVFEFE\u0022,\n\u0022Type\u0022: \u0022RequestValidationFailure\u0022,\n\u0022Message\u0022: \u0022Validation of the request message failed: Field ABC has an invalid value for a Product.\u0022,\n\u0022RequestID\u0022: \u0022576b62dd71894e3281a4d84951f44e70\u0022\n }\n}"
50
+
},
51
+
{
52
+
"name": "403",
53
+
"sample": "{\n\u0022Error\u0022: {\n\u0022Code\u0022: \u0022COVFEFE\u0022,\n\u0022Type\u0022: \u0022Forbidden\u0022,\n\u0022Message\u0022: \u0022You are not authorized to execute this request.\u0022,\n\u0022RequestID\u0022: \u0022576b62dd71894e3281a4d84951f44e70\u0022\n }\n}"
54
+
}
55
+
],
56
+
"deprecation_notice": null,
57
+
"request_type_id": "B",
58
+
"response_type_id": "C",
59
+
"types": {
60
+
"B": [
61
+
{
62
+
"name": "ApplyToCompanyType",
63
+
"deprecation_notice": null,
64
+
"description": "Flags enum, combine any of the below values:\n\n* \u00601\u0060 - Consumer\n* \u00602\u0060 - OrganizationUnit",
65
+
"type": "integer",
66
+
"required": true,
67
+
"properties_id": null,
68
+
"one_of": null
69
+
},
70
+
{
71
+
"name": "CountryID",
72
+
"deprecation_notice": null,
73
+
"description": "This is the ID of a \u0060Country\u0060",
74
+
"type": "string",
75
+
"required": true,
76
+
"properties_id": null,
77
+
"one_of": null
78
+
}
79
+
],
80
+
"D": [
81
+
{
82
+
"name": "Code",
83
+
"deprecation_notice": null,
84
+
"description": "A unique ID identifying this error.",
85
+
"type": "string | null",
86
+
"required": false,
87
+
"properties_id": null,
88
+
"one_of": null
89
+
},
90
+
{
91
+
"name": "Data",
92
+
"deprecation_notice": null,
93
+
"description": "",
94
+
"type": "any | null",
95
+
"required": false,
96
+
"properties_id": null,
97
+
"one_of": null
98
+
},
99
+
{
100
+
"name": "Message",
101
+
"deprecation_notice": null,
102
+
"description": "A human-readable message describing the error.",
103
+
"type": "string | null",
104
+
"required": false,
105
+
"properties_id": null,
106
+
"one_of": null
107
+
},
108
+
{
109
+
"name": "RequestID",
110
+
"deprecation_notice": null,
111
+
"description": "A unique ID identifying the request. Please provide this ID when contacting support.",
112
+
"type": "string | null",
113
+
"required": false,
114
+
"properties_id": null,
115
+
"one_of": null
116
+
},
117
+
{
118
+
"name": "Type",
119
+
"deprecation_notice": null,
120
+
"description": "A short description of the error type.",
121
+
"type": "string | null",
122
+
"required": false,
123
+
"properties_id": null,
124
+
"one_of": null
125
+
}
126
+
],
127
+
"E": [
128
+
{
129
+
"name": "ExternalIDs",
130
+
"deprecation_notice": null,
131
+
"description": "When using the \u0060ExternalIDs\u0060 mode, this will hold the resolved external IDs.",
132
+
"type": "map[map[string]] | null",
133
+
"required": false,
134
+
"properties_id": null,
135
+
"one_of": null
136
+
},
137
+
{
138
+
"name": "IsAsyncResultAvailable",
139
+
"deprecation_notice": null,
140
+
"description": "This is a flag indicating whether the async request is done. If it is \u0060null\u0060, it is not an async service. If it is \u0060false\u0060, the response is not yet available. Do not process the properties in that case. It is is \u0060true\u0060 the properties are filled with the result of the call.",
141
+
"type": "boolean | null",
142
+
"required": false,
143
+
"properties_id": null,
144
+
"one_of": null
145
+
},
146
+
{
147
+
"name": "UnresolvedExternalIDs",
148
+
"deprecation_notice": null,
149
+
"description": "When using the \u0060ExternalIDs\u0060 mode, this will hold the external IDs we couldn\u0027t resolve.",
0 commit comments