-
Notifications
You must be signed in to change notification settings - Fork 6
/
openapi.yaml
9025 lines (9023 loc) · 317 KB
/
openapi.yaml
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
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Fatture in Cloud API v2 - API Reference
description: >-
Connect your software with Fatture in Cloud, the invoicing platform chosen
by more than 500.000 businesses in Italy.
The Fatture in Cloud API is based on REST, and makes possible to interact
with the user related data prior authorization via OAuth2 protocol.
contact:
name: Fatture in Cloud
url: https://www.fattureincloud.it
email: [email protected]
license:
name: MIT
url: >-
https://github.com/fattureincloud/openapi-fattureincloud/blob/master/LICENSE
version: 2.1.3
servers:
- url: https://api-v2.fattureincloud.it
tags:
- name: Archive
- name: Cashbook
- name: Clients
- name: Companies
- name: Info
- name: Issued Documents
- name: Issued e-invoices
- name: Products
- name: Receipts
- name: Received Documents
- name: Suppliers
- name: Taxes
- name: User
paths:
/user/info:
get:
tags:
- User
summary: Get User Info
responses:
'200':
$ref: '#/components/responses/GetUserInfoResponse'
'401':
description: Unauthorized.
operationId: getUserInfo
description: Gets the current user's info.
security:
- OAuth2AuthenticationCodeFlow: []
parameters: []
/user/companies:
get:
summary: List User Companies
tags:
- User
responses:
'200':
$ref: '#/components/responses/ListUserCompaniesResponse'
'401':
description: Unauthorized
operationId: listUserCompanies
description: Lists the companies controlled by the current user.
security:
- OAuth2AuthenticationCodeFlow: []
parameters: []
/c/{company_id}/company/info:
parameters:
- $ref: '#/components/parameters/company_id'
get:
summary: Get Company Info
responses:
'200':
$ref: '#/components/responses/GetCompanyInfoResponse'
'401':
description: Unauthorized.
operationId: getCompanyInfo
description: Gets the company detailed info.
security:
- OAuth2AuthenticationCodeFlow: []
tags:
- Companies
/c/{company_id}/company/plan_usage:
parameters:
- $ref: '#/components/parameters/company_id'
get:
summary: Get Company Plan Usage
responses:
'200':
$ref: '#/components/responses/GetCompanyPlanUsageResponse'
'401':
description: Unauthorized.
operationId: getCompanyPlanUsage
description: Gets the company limits usage.
parameters:
- schema:
type: string
enum:
- clients
- suppliers
- products
- documents
in: query
name: category
description: Category
required: true
security:
- OAuth2AuthenticationCodeFlow: []
tags:
- Companies
/c/{company_id}/entities/clients:
parameters:
- $ref: '#/components/parameters/company_id'
get:
summary: List Clients
tags:
- Clients
responses:
'200':
$ref: '#/components/responses/ListClientsResponse'
'401':
description: Unauthorized
operationId: listClients
description: Lists the clients.
security:
- OAuth2AuthenticationCodeFlow:
- entity.clients:r
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/fieldset'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/per_page'
- $ref: '#/components/parameters/q'
post:
summary: Create Client
operationId: createClient
responses:
'200':
$ref: '#/components/responses/CreateClientResponse'
description: Creates a new client.
security:
- OAuth2AuthenticationCodeFlow:
- entity.clients:a
parameters: []
requestBody:
content:
application/json:
schema:
$ref: ./models/requests/CreateClientRequest.yaml
examples:
example-1:
value:
data:
code: AE86
name: Avv. Maria Rossi
type: person
first_name: Maria
last_name: Rossi
contact_person: ''
vat_number: IT12345640962
tax_code: BLTGNI5ABCDA794E
address_street: Via Roma, 1
address_postal_code: '20900'
address_city: Milano
address_province: MI
address_extra: ''
country: Italia
email: [email protected]
certified_email: [email protected]
phone: '1234567890'
fax: ''
notes: ''
default_payment_terms: 1
default_payment_terms_type: standard
bank_name: Indesa
bank_iban: IT40P123456781000000123456
bank_swift_code: AK86PCT
shipping_address: Corso Magellano 4
e_invoice: true
ei_code: '111111'
default_vat:
id: 54321
value: 45
description: ''
is_disabled: false
description: The client to create
tags:
- Clients
/c/{company_id}/entities/clients/{client_id}:
parameters:
- $ref: '#/components/parameters/company_id'
- $ref: '#/components/parameters/client_id'
get:
summary: Get Client
tags:
- Clients
responses:
'200':
$ref: '#/components/responses/GetClientResponse'
'401':
description: Unauthorized
'404':
description: Not Found
operationId: getClient
security:
- OAuth2AuthenticationCodeFlow:
- entity.clients:r
description: Gets the specified client.
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/fieldset'
put:
summary: Modify Client
operationId: modifyClient
responses:
'200':
$ref: '#/components/responses/ModifyClientResponse'
'401':
description: Unauthorized
'404':
description: Not Found
description: Modifies the specified client.
security:
- OAuth2AuthenticationCodeFlow:
- entity.clients:a
parameters: []
requestBody:
content:
application/json:
schema:
$ref: ./models/requests/ModifyClientRequest.yaml
examples:
example-1:
value:
data:
code: AE86
name: Avv. Maria Rossi
type: person
first_name: Maria
last_name: Rossi
contact_person: ''
vat_number: IT12345640962
tax_code: BLTGNI5ABCDA794E
address_street: Via Roma, 1
address_postal_code: '20900'
address_city: Milano
address_province: MI
address_extra: ''
country: Italia
email: [email protected]
certified_email: [email protected]
phone: '1234567890'
fax: ''
notes: ''
default_payment_terms: 1
default_payment_terms_type: standard
bank_name: Indesa
bank_iban: IT40P123456781000000123456
bank_swift_code: AK86PCT
shipping_address: Corso Magellano 4
e_invoice: true
ei_code: '111111'
default_vat:
id: 54321
value: 45
description: ''
is_disabled: false
description: The modified Client. First level parameters are managed in delta mode.
tags:
- Clients
delete:
summary: Delete Client
operationId: deleteClient
responses:
'200':
description: Entity Removed
'401':
description: Unauthorized
'404':
description: Not Found
description: Deletes the specified client.
parameters: []
security:
- OAuth2AuthenticationCodeFlow:
- entity.clients:a
tags:
- Clients
/c/{company_id}/entities/suppliers:
parameters:
- $ref: '#/components/parameters/company_id'
get:
summary: List Suppliers
responses:
'200':
$ref: '#/components/responses/ListSuppliersResponse'
'401':
description: Unauthorized
operationId: listSuppliers
description: Lists the suppliers.
security:
- OAuth2AuthenticationCodeFlow:
- entity.suppliers:r
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/fieldset'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/per_page'
- $ref: '#/components/parameters/q'
tags:
- Suppliers
post:
summary: Create Supplier
operationId: createSupplier
responses:
'200':
$ref: '#/components/responses/CreateSupplierResponse'
description: Creates a new supplier.
security:
- OAuth2AuthenticationCodeFlow:
- entity.suppliers:a
parameters: []
requestBody:
content:
application/json:
schema:
$ref: ./models/requests/CreateSupplierRequest.yaml
examples:
example-1:
value:
data:
id: 12345
code: AE86
name: Mario Rossi S.R.L.
type: company
first_name: Mario
last_name: Rossi
contact_person: ''
vat_number: '111222333'
tax_code: '111122233'
address_street: Corso Magellano, 46
address_postal_code: '20146'
address_city: Milano
address_province: MI
address_extra: ''
country: Italia
email: [email protected]
certified_email: [email protected]
phone: '1234567890'
fax: '123456789'
notes: ''
description: The supplier to create
tags:
- Suppliers
/c/{company_id}/entities/suppliers/{supplier_id}:
parameters:
- $ref: '#/components/parameters/company_id'
- $ref: '#/components/parameters/supplier_id'
get:
summary: Get Supplier
responses:
'200':
$ref: '#/components/responses/GetSupplierResponse'
'401':
description: Unauthorized
'404':
description: Not Found
operationId: getSupplier
security:
- OAuth2AuthenticationCodeFlow:
- entity.suppliers:r
description: Gets the specified supplier.
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/fieldset'
tags:
- Suppliers
put:
summary: Modify Supplier
operationId: modifySupplier
responses:
'200':
$ref: '#/components/responses/ModifySupplierResponse'
'401':
description: Unauthorized
'404':
description: Not Found
description: Modifies the specified supplier.
security:
- OAuth2AuthenticationCodeFlow:
- entity.suppliers:a
parameters: []
requestBody:
content:
application/json:
schema:
$ref: ./models/requests/ModifySupplierRequest.yaml
examples:
example-1:
value:
data:
id: 12345
code: AE86
name: Mario Rossi S.R.L.
type: company
first_name: Mario
last_name: Rossi
contact_person: ''
vat_number: '111222333'
tax_code: '111122233'
address_street: Corso Magellano, 46
address_postal_code: '20146'
address_city: Milano
address_province: MI
address_extra: ''
country: Italia
email: [email protected]
certified_email: [email protected]
phone: '1234567890'
fax: '123456789'
notes: ''
description: >-
The modified Supplier. First level parameters are managed in delta
mode.
tags:
- Suppliers
delete:
summary: Delete Supplier
operationId: deleteSupplier
responses:
'200':
description: Entity Removed
'401':
description: Unauthorized
'404':
description: Not Found
description: Deletes the specified supplier.
parameters: []
security:
- OAuth2AuthenticationCodeFlow:
- entity.suppliers:a
tags:
- Suppliers
/c/{company_id}/products:
parameters:
- $ref: '#/components/parameters/company_id'
get:
summary: List Products
tags:
- Products
responses:
'200':
$ref: '#/components/responses/ListProductsResponse'
'401':
description: Unauthorized
operationId: listProducts
description: Lists the products.
security:
- OAuth2AuthenticationCodeFlow:
- products:r
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/fieldset'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/per_page'
- $ref: '#/components/parameters/q'
post:
summary: Create Product
operationId: createProduct
responses:
'200':
$ref: '#/components/responses/CreateProductResponse'
tags:
- Products
description: Creates a new product.
security:
- OAuth2AuthenticationCodeFlow:
- products:a
parameters: []
requestBody:
content:
application/json:
schema:
$ref: ./models/requests/CreateProductRequest.yaml
examples:
example-1:
value:
data:
name: Tavolo di marmo
code: TAVOLO003
net_price: 240
net_cost: 0
measure: ''
description: Tavolo in marmo pregiato
category: arredamento
in_stock: true
default_vat:
id: 3
value: 22
description: Non imponibile art. 123
notes: IVA non imponibile ai sensi dell'articolo 123, comma 2
is_disabled: false
description: ''
/c/{company_id}/products/{product_id}:
parameters:
- $ref: '#/components/parameters/company_id'
- $ref: '#/components/parameters/product_id'
get:
summary: Get Product
tags:
- Products
responses:
'200':
$ref: '#/components/responses/GetProductResponse'
'401':
description: Unauthorized
'404':
description: Not Found
operationId: getProduct
description: Gets the specified product.
security:
- OAuth2AuthenticationCodeFlow:
- products:r
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/fieldset'
put:
summary: Modify Product
operationId: modifyProduct
responses:
'200':
$ref: '#/components/responses/ModifyProductResponse'
'401':
description: Unauthorized
'404':
description: Not Found
description: Modifies the specified product.
security:
- OAuth2AuthenticationCodeFlow:
- products:a
parameters: []
requestBody:
content:
application/json:
schema:
$ref: ./models/requests/ModifyProductRequest.yaml
examples:
example-1:
value:
data:
name: Tavolo di marmo
code: TAVOLO003
net_price: 240
net_cost: 0
measure: ''
description: Tavolo in marmo pregiato
category: arredamento
in_stock: true
default_vat:
id: 3
value: 22
description: Non imponibile art. 123
notes: IVA non imponibile ai sensi dell'articolo 123, comma 2
is_disabled: false
description: Modified product details.
tags:
- Products
delete:
summary: Delete Product
operationId: deleteProduct
responses:
'200':
description: Product removed.
'401':
description: Unauthorized
'404':
description: Not Found
description: Deletes the specified product.
security:
- OAuth2AuthenticationCodeFlow:
- products:a
parameters: []
tags:
- Products
/c/{company_id}/issued_documents:
parameters:
- $ref: '#/components/parameters/company_id'
get:
summary: List Issued Documents
tags:
- Issued Documents
responses:
'200':
$ref: '#/components/responses/ListIssuedDocumentsResponse'
'401':
description: Unauthorized
'404':
description: Not Found
operationId: listIssuedDocuments
description: Lists the issued documents.
security:
- OAuth2AuthenticationCodeFlow:
- issued_documents.invoices:r
- issued_documents.credit_notes:r
- issued_documents.receipts:r
- issued_documents.orders:r
- issued_documents.quotes:r
- issued_documents.proformas:r
- issued_documents.delivery_notes:r
parameters:
- $ref: '#/components/parameters/issued_document_type'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/fieldset'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/per_page'
- $ref: '#/components/parameters/q'
- schema:
type: integer
enum:
- 0
- 1
in: query
name: inclusive
description: (Only for type = delivery_notes) Include invoices delivery notes.
post:
summary: Create Issued Document
operationId: createIssuedDocument
responses:
'200':
$ref: '#/components/responses/CreateIssuedDocumentResponse'
'401':
description: Unauthorized
tags:
- Issued Documents
description: Creates a new document.
security:
- OAuth2AuthenticationCodeFlow:
- issued_documents.invoices:a
- issued_documents.credit_notes:a
- issued_documents.receipts:a
- issued_documents.orders:a
- issued_documents.quotes:a
- issued_documents.proformas:a
- issued_documents.delivery_notes:a
parameters: []
requestBody:
content:
application/json:
schema:
$ref: ./models/requests/CreateIssuedDocumentRequest.yaml
examples:
example-1:
value:
data:
type: receipt
numeration: rec123
subject: ''
visible_subject: ''
amount_net: 68.18
amount_vat: 6.82
amount_due_discount: 0
entity:
id: 54321
name: Mary Red S.r.L.
vat_number: IT05432181211
tax_code: IT05432181211
address_street: Via Italia, 66
address_postal_code: '20900'
address_city: Milano
address_province: MI
address_extra: ''
country: Italia
certified_email: [email protected]
ei_code: ABCXCR1
date: '2021-08-20'
number: 1
next_due_date: '2021-12-31'
attachment_token: ypbqqe4u8w8bdabcd5fd5b1a
items_list:
- product_id: 333
code: SG3
name: Soggiorno
measure: ''
net_price: 68.18182
category: ''
id: 277875565
gross_price: 75
apply_withholding_taxes: true
discount: 0
discount_highlight: false
in_dn: false
qty: 1
vat:
id: 3
value: 10
description: ''
stock: true
description: ''
not_taxable: false
payments_list:
- amount: 75
due_date: '2020-08-23'
id: 444
payment_terms:
days: 0
type: standard
status: not_paid
payment_method:
id: 4
description: The Issued Document
/c/{company_id}/issued_documents/{document_id}:
parameters:
- $ref: '#/components/parameters/company_id'
- $ref: '#/components/parameters/document_id'
get:
summary: Get Issued Document
tags:
- Issued Documents
responses:
'200':
$ref: '#/components/responses/GetIssuedDocumentResponse'
'401':
description: Unauthorized
'404':
description: Not Found
operationId: getIssuedDocument
description: |
Gets the specified document.
security:
- OAuth2AuthenticationCodeFlow:
- issued_documents.invoices:r
- issued_documents.credit_notes:r
- issued_documents.receipts:r
- issued_documents.orders:r
- issued_documents.quotes:r
- issued_documents.proformas:r
- issued_documents.delivery_notes:r
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/fieldset'
put:
summary: Modify Issued Document
operationId: modifyIssuedDocument
responses:
'200':
$ref: '#/components/responses/ModifyIssuedDocumentResponse'
'401':
description: Unauthorized
'404':
description: Not Found
description: Modifies the specified document.
security:
- OAuth2AuthenticationCodeFlow:
- issued_documents.invoices:a
- issued_documents.credit_notes:a
- issued_documents.receipts:a
- issued_documents.orders:a
- issued_documents.quotes:a
- issued_documents.proformas:a
- issued_documents.delivery_notes:a
parameters: []
requestBody:
content:
application/json:
schema:
$ref: ./models/requests/ModifyIssuedDocumentRequest.yaml
examples:
example-1:
value:
data:
type: receipt
numeration: rec123
subject: ''
visible_subject: ''
amount_net: 68.18
amount_vat: 6.82
amount_due_discount: 0
entity:
id: 54321
name: Mary Red S.r.L.
vat_number: IT05432181211
tax_code: IT05432181211
address_street: Via Italia, 66
address_postal_code: '20900'
address_city: Milano
address_province: MI
address_extra: ''
country: Italia
certified_email: [email protected]
ei_code: ABCXCR1
date: '2021-08-20'
number: 1
next_due_date: '2021-12-31'
attachment_token: ypbqqe4u8w8bdabcd5fd5b1a
items_list:
- product_id: 333
code: SG3
name: Soggiorno
measure: ''
net_price: 68.18182
category: ''
id: 277875565
gross_price: 75
apply_withholding_taxes: true
discount: 0
discount_highlight: false
in_dn: false
qty: 1
vat:
id: 3
value: 10
description: ''
stock: true
description: ''
not_taxable: false
payments_list:
- amount: 75
due_date: '2020-08-23'
id: 444
payment_terms:
days: 0
type: standard
status: not_paid
description: The modified document
tags:
- Issued Documents
delete:
summary: Delete Issued Document
operationId: deleteIssuedDocument
responses:
'200':
description: Document removed
'401':
description: Unauthorized
'404':
description: Not Found
description: Deletes the specified document.
security:
- OAuth2AuthenticationCodeFlow:
- issued_documents.invoices:a
- issued_documents.credit_notes:a
- issued_documents.receipts:a
- issued_documents.orders:a
- issued_documents.quotes:a
- issued_documents.proformas:a
- issued_documents.delivery_notes:a
parameters: []
tags:
- Issued Documents
/c/{company_id}/issued_documents/totals:
parameters:
- $ref: '#/components/parameters/company_id'
post:
summary: Get New Issued Document Totals
operationId: getNewIssuedDocumentTotals
responses:
'200':
$ref: '#/components/responses/GetNewIssuedDocumentTotalsResponse'
'401':
description: Unauthorized
description: Returns the totals for a new document.
tags:
- Issued Documents
security:
- OAuth2AuthenticationCodeFlow: []
parameters: []
requestBody:
content:
application/json:
schema:
$ref: ./models/requests/GetNewIssuedDocumentTotalsRequest.yaml
examples:
example-1:
value:
data:
id: 12345
type: receipt
year: 2021
numeration: rec123
subject: ''
visible_subject: ''
rc_center: ''
stamp_duty: 0
use_gross_prices: false
delivery_note: false
accompanying_invoice: false
amount_net: 68.18
amount_vat: 6.82
amount_due_discount: 0
amount_rivalsa: 0
amount_cassa: 0
amount_withholding_tax: 0
amount_other_withholding_tax: 0
h_margins: 15
v_margins: 16
show_payment_method: false
show_payments: true
show_totals: all
show_notification_button: false
is_marked: false
created_at: '2021-08-13 09:30:20'
updated_at: '2021-08-23 05:34:20'
entity:
id: 54321
name: Mary Red S.r.L.
vat_number: IT05432181211
tax_code: IT05432181211
address_street: Via Italia, 66
address_postal_code: '20900'
address_city: Milano
address_province: MI
address_extra: ''
country: Italia
certified_email: [email protected]
ei_code: ABCXCR1
date: '2021-08-20'
number: 1
currency:
id: EUR
exchange_rate: '1.00000'
symbol: €
language:
code: it
name: Italiano
notes: ''
rivalsa: 0
cassa: 0
withholding_tax: 0
withholding_tax_taxable: 100
other_withholding_tax: 0
payment_method:
id: 4
name: Credit card
use_split_payment: false
items_list:
- product_id: 5432
code: SG3
name: Soggiorno
measure: ''
net_price: 68.18182
category: ''
id: 277876033
apply_withholding_taxes: true
discount: 0
discount_highlight: false
in_dn: false
qty: 1
vat:
id: 3
value: 10
description: ''
stock: false
description: ''
not_taxable: false
payments_list:
- amount: 75
due_date: '2020-08-23'
id: 69078013
payment_terms:
days: 0
type: standard
status: not_paid
attachment_url: kdijrnf893hnwkfk45f50f.pdf
next_due_date: '2020-08-23'
template:
id: 2821
name: Light Smoke
url: y12h45rn9yf2mse0p43t7ec90vr.pdf
/c/{company_id}/issued_documents/{document_id}/totals:
parameters:
- $ref: '#/components/parameters/company_id'
- $ref: '#/components/parameters/document_id'
post:
summary: Get Existing Issued Document Totals
operationId: getExistingIssuedDocumentTotals
responses:
'200':
$ref: '#/components/responses/GetExistingIssuedDocumentTotalsResponse'
'401':
description: Unauthorized
'404':
description: Not Found
tags:
- Issued Documents
description: Returns the totals for a specified document.
security:
- OAuth2AuthenticationCodeFlow: []
parameters: []
requestBody:
content:
application/json:
schema:
$ref: ./models/requests/GetExistingIssuedDocumentTotalsRequest.yaml
examples:
example-1:
value:
data: