-
Notifications
You must be signed in to change notification settings - Fork 0
/
corepatterns.fiscaltimezones.html
482 lines (470 loc) · 22.3 KB
/
corepatterns.fiscaltimezones.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<script src="javascript/thirdparty/jquery-3.2.0.min.js"></script>
<script src="javascript/thirdparty/handlebars-latest.js"></script>
<script src="javascript/thirdparty/typeahead.bundle.js"></script>
<script src="javascript/thirdparty/clipboard.min.js"></script>
<script src="javascript/searchindex.js"></script>
<script src="javascript/script.js"></script>
<link rel="stylesheet" href="resources/fonts/font-awesome-4.7.0/css/font-awesome.min.css">
<link rel="stylesheet" type="text/css" href="styles/normalizer.css">
<link rel="stylesheet" type="text/css" href="styles/style.css">
<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
<title>Jasmin Developers - Platform | Fiscal Time Zone</title>
</header>
<body>
<div class="header">
<i id="menu-button" class="menu-icon fa fa-bars" aria-hidden="true"></i>
<div class="title">Jasmin Developers - Web API Reference</div>
<div id="search" class="search">
<i class="search-icon fa fa-search" aria-hidden="true"></i>
<input class="typeahead" type="text" placeholder="Search">
</div>
</div>
<div class="sidebar" id="sidebar">
<a class="menu-item " href="index.html">
Overview
</a>
<a class="menu-item" href="accountspayable.html">
Accounts Payable
</a>
<a class="menu-item" href="accountsreceivable.html">
Accounts Receivable
</a>
<a class="menu-item" href="financials.html">
Financials
</a>
<a class="menu-item" href="goodsreceipt.html">
Goods Receipt
</a>
<a class="menu-item" href="logistics.html">
Logistics
</a>
<a class="menu-item" href="masterdatabusinessentities.html">
Master Data Business Entities
</a>
<a class="menu-item" href="materialsmanagement.html">
Materials Management
</a>
<a id="current-menu-item" class="menu-item " href="platform.html">
Platform
</a>
<a class="menu-subitem " href="corepatterns.addresses.html">
Address
</a>
<a class="menu-subitem " href="corepatterns.assignments.html">
Assignment
</a>
<a class="menu-subitem " href="corepatterns.backgroundoperations.html">
BackgroundOperation
</a>
<a class="menu-subitem " href="shell.clientcontextvalues.html">
Client Context Value
</a>
<a class="menu-subitem " href="corepatterns.companies.html">
Company
</a>
<a class="menu-subitem " href="identity.companyaccessrestrictions.html">
Company Access Restriction
</a>
<a class="menu-subitem " href="corepatterns.contacts.html">
Contact
</a>
<a class="menu-subitem " href="corepatterns.contactgroups.html">
Contact Group
</a>
<a class="menu-subitem " href="corepatterns.contacttypes.html">
Contact Type
</a>
<a class="menu-subitem " href="corepatterns.countries.html">
Country
</a>
<a class="menu-subitem " href="corepatterns.cultures.html">
Culture
</a>
<a class="menu-subitem " href="corepatterns.currencies.html">
Currency
</a>
<a class="menu-subitem " href="corepatterns.customentityrecords.html">
Custom Entity Record
</a>
<a class="menu-subitem " href="reporting.offlinereports.html">
Data Report
</a>
<a class="menu-subitem " href="operations.dbversions.html">
Db Version
</a>
<a class="menu-subitem " href="corepatterns.drafts.html">
Draft
</a>
<a class="menu-subitem " href="reporting.electroniccertificates.html">
Electronic Certificate
</a>
<a class="menu-subitem " href="operations.emailtemplates.html">
Email Template
</a>
<a class="menu-subitem " href="corepatterns.schemaattributes.html">
Entity Attribute
</a>
<a class="menu-subitem " href="corepatterns.entitylockreasons.html">
Entity Lock Reason
</a>
<a class="menu-subitem " href="corepatterns.extensibilityviewdefinitions.html">
Extensibility View Definition
</a>
<a class="menu-subitem menu-item-selected" href="corepatterns.fiscaltimezones.html">
Fiscal Time Zone
</a>
<a class="menu-subitem " href="identity.groups.html">
Group
</a>
<a class="menu-subitem " href="corepatterns.importdatainfos.html">
Import Data Info
</a>
<a class="menu-subitem " href="operations.notifications.html">
Notification
</a>
<a class="menu-subitem " href="corepatterns.operations.html">
Operation
</a>
<a class="menu-subitem " href="corepatterns.organizationconfigurations.html">
Organization Configuration
</a>
<a class="menu-subitem " href="corepatterns.postalzones.html">
Postal Code
</a>
<a class="menu-subitem " href="corepatterns.powerbiinfos.html">
Power Bi Info
</a>
<a class="menu-subitem " href="corepatterns.regions.html">
Region
</a>
<a class="menu-subitem " href="identity.roles.html">
Role
</a>
<a class="menu-subitem " href="corepatterns.schemaentities.html">
Schema Entity Management
</a>
<a class="menu-subitem " href="corepatterns.sequences.html">
Sequence
</a>
<a class="menu-subitem " href="corepatterns.subscriptionvalidations.html">
Subscription Validation
</a>
<a class="menu-subitem " href="corepatterns.units.html">
Unit
</a>
<a class="menu-subitem " href="corepatterns.unitdimensions.html">
Unit Dimension
</a>
<a class="menu-subitem " href="operations.upgradeversions.html">
Upgrade Version
</a>
<a class="menu-subitem " href="identity.users.html">
User
</a>
<a class="menu-item" href="purchases.html">
Purchases
</a>
<a class="menu-item" href="sales.html">
Sales
</a>
<a class="menu-item" href="shipping.html">
Shipping
</a>
<a class="menu-item" href="taxes.html">
Taxes
</a>
</div>
<div class="content">
<div class="content-section">
<div class="content-section-col1">
<h1>Platform | Fiscal Time Zone</h1>
<p>
Service to manage entities of type 'FiscalTimeZone'.
</p>
<h2>Overview</h2>
<br/>
<table>
<tbody>
<tr>
<td>URL</td>
<td class="breakword url-cell">api/{tenantKey}/{orgKey}/corePatterns/fiscalTimeZones <i title="Copy to clipboard" class="copy-clipboard fa fa-clipboard clipboard-url" aria-hidden="true" data-clipboard-target="#copy-corepatterns-fiscaltimezones"></i></td>
<div class="hidden-copylink" id="copy-corepatterns-fiscaltimezones">api/{tenantKey}/{orgKey}/corePatterns/fiscalTimeZones</div>
</tr>
<tr>
<td>Methods Supported</td>
<td><a href="#GET">GET</a></td>
</tr>
</tbody>
</table>
<h2>All Operations</h2>
<p>
This service includes the following operations:
</p>
<ul>
<li>
GET:
<ul>
<li><a href="#4f21f136-3608-44ec-b206-63478e1a858b">GET FiscalTimeZones</a></li>
<li><a href="#acac7e43-397d-4ae0-abf8-3420e5018166">GET FiscalTimeZones (paged)</a></li>
<li><a href="#8eb862aa-2b9a-4c59-984c-e15aef70c27e">GET FiscalTimeZone by identifier</a></li>
<li><a href="#cc181343-c7b5-44dd-be57-dd079b9ec08f">GET FiscalTimeZone by key</a></li>
</ul>
</li>
</ul>
<h2>All Resources</h2>
<p>
This service uses the following resources:
</p>
<ul>
<li><a href="#FiscalTimeZoneResource">FiscalTimeZoneResource</a></li>
</ul>
</div>
</div>
<div class="content-section">
<div class="content-section-col1">
<a class="anchor" name="GET"></a>
<h2>GET Operations</h2>
</div>
</div>
<div class="content-section">
<div class="content-section-col1">
<a class="anchor" name="4f21f136-3608-44ec-b206-63478e1a858b"></a>
<h3>GET FiscalTimeZones <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-4f21f136-3608-44ec-b206-63478e1a858b"></i></h3>
<div class="hidden-copylink" id="copy-4f21f136-3608-44ec-b206-63478e1a858b"><a href="#4f21f136-3608-44ec-b206-63478e1a858b">GET FiscalTimeZones</a></div>
<p class="operation-description">Returns the list of all the entity records available.</p>
<p>Response:</p>
<table>
<tbody>
<tr>
<td>When successful, the response body contains the list of records available. See <a href="#FiscalTimeZoneResource">FiscalTimeZoneResource.</a></td>
</tr>
</tbody>
</table>
<p>Response status codes:</p>
<table>
<tbody>
<tr>
<td class="highlighted">200</td>
<td>OK. The operation was completed successfully.</td>
</tr>
<tr>
<td class="highlighted">400</td>
<td>BadRequest. The request parameters are invalid.</td>
</tr>
</tbody>
</table>
</div>
<div class="content-section-col2">
<p>Resource URL:</p>
<div class="hidden-copylink" id="copy2-4f21f136-3608-44ec-b206-63478e1a858b">api/{tenantKey}/{orgKey}/corePatterns/fiscalTimeZones</div>
<div class="resource-url">
<div class="inner-resource-url"><div>GET /corePatterns/fiscalTimeZones</div></div>
<div class="copy-clipboard clipboard-example" data-clipboard-target="#copy2-4f21f136-3608-44ec-b206-63478e1a858b"><div><i title="Copy to clipboard" class="fa fa-clipboard" aria-hidden="true"></i></div></div>
</div>
</div>
</div>
<div class="content-section">
<div class="content-section-col1">
<a class="anchor" name="acac7e43-397d-4ae0-abf8-3420e5018166"></a>
<h3>GET FiscalTimeZones (paged) <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-acac7e43-397d-4ae0-abf8-3420e5018166"></i></h3>
<div class="hidden-copylink" id="copy-acac7e43-397d-4ae0-abf8-3420e5018166"><a href="#acac7e43-397d-4ae0-abf8-3420e5018166">GET FiscalTimeZones (paged)</a></div>
<p class="operation-description">Returns a page of the list of all the entity records available.</p>
<p>The following elements are optional:</p>
<table>
<tbody>
<tr>
<td class="highlighted">page</td>
<td><i>(int)</i> The index of the page of the list that should be returned. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">pageSize</td>
<td><i>(int)</i> The number of page elements that should be returned (max. is 1000). This is a query string parameter.</td>
</tr>
</tbody>
</table>
<br />
<p>Response:</p>
<table>
<tbody>
<tr>
<td>When successful, the response body contains the list of records available. See <a href="#FiscalTimeZoneResource">FiscalTimeZoneResource.</a></td>
</tr>
</tbody>
</table>
<p>Response status codes:</p>
<table>
<tbody>
<tr>
<td class="highlighted">200</td>
<td>OK. The operation was completed successfully.</td>
</tr>
<tr>
<td class="highlighted">400</td>
<td>BadRequest. The request parameters are invalid.</td>
</tr>
</tbody>
</table>
</div>
<div class="content-section-col2">
<p>Resource URL:</p>
<div class="hidden-copylink" id="copy2-acac7e43-397d-4ae0-abf8-3420e5018166">api/{tenantKey}/{orgKey}/corePatterns/fiscalTimeZones?page={page}&pageSize={pageSize}</div>
<div class="resource-url">
<div class="inner-resource-url"><div>GET /corePatterns/fiscalTimeZones?page={page}&pageSize={pageSize}</div></div>
<div class="copy-clipboard clipboard-example" data-clipboard-target="#copy2-acac7e43-397d-4ae0-abf8-3420e5018166"><div><i title="Copy to clipboard" class="fa fa-clipboard" aria-hidden="true"></i></div></div>
</div>
</div>
</div>
<div class="content-section">
<div class="content-section-col1">
<a class="anchor" name="8eb862aa-2b9a-4c59-984c-e15aef70c27e"></a>
<h3>GET FiscalTimeZone by identifier <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-8eb862aa-2b9a-4c59-984c-e15aef70c27e"></i></h3>
<div class="hidden-copylink" id="copy-8eb862aa-2b9a-4c59-984c-e15aef70c27e"><a href="#8eb862aa-2b9a-4c59-984c-e15aef70c27e">GET FiscalTimeZone by identifier</a></div>
<p class="operation-description">Returns the entity record that matches the specified identifier.</p>
<p>The following elements are required:</p>
<table>
<tbody>
<tr>
<td class="highlighted">id</td>
<td><i>(string)</i> The record identifier.</td>
</tr>
</tbody>
</table>
<br />
<p>Response:</p>
<table>
<tbody>
<tr>
<td>When successful, the response body contains the entity record. See <a href="#FiscalTimeZoneResource">FiscalTimeZoneResource.</a></td>
</tr>
</tbody>
</table>
<p>Response status codes:</p>
<table>
<tbody>
<tr>
<td class="highlighted">200</td>
<td>OK. The operation was completed successfully.</td>
</tr>
<tr>
<td class="highlighted">400</td>
<td>BadRequest. The request parameters are invalid.</td>
</tr>
<tr>
<td class="highlighted">404</td>
<td>NotFound. The specified record does not exist.</td>
</tr>
</tbody>
</table>
</div>
<div class="content-section-col2">
<p>Resource URL:</p>
<div class="hidden-copylink" id="copy2-8eb862aa-2b9a-4c59-984c-e15aef70c27e">api/{tenantKey}/{orgKey}/corePatterns/fiscalTimeZones/{id}</div>
<div class="resource-url">
<div class="inner-resource-url"><div>GET /corePatterns/fiscalTimeZones/{id}</div></div>
<div class="copy-clipboard clipboard-example" data-clipboard-target="#copy2-8eb862aa-2b9a-4c59-984c-e15aef70c27e"><div><i title="Copy to clipboard" class="fa fa-clipboard" aria-hidden="true"></i></div></div>
</div>
</div>
</div>
<div class="content-section">
<div class="content-section-col1">
<a class="anchor" name="cc181343-c7b5-44dd-be57-dd079b9ec08f"></a>
<h3>GET FiscalTimeZone by key <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-cc181343-c7b5-44dd-be57-dd079b9ec08f"></i></h3>
<div class="hidden-copylink" id="copy-cc181343-c7b5-44dd-be57-dd079b9ec08f"><a href="#cc181343-c7b5-44dd-be57-dd079b9ec08f">GET FiscalTimeZone by key</a></div>
<p class="operation-description">Returns the entity record that matches the specified key.</p>
<p>The following elements are required:</p>
<table>
<tbody>
<tr>
<td class="highlighted">code</td>
<td><i>(int)</i> The fiscal time zone’s code.</td>
</tr>
</tbody>
</table>
<br />
<p>Response:</p>
<table>
<tbody>
<tr>
<td>When successful, the response body contains the entity record. See <a href="#FiscalTimeZoneResource">FiscalTimeZoneResource.</a></td>
</tr>
</tbody>
</table>
<p>Response status codes:</p>
<table>
<tbody>
<tr>
<td class="highlighted">200</td>
<td>OK. The operation was completed successfully.</td>
</tr>
<tr>
<td class="highlighted">400</td>
<td>BadRequest. The request parameters are invalid.</td>
</tr>
<tr>
<td class="highlighted">404</td>
<td>NotFound. The specified record does not exist.</td>
</tr>
</tbody>
</table>
</div>
<div class="content-section-col2">
<p>Resource URL:</p>
<div class="hidden-copylink" id="copy2-cc181343-c7b5-44dd-be57-dd079b9ec08f">api/{tenantKey}/{orgKey}/corePatterns/fiscalTimeZones/{code}</div>
<div class="resource-url">
<div class="inner-resource-url"><div>GET /corePatterns/fiscalTimeZones/{code}</div></div>
<div class="copy-clipboard clipboard-example" data-clipboard-target="#copy2-cc181343-c7b5-44dd-be57-dd079b9ec08f"><div><i title="Copy to clipboard" class="fa fa-clipboard" aria-hidden="true"></i></div></div>
</div>
</div>
</div>
<div class="content-section">
<div class="content-section-col1">
<h2>Resources</h2>
<br />
<a class="anchor" name="FiscalTimeZoneResource"></a>
<h4>FiscalTimeZoneResource <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-FiscalTimeZoneResource"></i></h4>
<div class="hidden-copylink" id="copy-FiscalTimeZoneResource"><a href="#FiscalTimeZoneResource">FiscalTimeZoneResource</a></div>
<p>The following elements are required:</p>
<table>
<tbody>
<tr>
<td class="highlighted">code</td>
<td class="wrap"><i>(int)</i> The fiscal time zone’s code.
</td>
</tr>
</tbody>
</table>
<p>The following elements are optional:</p>
<table>
<tbody>
<tr>
<td class="highlighted">name</td>
<td class="wrap"><i>(string)</i> The fiscal time zone’s name.
</td>
</tr>
<tr>
<td class="highlighted">displayName</td>
<td class="wrap"><i>(string)</i> The fiscal time zone’s display name.
</td>
</tr>
</tbody>
</table>
<br />
<br />
</div>
</div>
</div>
</body>
<script>
var clipboard = new Clipboard('.copy-clipboard');
clipboard.on('success', function(e) {
showTooltip(e.trigger, 'Copied!', 'left');
});
clipboard.on('error', function(e) {
showTooltip(e.trigger, 'Error!', 'left');
});
</script>
</html>