-
Notifications
You must be signed in to change notification settings - Fork 0
/
billing.processreturnorders.html
573 lines (530 loc) · 26.4 KB
/
billing.processreturnorders.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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
<!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 - Sales | Process Return Order</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 class="menu-item" href="platform.html">
Platform
</a>
<a class="menu-item" href="purchases.html">
Purchases
</a>
<a id="current-menu-item" class="menu-item " href="sales.html">
Sales
</a>
<a class="menu-subitem " href="salescore.associatesalesitemstosaleschannels.html">
Associate Sales Items To Sales Channel
</a>
<a class="menu-subitem " href="billing.companyinvoices.html">
Company Invoice
</a>
<a class="menu-subitem " href="billing.memos.html">
Credit or Debit Note
</a>
<a class="menu-subitem " href="salescore.customergroups.html">
Customer Group
</a>
<a class="menu-subitem " href="salescore.customerparties.html">
Customer Party
</a>
<a class="menu-subitem " href="sales.indicators.html">
Indicator
</a>
<a class="menu-subitem " href="billing.invoices.html">
Invoice
</a>
<a class="menu-subitem " href="salescore.invoicetypes.html">
Invoice Type
</a>
<a class="menu-subitem " href="salescore.memotypes.html">
Memo Type
</a>
<a class="menu-subitem " href="billing.monitorings.html">
Monitoring
</a>
<a class="menu-subitem " href="sales.orders.html">
Order
</a>
<a class="menu-subitem " href="salescore.ordertypes.html">
Order Type
</a>
<a class="menu-subitem " href="salescore.posdevices.html">
Pos Device
</a>
<a class="menu-subitem " href="salescore.pricelists.html">
Price List
</a>
<a class="menu-subitem " href="billing.processorders.html">
Process Order
</a>
<a class="menu-subitem menu-item-selected" href="billing.processreturnorders.html">
Process Return Order
</a>
<a class="menu-subitem " href="sales.productnews.html">
Product News
</a>
<a class="menu-subitem " href="sales.quotations.html">
Quotation
</a>
<a class="menu-subitem " href="salescore.quotationtypes.html">
Quotation Type
</a>
<a class="menu-subitem " href="salescore.saleschannels.html">
Sales Channel
</a>
<a class="menu-subitem " href="salescore.salesitems.html">
Sales Item
</a>
<a class="menu-subitem " href="salescore.salessetups.html">
Sales Settings
</a>
<a class="menu-subitem " href="salescore.salespersons.html">
Salesperson
</a>
<a class="menu-subitem " href="salescore.stores.html">
Store
</a>
<a class="menu-subitem " href="sales.summaryvalues.html">
Summary Value
</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>Sales | Process Return Order</h1>
<p>
</p>
<h2>Overview</h2>
<br/>
<table>
<tbody>
<tr>
<td>URL</td>
<td class="breakword url-cell">api/{tenantKey}/{orgKey}/billing/processReturnOrders <i title="Copy to clipboard" class="copy-clipboard fa fa-clipboard clipboard-url" aria-hidden="true" data-clipboard-target="#copy-billing-processreturnorders"></i></td>
<div class="hidden-copylink" id="copy-billing-processreturnorders">api/{tenantKey}/{orgKey}/billing/processReturnOrders</div>
</tr>
<tr>
<td>Methods Supported</td>
<td><a href="#GET">GET</a>, <a href="#POST">POST</a></td>
</tr>
</tbody>
</table>
<h2>All Operations</h2>
<p>
This service includes the following operations:
</p>
<ul>
<li>
GET:
<ul>
<li><a href="#6ea504cf-f4b8-4256-8af2-566288c0bd2b">GET Process Return Order</a></li>
</ul>
</li>
<li>
POST:
<ul>
<li><a href="#3dfdefda-cd39-47b5-98cf-932291210dc2">POST Process Return Order</a></li>
</ul>
</li>
</ul>
<h2>All Resources</h2>
<p>
This service uses the following resources:
</p>
<ul>
<li><a href="#BillingReturnOrder">BillingReturnOrder</a></li>
<li><a href="#BillingReturnOrderLine">BillingReturnOrderLine</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="6ea504cf-f4b8-4256-8af2-566288c0bd2b"></a>
<h3>GET Process Return Order <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-6ea504cf-f4b8-4256-8af2-566288c0bd2b"></i></h3>
<div class="hidden-copylink" id="copy-6ea504cf-f4b8-4256-8af2-566288c0bd2b"><a href="#6ea504cf-f4b8-4256-8af2-566288c0bd2b">GET Process Return Order</a></div>
<p class="operation-description">Returns the list of entity records that can be processed by the 'Memos' service.</p>
<p>The following elements are required:</p>
<table>
<tbody>
<tr>
<td class="highlighted">pageIndex</td>
<td><i>(int)</i> The index of the page of the list that should be returned.</td>
</tr>
<tr>
<td class="highlighted">pageSize</td>
<td><i>(int)</i> The number of page elements that should be returned (max. is 1000).</td>
</tr>
</tbody>
</table>
<br />
<p>The following elements are optional:</p>
<table>
<tbody>
<tr>
<td class="highlighted">company</td>
<td><i>(string)</i> The company code is the central organizational unit within the system. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">accountingCustomerParty</td>
<td><i>(string)</i> The accounting's customer party. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">memoType</td>
<td><i>(string)</i> The memo's type. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">billingRequestDateFrom</td>
<td><i>(DateTime?)</i> The start date for the billing request. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">billingRequestDateUntil</td>
<td><i>(DateTime?)</i> The end date for the billing request. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">currency</td>
<td><i>(string)</i> The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the customer party. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">sourceDoc</td>
<td><i>(string)</i> The source document. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">goodsReceiptNoteKey</td>
<td><i>(string)</i> The key for the goods receipt note. 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 entity records available for processing. See <a href="#BillingReturnOrderLine">BillingReturnOrderLine.</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-6ea504cf-f4b8-4256-8af2-566288c0bd2b">api/{tenantKey}/{orgKey}/billing/processReturnOrders/{pageIndex}/{pageSize}?company={company}&accountingCustomerParty={accountingCustomerParty}&memoType={memoType}&billingRequestDateFrom={billingRequestDateFrom}&billingRequestDateUntil={billingRequestDateUntil}&currency={currency}&sourceDoc={sourceDoc}&goodsReceiptNoteKey={goodsReceiptNoteKey}</div>
<div class="resource-url">
<div class="inner-resource-url"><div>GET /billing/processReturnOrders/{pageIndex}/{pageSize}?company={company}&accountingCustomerParty={accountingCustomerParty}&memoType={memoType}&billingRequestDateFrom={billingRequestDateFrom}&billingRequestDateUntil={billingRequestDateUntil}&currency={currency}&sourceDoc={sourceDoc}&goodsReceiptNoteKey={goodsReceiptNoteKey}</div></div>
<div class="copy-clipboard clipboard-example" data-clipboard-target="#copy2-6ea504cf-f4b8-4256-8af2-566288c0bd2b"><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="POST"></a>
<h2>POST Operations</h2>
</div>
</div>
<div class="content-section">
<div class="content-section-col1">
<a class="anchor" name="3dfdefda-cd39-47b5-98cf-932291210dc2"></a>
<h3>POST Process Return Order <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-3dfdefda-cd39-47b5-98cf-932291210dc2"></i></h3>
<div class="hidden-copylink" id="copy-3dfdefda-cd39-47b5-98cf-932291210dc2"><a href="#3dfdefda-cd39-47b5-98cf-932291210dc2">POST Process Return Order</a></div>
<p class="operation-description">Instructs the 'Memos' service to process the specified entity records.</p>
<p>The following elements are required:</p>
<table>
<tbody>
<tr>
<td class="highlighted">list</td>
<td><i>(BillingReturnOrderLine)</i> List of the entity records that should be processed.<br/>See <a href="#BillingReturnOrderLine">BillingReturnOrderLine.</a></td>
</tr>
<tr>
<td class="highlighted">companyKey</td>
<td><i>(string)</i> The company key.</td>
</tr>
</tbody>
</table>
<br />
<p>Response:</p>
<table>
<tbody>
<tr>
<td>When successful, the response body is empty. The URL of the processed items is returned in the response location header.</td>
</tr>
</tbody>
</table>
<p>Response status codes:</p>
<table>
<tbody>
<tr>
<td class="highlighted">201</td>
<td>Created. 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-3dfdefda-cd39-47b5-98cf-932291210dc2">api/{tenantKey}/{orgKey}/billing/processReturnOrders/{companyKey}</div>
<div class="resource-url">
<div class="inner-resource-url"><div>POST /billing/processReturnOrders/{companyKey}</div></div>
<div class="copy-clipboard clipboard-example" data-clipboard-target="#copy2-3dfdefda-cd39-47b5-98cf-932291210dc2"><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="BillingReturnOrder"></a>
<h4>BillingReturnOrder <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-BillingReturnOrder"></i></h4>
<div class="hidden-copylink" id="copy-BillingReturnOrder"><a href="#BillingReturnOrder">BillingReturnOrder</a></div>
<p>The following elements are required:</p>
<table>
<tbody>
<tr>
<td class="highlighted">selectedCount</td>
<td class="wrap"><i>(int)</i> Selected Count.
</td>
</tr>
</tbody>
</table>
<p>The following elements are optional:</p>
<table>
<tbody>
<tr>
<td class="highlighted">company</td>
<td class="wrap"><i>(string)</i> The company code is the central organizational unit within the system.
</td>
</tr>
<tr>
<td class="highlighted">accountingCustomerParty</td>
<td class="wrap"><i>(string)</i> The accounting's customer party.
</td>
</tr>
<tr>
<td class="highlighted">memoType</td>
<td class="wrap"><i>(string)</i> The memo's type.
</td>
</tr>
<tr>
<td class="highlighted">billingRequestDateFrom</td>
<td class="wrap"><i>(DateTime)</i> The start date for the billing request.
</td>
</tr>
<tr>
<td class="highlighted">billingRequestDateUntil</td>
<td class="wrap"><i>(DateTime)</i> The end date for the billing request.
</td>
</tr>
<tr>
<td class="highlighted">currency</td>
<td class="wrap"><i>(string)</i> The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the customer party.
</td>
</tr>
<tr>
<td class="highlighted">sourceDoc</td>
<td class="wrap"><i>(string)</i> The source document.
</td>
</tr>
<tr>
<td class="highlighted">goodsReceiptNoteKey</td>
<td class="wrap"><i>(string)</i> The key for the goods receipt note.
</td>
</tr>
</tbody>
</table>
<br />
<br />
<a class="anchor" name="BillingReturnOrderLine"></a>
<h4>BillingReturnOrderLine <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-BillingReturnOrderLine"></i></h4>
<div class="hidden-copylink" id="copy-BillingReturnOrderLine"><a href="#BillingReturnOrderLine">BillingReturnOrderLine</a></div>
<p>The following elements are required:</p>
<table>
<tbody>
<tr>
<td class="highlighted">selected</td>
<td class="wrap"><i>(bool)</i> Indicates if the line has been selected.
</td>
</tr>
<tr>
<td class="highlighted">hasDiscountInValue</td>
<td class="wrap"><i>(bool)</i> Has Discount In Value.
</td>
</tr>
</tbody>
</table>
<p>The following elements are optional:</p>
<table>
<tbody>
<tr>
<td class="highlighted">salesItem</td>
<td class="wrap"><i>(string)</i> The sales item.
</td>
</tr>
<tr>
<td class="highlighted">currency</td>
<td class="wrap"><i>(string)</i> The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the customer party.
</td>
</tr>
<tr>
<td class="highlighted">goodsReceiptNoteKey</td>
<td class="wrap"><i>(string)</i> The key for the goods receipt note.
</td>
</tr>
<tr>
<td class="highlighted">goodsReceiptNoteLineNumber</td>
<td class="wrap"><i>(int)</i> The goods receipt's note line number.
</td>
</tr>
<tr>
<td class="highlighted">description</td>
<td class="wrap"><i>(string)</i> The description for the line.
</td>
</tr>
<tr>
<td class="highlighted">orderKey</td>
<td class="wrap"><i>(string)</i> The order's key.
</td>
</tr>
<tr>
<td class="highlighted">orderLineNumber</td>
<td class="wrap"><i>(int)</i> The order's line number.
</td>
</tr>
<tr>
<td class="highlighted">quantity</td>
<td class="wrap"><i>(decimal)</i> The line's quantity.
</td>
</tr>
<tr>
<td class="highlighted">unit</td>
<td class="wrap"><i>(string)</i> The line's unit.
</td>
</tr>
<tr>
<td class="highlighted">unitPrice</td>
<td class="wrap"><i>(decimal)</i> The line's unit price.
</td>
</tr>
<tr>
<td class="highlighted">billingRequestId</td>
<td class="wrap"><i>(Guid)</i> The billing request's identifier.
</td>
</tr>
<tr>
<td class="highlighted">billingRequestLineId</td>
<td class="wrap"><i>(Guid)</i> The billing request's line identifier.
</td>
</tr>
<tr>
<td class="highlighted">billingDate</td>
<td class="wrap"><i>(DateTimeOffset)</i> The billing's date.
</td>
</tr>
<tr>
<td class="highlighted">accountingCustomerParty</td>
<td class="wrap"><i>(string)</i> The accounting's customer party,.
</td>
</tr>
<tr>
<td class="highlighted">salesChannel</td>
<td class="wrap"><i>(string)</i> Sales Channel.
</td>
</tr>
<tr>
<td class="highlighted">store</td>
<td class="wrap"><i>(string)</i> Store.
</td>
</tr>
<tr>
<td class="highlighted">company</td>
<td class="wrap"><i>(string)</i> The company code is the central organizational unit within the system.
</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>