-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathaccountsreceivable.processopenitems.html
More file actions
806 lines (730 loc) · 42.9 KB
/
accountsreceivable.processopenitems.html
File metadata and controls
806 lines (730 loc) · 42.9 KB
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
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
<!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 - Accounts Receivable | Create Receipt</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 id="current-menu-item" class="menu-item " href="accountsreceivable.html">
Accounts Receivable
</a>
<a class="menu-subitem menu-item-selected" href="accountsreceivable.processopenitems.html">
Create Receipt
</a>
<a class="menu-subitem " href="accountsreceivable.receipts.html">
Receipt
</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 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>Accounts Receivable | Create Receipt</h1>
<p>
Service to allow picking of open items to process for receipt purpose. The monetary values must be specified using the party default currency.
</p>
<h2>Overview</h2>
<br/>
<table>
<tbody>
<tr>
<td>URL</td>
<td class="breakword url-cell">api/{tenantKey}/{orgKey}/accountsReceivable/processOpenItems <i title="Copy to clipboard" class="copy-clipboard fa fa-clipboard clipboard-url" aria-hidden="true" data-clipboard-target="#copy-accountsreceivable-processopenitems"></i></td>
<div class="hidden-copylink" id="copy-accountsreceivable-processopenitems">api/{tenantKey}/{orgKey}/accountsReceivable/processOpenItems</div>
</tr>
<tr>
<td>Methods Supported</td>
<td><a href="#POST">POST</a>, <a href="#GET">GET</a></td>
</tr>
</tbody>
</table>
<h2>All Operations</h2>
<p>
This service includes the following operations:
</p>
<ul>
<li>
POST:
<ul>
<li><a href="#46a12952-b9b4-4636-b8f1-c1c0a7e16e1a">POST Generate Receipt</a></li>
<li><a href="#8a2e4aa2-dd64-4503-831a-d792a9a0fecf">POST Create Receipt</a></li>
</ul>
</li>
<li>
GET:
<ul>
<li><a href="#1bd16dba-e060-4642-9ae0-b68cefa011a3">GET Create Receipt</a></li>
</ul>
</li>
</ul>
<h2>All Resources</h2>
<p>
This service uses the following resources:
</p>
<ul>
<li><a href="#ApiOpenAccountPosting">ApiOpenAccountPosting</a></li>
<li><a href="#OpenAccountPosting">OpenAccountPosting</a></li>
<li><a href="#OpenAccountPostingLine">OpenAccountPostingLine</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="1bd16dba-e060-4642-9ae0-b68cefa011a3"></a>
<h3>GET Create Receipt <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-1bd16dba-e060-4642-9ae0-b68cefa011a3"></i></h3>
<div class="hidden-copylink" id="copy-1bd16dba-e060-4642-9ae0-b68cefa011a3"><a href="#1bd16dba-e060-4642-9ae0-b68cefa011a3">GET Create Receipt</a></div>
<p class="operation-description">Returns the list of entity records that can be processed by the 'Receipts' 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>
<tr>
<td class="highlighted">company</td>
<td><i>(string)</i> The company code is the central organizational unit within the system.</td>
</tr>
<tr>
<td class="highlighted">documentType</td>
<td><i>(string)</i> Defines the receipt's purpose. Distinguishes the business transactions to be posted. The default receipt type is defined in the sales setup configuration setting.</td>
</tr>
<tr>
<td class="highlighted">documentDate</td>
<td><i>(DateTime)</i> The date when the document is issued.</td>
</tr>
<tr>
<td class="highlighted">postingDate</td>
<td><i>(DateTime)</i> Posting Date.</td>
</tr>
<tr>
<td class="highlighted">financialAccount</td>
<td><i>(string)</i> Financial Account.</td>
</tr>
<tr>
<td class="highlighted">cashFlowItem</td>
<td><i>(string)</i> Cash Flow Item.</td>
</tr>
<tr>
<td class="highlighted">party</td>
<td><i>(string)</i> The customer designated in the account posting as the party to whom should be sent the receipt. It may or may not be the party to whom the goods or services were delivered.</td>
</tr>
<tr>
<td class="highlighted">currency</td>
<td><i>(string)</i> 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">exchangeRate</td>
<td><i>(decimal)</i> The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency.</td>
</tr>
<tr>
<td class="highlighted">paymentMethod</td>
<td><i>(string)</i> Payment Method.</td>
</tr>
<tr>
<td class="highlighted">isCheckPaymentMethod</td>
<td><i>(bool)</i> Is Check Payment Method.</td>
</tr>
</tbody>
</table>
<br />
<p>The following elements are optional:</p>
<table>
<tbody>
<tr>
<td class="highlighted">note</td>
<td><i>(string)</i> Reference This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">checkNumber</td>
<td><i>(string)</i> Check Number This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">checkDate</td>
<td><i>(DateTime?)</i> Check Date This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">checkBank</td>
<td><i>(string)</i> Check Bank This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">checkBranch</td>
<td><i>(string)</i> Check Branch This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">checkAccount</td>
<td><i>(string)</i> Check Account This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">dueDateFromFilter</td>
<td><i>(DateTime?)</i> The accounting posting starting due date. Ignored if not set, is used to filter the due date. Only account postings with due date greater than or equal to this value will be displayed. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">dueDateUntilFilter</td>
<td><i>(DateTime?)</i> The accounting posting end due date. Ignored if not set, is used to filter the due date. Only account postings with due date less than or equal to this value will be displayed. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">paymentMethodFilter</td>
<td><i>(string)</i> Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">sourceDocFilter</td>
<td><i>(string)</i> The original document to be settled. The source documents is usually an invoice but other documents can be included on a receitp (ex: Credit or Debit Notes). Internally determined. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">total</td>
<td><i>(decimal?)</i> Document total. Internally calculated. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">serie</td>
<td><i>(string)</i> Serie This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">discount</td>
<td><i>(decimal?)</i> Document total discount. Internally calculated. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">withholded</td>
<td><i>(decimal?)</i> Document total withholded value. Internally calculated. This is a query string parameter.</td>
</tr>
<tr>
<td class="highlighted">gross</td>
<td><i>(decimal?)</i> Document gross value. Internally calculated. 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="#OpenAccountPostingLine">OpenAccountPostingLine.</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-1bd16dba-e060-4642-9ae0-b68cefa011a3">api/{tenantKey}/{orgKey}/accountsReceivable/processOpenItems/{pageIndex}/{pageSize}?note={note}&checkNumber={checkNumber}&checkDate={checkDate}&checkBank={checkBank}&checkBranch={checkBranch}&checkAccount={checkAccount}&dueDateFromFilter={dueDateFromFilter}&dueDateUntilFilter={dueDateUntilFilter}&paymentMethodFilter={paymentMethodFilter}&sourceDocFilter={sourceDocFilter}&total={total}&serie={serie}&discount={discount}&withholded={withholded}&gross={gross}</div>
<div class="resource-url">
<div class="inner-resource-url"><div>GET /accountsReceivable/processOpenItems/{pageIndex}/{pageSize}?note={note}&checkNumber={checkNumber}&checkDate={checkDate}&checkBank={checkBank}&checkBranch={checkBranch}&checkAccount={checkAccount}&dueDateFromFilter={dueDateFromFilter}&dueDateUntilFilter={dueDateUntilFilter}&paymentMethodFilter={paymentMethodFilter}&sourceDocFilter={sourceDocFilter}&total={total}&serie={serie}&discount={discount}&withholded={withholded}&gross={gross}</div></div>
<div class="copy-clipboard clipboard-example" data-clipboard-target="#copy2-1bd16dba-e060-4642-9ae0-b68cefa011a3"><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="46a12952-b9b4-4636-b8f1-c1c0a7e16e1a"></a>
<h3>POST Generate Receipt <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-46a12952-b9b4-4636-b8f1-c1c0a7e16e1a"></i></h3>
<div class="hidden-copylink" id="copy-46a12952-b9b4-4636-b8f1-c1c0a7e16e1a"><a href="#46a12952-b9b4-4636-b8f1-c1c0a7e16e1a">POST Generate Receipt</a></div>
<p class="operation-description">Operation that creates a new receipt using the specifed information while processing the specified entity records.</p>
<p>The following elements are required:</p>
<table>
<tbody>
<tr>
<td class="highlighted">apiOpenAccountPosting</td>
<td><i>(ApiOpenAccountPosting)</i> ApiOpenAccountPosting.</td>
</tr>
</tbody>
</table>
<br />
<p>Response:</p>
<table>
<tbody>
<tr>
<td>When successful, the response body contains a unique identifier.</td>
</tr>
</tbody>
</table>
</div>
<div class="content-section-col2">
<p>Resource URL:</p>
<div class="hidden-copylink" id="copy2-46a12952-b9b4-4636-b8f1-c1c0a7e16e1a">api/{tenantKey}/{orgKey}/accountsReceivable/processOpenItems/generateReceipt</div>
<div class="resource-url">
<div class="inner-resource-url"><div>POST /accountsReceivable/processOpenItems/generateReceipt</div></div>
<div class="copy-clipboard clipboard-example" data-clipboard-target="#copy2-46a12952-b9b4-4636-b8f1-c1c0a7e16e1a"><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="8a2e4aa2-dd64-4503-831a-d792a9a0fecf"></a>
<h3>POST Create Receipt <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-8a2e4aa2-dd64-4503-831a-d792a9a0fecf"></i></h3>
<div class="hidden-copylink" id="copy-8a2e4aa2-dd64-4503-831a-d792a9a0fecf"><a href="#8a2e4aa2-dd64-4503-831a-d792a9a0fecf">POST Create Receipt</a></div>
<p class="operation-description">Instructs the 'Receipts' 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>(OpenAccountPostingLine)</i> List of the entity records that should be processed.<br/>See <a href="#OpenAccountPostingLine">OpenAccountPostingLine.</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-8a2e4aa2-dd64-4503-831a-d792a9a0fecf">api/{tenantKey}/{orgKey}/accountsReceivable/processOpenItems/{companyKey}</div>
<div class="resource-url">
<div class="inner-resource-url"><div>POST /accountsReceivable/processOpenItems/{companyKey}</div></div>
<div class="copy-clipboard clipboard-example" data-clipboard-target="#copy2-8a2e4aa2-dd64-4503-831a-d792a9a0fecf"><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="ApiOpenAccountPosting"></a>
<h4>ApiOpenAccountPosting <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-ApiOpenAccountPosting"></i></h4>
<div class="hidden-copylink" id="copy-ApiOpenAccountPosting"><a href="#ApiOpenAccountPosting">ApiOpenAccountPosting</a></div>
<p>The following elements are required:</p>
<table>
<tbody>
<tr>
<td class="highlighted">company</td>
<td class="wrap"><i>(string)</i> Company.
</td>
</tr>
<tr>
<td class="highlighted">documentType</td>
<td class="wrap"><i>(string)</i> Receipt Type.
</td>
</tr>
<tr>
<td class="highlighted">documentDate</td>
<td class="wrap"><i>(DateTime)</i> Document Date.
</td>
</tr>
<tr>
<td class="highlighted">postingDate</td>
<td class="wrap"><i>(DateTime)</i> Posting Date.
</td>
</tr>
<tr>
<td class="highlighted">financialAccount</td>
<td class="wrap"><i>(string)</i> Financial Account.
</td>
</tr>
<tr>
<td class="highlighted">cashFlowItem</td>
<td class="wrap"><i>(string)</i> Cash Flow Item.
</td>
</tr>
<tr>
<td class="highlighted">party</td>
<td class="wrap"><i>(string)</i> Party.
</td>
</tr>
<tr>
<td class="highlighted">currency</td>
<td class="wrap"><i>(string)</i> Currency.
</td>
</tr>
<tr>
<td class="highlighted">exchangeRate</td>
<td class="wrap"><i>(decimal)</i> The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
</td>
</tr>
<tr>
<td class="highlighted">paymentMethod</td>
<td class="wrap"><i>(string)</i> Payment Method.
</td>
</tr>
</tbody>
</table>
<p>The following elements are optional:</p>
<table>
<tbody>
<tr>
<td class="highlighted">note</td>
<td class="wrap"><i>(string)</i> Reference.
</td>
</tr>
<tr>
<td class="highlighted">checkNumber</td>
<td class="wrap"><i>(string)</i> Check Number.
</td>
</tr>
<tr>
<td class="highlighted">checkDate</td>
<td class="wrap"><i>(DateTime)</i> Check Date.
</td>
</tr>
<tr>
<td class="highlighted">checkBank</td>
<td class="wrap"><i>(string)</i> Check Bank.
</td>
</tr>
<tr>
<td class="highlighted">checkBranch</td>
<td class="wrap"><i>(string)</i> Check Branch.
</td>
</tr>
<tr>
<td class="highlighted">checkAccount</td>
<td class="wrap"><i>(string)</i> Check Account.
</td>
</tr>
<tr>
<td class="highlighted">serie</td>
<td class="wrap"><i>(string)</i> Serie.
</td>
</tr>
</tbody>
</table>
<br />
<br />
<a class="anchor" name="OpenAccountPosting"></a>
<h4>OpenAccountPosting <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-OpenAccountPosting"></i></h4>
<div class="hidden-copylink" id="copy-OpenAccountPosting"><a href="#OpenAccountPosting">OpenAccountPosting</a></div>
<p>The following elements are required:</p>
<table>
<tbody>
<tr>
<td class="highlighted">selectedCount</td>
<td class="wrap"><i>(int)</i> Number of lines selected. Internally calculated.
</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>
<tr>
<td class="highlighted">documentType</td>
<td class="wrap"><i>(string)</i> Defines the receipt's purpose. Distinguishes the business transactions to be posted. The default receipt type is defined in the sales setup configuration setting.
</td>
</tr>
<tr>
<td class="highlighted">documentDate</td>
<td class="wrap"><i>(DateTime)</i> The date when the document is issued.
</td>
</tr>
<tr>
<td class="highlighted">postingDate</td>
<td class="wrap"><i>(DateTime)</i> Posting Date.
</td>
</tr>
<tr>
<td class="highlighted">financialAccount</td>
<td class="wrap"><i>(string)</i> Financial Account.
</td>
</tr>
<tr>
<td class="highlighted">cashFlowItem</td>
<td class="wrap"><i>(string)</i> Cash Flow Item.
</td>
</tr>
<tr>
<td class="highlighted">party</td>
<td class="wrap"><i>(string)</i> The customer designated in the account posting as the party to whom should be sent the receipt. It may or may not be the party to whom the goods or services were delivered.
</td>
</tr>
<tr>
<td class="highlighted">currency</td>
<td class="wrap"><i>(string)</i> 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">exchangeRate</td>
<td class="wrap"><i>(decimal)</i> The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's base currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
</td>
</tr>
<tr>
<td class="highlighted">paymentMethod</td>
<td class="wrap"><i>(string)</i> Payment Method.
</td>
</tr>
<tr>
<td class="highlighted">isCheckPaymentMethod</td>
<td class="wrap"><i>(bool)</i> Is Check Payment Method.
</td>
</tr>
</tbody>
</table>
<p>The following elements are optional:</p>
<table>
<tbody>
<tr>
<td class="highlighted">note</td>
<td class="wrap"><i>(string)</i> Reference.
</td>
</tr>
<tr>
<td class="highlighted">checkNumber</td>
<td class="wrap"><i>(string)</i> Check Number.
</td>
</tr>
<tr>
<td class="highlighted">checkDate</td>
<td class="wrap"><i>(DateTime)</i> Check Date.
</td>
</tr>
<tr>
<td class="highlighted">checkBank</td>
<td class="wrap"><i>(string)</i> Check Bank.
</td>
</tr>
<tr>
<td class="highlighted">checkBranch</td>
<td class="wrap"><i>(string)</i> Check Branch.
</td>
</tr>
<tr>
<td class="highlighted">checkAccount</td>
<td class="wrap"><i>(string)</i> Check Account.
</td>
</tr>
<tr>
<td class="highlighted">dueDateFromFilter</td>
<td class="wrap"><i>(DateTime)</i> The accounting posting starting due date. Ignored if not set, is used to filter the due date. Only account postings with due date greater than or equal to this value will be displayed.
</td>
</tr>
<tr>
<td class="highlighted">dueDateUntilFilter</td>
<td class="wrap"><i>(DateTime)</i> The accounting posting end due date. Ignored if not set, is used to filter the due date. Only account postings with due date less than or equal to this value will be displayed.
</td>
</tr>
<tr>
<td class="highlighted">paymentMethodFilter</td>
<td class="wrap"><i>(string)</i> Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
</td>
</tr>
<tr>
<td class="highlighted">sourceDocFilter</td>
<td class="wrap"><i>(string)</i> The original document to be settled. The source documents is usually an invoice but other documents can be included on a receitp (ex: Credit or Debit Notes). Internally determined.
</td>
</tr>
<tr>
<td class="highlighted">total</td>
<td class="wrap"><i>(decimal)</i> Document total. Internally calculated.
</td>
</tr>
<tr>
<td class="highlighted">serie</td>
<td class="wrap"><i>(string)</i> Serie.
</td>
</tr>
<tr>
<td class="highlighted">discount</td>
<td class="wrap"><i>(decimal)</i> Document total discount. Internally calculated.
</td>
</tr>
<tr>
<td class="highlighted">withholded</td>
<td class="wrap"><i>(decimal)</i> Document total withholded value. Internally calculated.
</td>
</tr>
<tr>
<td class="highlighted">gross</td>
<td class="wrap"><i>(decimal)</i> Document gross value. Internally calculated.
</td>
</tr>
</tbody>
</table>
<br />
<br />
<a class="anchor" name="OpenAccountPostingLine"></a>
<h4>OpenAccountPostingLine <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-OpenAccountPostingLine"></i></h4>
<div class="hidden-copylink" id="copy-OpenAccountPostingLine"><a href="#OpenAccountPostingLine">OpenAccountPostingLine</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 to be included on the receipt.
</td>
</tr>
</tbody>
</table>
<p>The following elements are optional:</p>
<table>
<tbody>
<tr>
<td class="highlighted">sourceDoc</td>
<td class="wrap"><i>(string)</i> The original document to be settled. The source documents is usually an invoice but other documents can be included on a receitp (ex: Credit or Debit Notes). Internally determined.
</td>
</tr>
<tr>
<td class="highlighted">dueDate</td>
<td class="wrap"><i>(DateTime)</i> The due date of the original document to be settled. Internally determined.
</td>
</tr>
<tr>
<td class="highlighted">sourceDocPaymentMethod</td>
<td class="wrap"><i>(string)</i> Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
</td>
</tr>
<tr>
<td class="highlighted">amount</td>
<td class="wrap"><i>(decimal)</i> It indicates the total amount of the original document in the receipt currency. Internally determined.
</td>
</tr>
<tr>
<td class="highlighted">open</td>
<td class="wrap"><i>(decimal)</i> It indicates the current open amount of the original document in the receipt currency. One original document document can be partially settled over multiple receipts. Internally determined.
</td>
</tr>
<tr>
<td class="highlighted">settled</td>
<td class="wrap"><i>(decimal)</i> It indicates the amount (in the receipt curreny) that is settled by this receipt. This amount is deducted to the original open amount. One original document document can be partially settled over multiple receipts.
</td>
</tr>
<tr>
<td class="highlighted">discount</td>
<td class="wrap"><i>(decimal)</i> It indicates the discount amount (in the receipt curreny) that is settled by this receipt. This discount amount is deducted to the setteled amount. One original document document can be partially settled over multiple receipts.
</td>
</tr>
<tr>
<td class="highlighted">withholded</td>
<td class="wrap"><i>(decimal)</i> It indicates the withholding tax amount (in the receipt curreny) that is settled by this receipt. In some countries, define the tax amount deducted at the beginning of the payment flow and paid to the tax authorities on behalf of the person / company subject to that tax. This amount is deducted to the original open amount.
</td>
</tr>
<tr>
<td class="highlighted">accountPostingId</td>
<td class="wrap"><i>(Guid)</i> The unique identifier of then account posting for the line. Internally determined.
</td>
</tr>
<tr>
<td class="highlighted">sourceDocExchangeRate</td>
<td class="wrap"><i>(decimal)</i> The price of the document's currency expressed in the company's base currency. In other words, the rate at which the document's currency can be exchanged for the company's currency. The default is inferred using the defined exchange rates on the system for the document date and currency.
</td>
</tr>
<tr>
<td class="highlighted">natureId</td>
<td class="wrap"><i>(Guid)</i> The unique identifier of the original document nature (Debit or Credit). Internally determined.
</td>
</tr>
<tr>
<td class="highlighted">sourceDocId</td>
<td class="wrap"><i>(Guid)</i> The unique identifier of the original document to be settled. The source documents is usually an invoice but other documents can be included on a receitp (ex: Credit or Debit Notes). Internally determined.
</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>