n8n-nodes-quipu 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/LICENSE.md +18 -0
  2. package/README.md +176 -0
  3. package/dist/credentials/ExampleCredentialsApi.credentials.d.ts +8 -0
  4. package/dist/credentials/ExampleCredentialsApi.credentials.js +46 -0
  5. package/dist/credentials/ExampleCredentialsApi.credentials.js.map +1 -0
  6. package/dist/credentials/HttpBinApi.credentials.d.ts +9 -0
  7. package/dist/credentials/HttpBinApi.credentials.js +43 -0
  8. package/dist/credentials/HttpBinApi.credentials.js.map +1 -0
  9. package/dist/credentials/QuipuApi.credentials.d.ts +9 -0
  10. package/dist/credentials/QuipuApi.credentials.js +75 -0
  11. package/dist/credentials/QuipuApi.credentials.js.map +1 -0
  12. package/dist/nodes/ExampleNode/ExampleNode.node.d.ts +5 -0
  13. package/dist/nodes/ExampleNode/ExampleNode.node.js +63 -0
  14. package/dist/nodes/ExampleNode/ExampleNode.node.js.map +1 -0
  15. package/dist/nodes/HttpBin/HttpBin.node.d.ts +4 -0
  16. package/dist/nodes/HttpBin/HttpBin.node.js +55 -0
  17. package/dist/nodes/HttpBin/HttpBin.node.js.map +1 -0
  18. package/dist/nodes/HttpBin/HttpBin.node.json +18 -0
  19. package/dist/nodes/HttpBin/HttpVerbDescription.d.ts +3 -0
  20. package/dist/nodes/HttpBin/HttpVerbDescription.js +234 -0
  21. package/dist/nodes/HttpBin/HttpVerbDescription.js.map +1 -0
  22. package/dist/nodes/HttpBin/httpbin.svg +18 -0
  23. package/dist/nodes/Quipu/HttpBin.node.d.ts +4 -0
  24. package/dist/nodes/Quipu/HttpBin.node.js +76 -0
  25. package/dist/nodes/Quipu/HttpBin.node.js.map +1 -0
  26. package/dist/nodes/Quipu/HttpBin.node.json +19 -0
  27. package/dist/nodes/Quipu/HttpVerbDescription.d.ts +3 -0
  28. package/dist/nodes/Quipu/HttpVerbDescription.js +234 -0
  29. package/dist/nodes/Quipu/HttpVerbDescription.js.map +1 -0
  30. package/dist/nodes/Quipu/Quipu.node.d.ts +4 -0
  31. package/dist/nodes/Quipu/Quipu.node.js +76 -0
  32. package/dist/nodes/Quipu/Quipu.node.js.map +1 -0
  33. package/dist/nodes/Quipu/Quipu.node.json +19 -0
  34. package/dist/nodes/Quipu/httpbin.svg +18 -0
  35. package/dist/nodes/Quipu/openapi.json +3147 -0
  36. package/dist/nodes/Quipu/quipu.svg +18 -0
  37. package/dist/package.json +57 -0
  38. package/dist/tsconfig.tsbuildinfo +1 -0
  39. package/index.js +0 -0
  40. package/package.json +56 -0
@@ -0,0 +1,3147 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "Quipu API",
5
+ "description": "Quipu is an invoice and taxes software as a service for freelances and companies.\n\nTo use our API you need to sign up in our software. You will have 15 days to try it for free.\nIf you need more time, contact our support team to extend the trial period.\n\nFor more information about our API, libraries and other applications, visit: https://getquipu.com/en/integrations.",
6
+ "version": "1.0.0"
7
+ },
8
+ "servers": [
9
+ {
10
+ "url": "https://getquipu.com",
11
+ "description": "Production server"
12
+ }
13
+ ],
14
+ "security": [
15
+ {
16
+ "oauth2": []
17
+ }
18
+ ],
19
+ "paths": {
20
+ "/oauth/token": {
21
+ "post": {
22
+ "summary": "Get an access token",
23
+ "operationId": "getAccessToken",
24
+ "tags": ["Authentication"],
25
+ "security": [],
26
+ "requestBody": {
27
+ "required": true,
28
+ "content": {
29
+ "application/x-www-form-urlencoded": {
30
+ "schema": {
31
+ "type": "object",
32
+ "required": ["grant_type", "scope"],
33
+ "properties": {
34
+ "grant_type": {
35
+ "type": "string",
36
+ "enum": ["client_credentials"]
37
+ },
38
+ "scope": {
39
+ "type": "string",
40
+ "example": "ecommerce"
41
+ }
42
+ }
43
+ }
44
+ }
45
+ }
46
+ },
47
+ "responses": {
48
+ "200": {
49
+ "description": "Successfully authenticated",
50
+ "content": {
51
+ "application/json": {
52
+ "schema": {
53
+ "$ref": "#/components/schemas/TokenResponse"
54
+ }
55
+ }
56
+ }
57
+ }
58
+ }
59
+ }
60
+ },
61
+ "/contacts": {
62
+ "get": {
63
+ "summary": "Retrieve all contacts",
64
+ "operationId": "getContacts",
65
+ "tags": ["Contacts"],
66
+ "parameters": [
67
+ {
68
+ "$ref": "#/components/parameters/FilterQ"
69
+ },
70
+ {
71
+ "$ref": "#/components/parameters/FilterKind"
72
+ },
73
+ {
74
+ "$ref": "#/components/parameters/FilterTaxId"
75
+ },
76
+ {
77
+ "$ref": "#/components/parameters/FilterCountry"
78
+ },
79
+ {
80
+ "$ref": "#/components/parameters/FilterEmail"
81
+ },
82
+ {
83
+ "$ref": "#/components/parameters/SortParameter"
84
+ },
85
+ {
86
+ "$ref": "#/components/parameters/PageNumber"
87
+ }
88
+ ],
89
+ "responses": {
90
+ "200": {
91
+ "description": "Successful response",
92
+ "content": {
93
+ "application/vnd.quipu.v1+json": {
94
+ "schema": {
95
+ "$ref": "#/components/schemas/ContactCollection"
96
+ }
97
+ }
98
+ }
99
+ }
100
+ }
101
+ },
102
+ "post": {
103
+ "summary": "Create a new contact",
104
+ "operationId": "createContact",
105
+ "tags": ["Contacts"],
106
+ "requestBody": {
107
+ "required": true,
108
+ "content": {
109
+ "application/vnd.quipu.v1+json": {
110
+ "schema": {
111
+ "$ref": "#/components/schemas/ContactCreate"
112
+ }
113
+ }
114
+ }
115
+ },
116
+ "responses": {
117
+ "204": {
118
+ "description": "Contact created successfully",
119
+ "content": {
120
+ "application/vnd.quipu.v1+json": {
121
+ "schema": {
122
+ "$ref": "#/components/schemas/ContactResponse"
123
+ }
124
+ }
125
+ }
126
+ },
127
+ "422": {
128
+ "description": "Validation error",
129
+ "content": {
130
+ "application/vnd.quipu.v1+json": {
131
+ "schema": {
132
+ "$ref": "#/components/schemas/ErrorResponse"
133
+ }
134
+ }
135
+ }
136
+ }
137
+ }
138
+ }
139
+ },
140
+ "/contacts/{id}": {
141
+ "parameters": [
142
+ {
143
+ "name": "id",
144
+ "in": "path",
145
+ "required": true,
146
+ "schema": {
147
+ "type": "string"
148
+ }
149
+ }
150
+ ],
151
+ "get": {
152
+ "summary": "Retrieve a specific contact",
153
+ "operationId": "getContact",
154
+ "tags": ["Contacts"],
155
+ "responses": {
156
+ "200": {
157
+ "description": "Successful response",
158
+ "content": {
159
+ "application/vnd.quipu.v1+json": {
160
+ "schema": {
161
+ "$ref": "#/components/schemas/ContactResponse"
162
+ }
163
+ }
164
+ }
165
+ }
166
+ }
167
+ },
168
+ "patch": {
169
+ "summary": "Update a contact",
170
+ "operationId": "updateContact",
171
+ "tags": ["Contacts"],
172
+ "requestBody": {
173
+ "required": true,
174
+ "content": {
175
+ "application/vnd.quipu.v1+json": {
176
+ "schema": {
177
+ "$ref": "#/components/schemas/ContactUpdate"
178
+ }
179
+ }
180
+ }
181
+ },
182
+ "responses": {
183
+ "200": {
184
+ "description": "Contact updated successfully",
185
+ "content": {
186
+ "application/vnd.quipu.v1+json": {
187
+ "schema": {
188
+ "$ref": "#/components/schemas/ContactResponse"
189
+ }
190
+ }
191
+ }
192
+ },
193
+ "422": {
194
+ "description": "Validation error",
195
+ "content": {
196
+ "application/vnd.quipu.v1+json": {
197
+ "schema": {
198
+ "$ref": "#/components/schemas/ErrorResponse"
199
+ }
200
+ }
201
+ }
202
+ }
203
+ }
204
+ },
205
+ "delete": {
206
+ "summary": "Delete a contact",
207
+ "operationId": "deleteContact",
208
+ "tags": ["Contacts"],
209
+ "responses": {
210
+ "204": {
211
+ "description": "Contact deleted successfully"
212
+ },
213
+ "403": {
214
+ "description": "Contact could not be deleted"
215
+ }
216
+ }
217
+ }
218
+ },
219
+ "/book_entries": {
220
+ "get": {
221
+ "summary": "Retrieve all invoices, tickets and paysheets",
222
+ "operationId": "getBookEntries",
223
+ "tags": ["Book Entries"],
224
+ "parameters": [
225
+ {
226
+ "$ref": "#/components/parameters/FilterType"
227
+ },
228
+ {
229
+ "$ref": "#/components/parameters/FilterKind"
230
+ },
231
+ {
232
+ "$ref": "#/components/parameters/FilterQ"
233
+ },
234
+ {
235
+ "$ref": "#/components/parameters/FilterPeriod"
236
+ },
237
+ {
238
+ "$ref": "#/components/parameters/FilterPaymentStatus"
239
+ },
240
+ {
241
+ "$ref": "#/components/parameters/FilterContactId"
242
+ },
243
+ {
244
+ "$ref": "#/components/parameters/FilterFieldQuery"
245
+ },
246
+ {
247
+ "$ref": "#/components/parameters/SortParameter"
248
+ },
249
+ {
250
+ "$ref": "#/components/parameters/PageNumber"
251
+ }
252
+ ],
253
+ "responses": {
254
+ "200": {
255
+ "description": "Successful response",
256
+ "content": {
257
+ "application/vnd.quipu.v1+json": {
258
+ "schema": {
259
+ "$ref": "#/components/schemas/BookEntryCollection"
260
+ }
261
+ }
262
+ }
263
+ }
264
+ }
265
+ }
266
+ },
267
+ "/invoices": {
268
+ "get": {
269
+ "summary": "Retrieve all invoices",
270
+ "operationId": "getInvoices",
271
+ "tags": ["Invoices"],
272
+ "parameters": [
273
+ {
274
+ "$ref": "#/components/parameters/FilterKind"
275
+ },
276
+ {
277
+ "$ref": "#/components/parameters/FilterQ"
278
+ },
279
+ {
280
+ "$ref": "#/components/parameters/FilterPeriod"
281
+ },
282
+ {
283
+ "$ref": "#/components/parameters/FilterPaymentStatus"
284
+ },
285
+ {
286
+ "$ref": "#/components/parameters/FilterContactId"
287
+ },
288
+ {
289
+ "$ref": "#/components/parameters/FilterFieldQuery"
290
+ },
291
+ {
292
+ "$ref": "#/components/parameters/SortParameter"
293
+ },
294
+ {
295
+ "$ref": "#/components/parameters/PageNumber"
296
+ },
297
+ {
298
+ "$ref": "#/components/parameters/IncludeItems"
299
+ }
300
+ ],
301
+ "responses": {
302
+ "200": {
303
+ "description": "Successful response",
304
+ "content": {
305
+ "application/vnd.quipu.v1+json": {
306
+ "schema": {
307
+ "$ref": "#/components/schemas/InvoiceCollection"
308
+ }
309
+ }
310
+ }
311
+ }
312
+ }
313
+ },
314
+ "post": {
315
+ "summary": "Create a new invoice",
316
+ "operationId": "createInvoice",
317
+ "tags": ["Invoices"],
318
+ "requestBody": {
319
+ "required": true,
320
+ "content": {
321
+ "application/vnd.quipu.v1+json": {
322
+ "schema": {
323
+ "$ref": "#/components/schemas/InvoiceCreate"
324
+ }
325
+ }
326
+ }
327
+ },
328
+ "responses": {
329
+ "201": {
330
+ "description": "Invoice created successfully",
331
+ "content": {
332
+ "application/vnd.quipu.v1+json": {
333
+ "schema": {
334
+ "$ref": "#/components/schemas/InvoiceResponse"
335
+ }
336
+ }
337
+ }
338
+ },
339
+ "422": {
340
+ "description": "Validation error",
341
+ "content": {
342
+ "application/vnd.quipu.v1+json": {
343
+ "schema": {
344
+ "$ref": "#/components/schemas/ErrorResponse"
345
+ }
346
+ }
347
+ }
348
+ }
349
+ }
350
+ }
351
+ },
352
+ "/invoices/{id}": {
353
+ "parameters": [
354
+ {
355
+ "name": "id",
356
+ "in": "path",
357
+ "required": true,
358
+ "schema": {
359
+ "type": "string"
360
+ }
361
+ }
362
+ ],
363
+ "get": {
364
+ "summary": "Retrieve a specific invoice",
365
+ "operationId": "getInvoice",
366
+ "tags": ["Invoices"],
367
+ "parameters": [
368
+ {
369
+ "$ref": "#/components/parameters/IncludeItems"
370
+ }
371
+ ],
372
+ "responses": {
373
+ "200": {
374
+ "description": "Successful response",
375
+ "content": {
376
+ "application/vnd.quipu.v1+json": {
377
+ "schema": {
378
+ "$ref": "#/components/schemas/InvoiceResponse"
379
+ }
380
+ }
381
+ }
382
+ }
383
+ }
384
+ },
385
+ "patch": {
386
+ "summary": "Update an invoice",
387
+ "operationId": "updateInvoice",
388
+ "tags": ["Invoices"],
389
+ "requestBody": {
390
+ "required": true,
391
+ "content": {
392
+ "application/vnd.quipu.v1+json": {
393
+ "schema": {
394
+ "$ref": "#/components/schemas/InvoiceUpdate"
395
+ }
396
+ }
397
+ }
398
+ },
399
+ "responses": {
400
+ "200": {
401
+ "description": "Invoice updated successfully",
402
+ "content": {
403
+ "application/vnd.quipu.v1+json": {
404
+ "schema": {
405
+ "$ref": "#/components/schemas/InvoiceResponse"
406
+ }
407
+ }
408
+ }
409
+ },
410
+ "422": {
411
+ "description": "Validation error",
412
+ "content": {
413
+ "application/vnd.quipu.v1+json": {
414
+ "schema": {
415
+ "$ref": "#/components/schemas/ErrorResponse"
416
+ }
417
+ }
418
+ }
419
+ }
420
+ }
421
+ },
422
+ "delete": {
423
+ "summary": "Delete an invoice",
424
+ "operationId": "deleteInvoice",
425
+ "tags": ["Invoices"],
426
+ "responses": {
427
+ "204": {
428
+ "description": "Invoice deleted successfully"
429
+ }
430
+ }
431
+ }
432
+ },
433
+ "/tickets": {
434
+ "get": {
435
+ "summary": "Retrieve all tickets",
436
+ "operationId": "getTickets",
437
+ "tags": ["Tickets"],
438
+ "parameters": [
439
+ {
440
+ "$ref": "#/components/parameters/FilterKind"
441
+ },
442
+ {
443
+ "$ref": "#/components/parameters/FilterQ"
444
+ },
445
+ {
446
+ "$ref": "#/components/parameters/FilterPeriod"
447
+ },
448
+ {
449
+ "$ref": "#/components/parameters/FilterPaymentStatus"
450
+ },
451
+ {
452
+ "$ref": "#/components/parameters/FilterContactId"
453
+ },
454
+ {
455
+ "$ref": "#/components/parameters/FilterFieldQuery"
456
+ },
457
+ {
458
+ "$ref": "#/components/parameters/SortParameter"
459
+ },
460
+ {
461
+ "$ref": "#/components/parameters/PageNumber"
462
+ },
463
+ {
464
+ "$ref": "#/components/parameters/IncludeItems"
465
+ }
466
+ ],
467
+ "responses": {
468
+ "200": {
469
+ "description": "Successful response",
470
+ "content": {
471
+ "application/vnd.quipu.v1+json": {
472
+ "schema": {
473
+ "$ref": "#/components/schemas/TicketCollection"
474
+ }
475
+ }
476
+ }
477
+ }
478
+ }
479
+ },
480
+ "post": {
481
+ "summary": "Create a new ticket",
482
+ "operationId": "createTicket",
483
+ "tags": ["Tickets"],
484
+ "requestBody": {
485
+ "required": true,
486
+ "content": {
487
+ "application/vnd.quipu.v1+json": {
488
+ "schema": {
489
+ "$ref": "#/components/schemas/TicketCreate"
490
+ }
491
+ }
492
+ }
493
+ },
494
+ "responses": {
495
+ "201": {
496
+ "description": "Ticket created successfully",
497
+ "content": {
498
+ "application/vnd.quipu.v1+json": {
499
+ "schema": {
500
+ "$ref": "#/components/schemas/TicketResponse"
501
+ }
502
+ }
503
+ }
504
+ },
505
+ "422": {
506
+ "description": "Validation error",
507
+ "content": {
508
+ "application/vnd.quipu.v1+json": {
509
+ "schema": {
510
+ "$ref": "#/components/schemas/ErrorResponse"
511
+ }
512
+ }
513
+ }
514
+ }
515
+ }
516
+ }
517
+ },
518
+ "/tickets/{id}": {
519
+ "parameters": [
520
+ {
521
+ "name": "id",
522
+ "in": "path",
523
+ "required": true,
524
+ "schema": {
525
+ "type": "string"
526
+ }
527
+ }
528
+ ],
529
+ "get": {
530
+ "summary": "Retrieve a specific ticket",
531
+ "operationId": "getTicket",
532
+ "tags": ["Tickets"],
533
+ "parameters": [
534
+ {
535
+ "$ref": "#/components/parameters/IncludeItems"
536
+ }
537
+ ],
538
+ "responses": {
539
+ "200": {
540
+ "description": "Successful response",
541
+ "content": {
542
+ "application/vnd.quipu.v1+json": {
543
+ "schema": {
544
+ "$ref": "#/components/schemas/TicketResponse"
545
+ }
546
+ }
547
+ }
548
+ }
549
+ }
550
+ },
551
+ "patch": {
552
+ "summary": "Update a ticket",
553
+ "operationId": "updateTicket",
554
+ "tags": ["Tickets"],
555
+ "requestBody": {
556
+ "required": true,
557
+ "content": {
558
+ "application/vnd.quipu.v1+json": {
559
+ "schema": {
560
+ "$ref": "#/components/schemas/TicketUpdate"
561
+ }
562
+ }
563
+ }
564
+ },
565
+ "responses": {
566
+ "200": {
567
+ "description": "Ticket updated successfully",
568
+ "content": {
569
+ "application/vnd.quipu.v1+json": {
570
+ "schema": {
571
+ "$ref": "#/components/schemas/TicketResponse"
572
+ }
573
+ }
574
+ }
575
+ },
576
+ "422": {
577
+ "description": "Validation error",
578
+ "content": {
579
+ "application/vnd.quipu.v1+json": {
580
+ "schema": {
581
+ "$ref": "#/components/schemas/ErrorResponse"
582
+ }
583
+ }
584
+ }
585
+ }
586
+ }
587
+ },
588
+ "delete": {
589
+ "summary": "Delete a ticket",
590
+ "operationId": "deleteTicket",
591
+ "tags": ["Tickets"],
592
+ "responses": {
593
+ "204": {
594
+ "description": "Ticket deleted successfully"
595
+ }
596
+ }
597
+ }
598
+ },
599
+ "/paysheets": {
600
+ "get": {
601
+ "summary": "Retrieve all paysheets",
602
+ "operationId": "getPaysheets",
603
+ "tags": ["Paysheets"],
604
+ "parameters": [
605
+ {
606
+ "$ref": "#/components/parameters/FilterQ"
607
+ },
608
+ {
609
+ "$ref": "#/components/parameters/FilterPeriod"
610
+ },
611
+ {
612
+ "$ref": "#/components/parameters/FilterPaymentStatus"
613
+ },
614
+ {
615
+ "$ref": "#/components/parameters/FilterContactId"
616
+ },
617
+ {
618
+ "$ref": "#/components/parameters/FilterFieldQuery"
619
+ },
620
+ {
621
+ "$ref": "#/components/parameters/SortParameter"
622
+ },
623
+ {
624
+ "$ref": "#/components/parameters/PageNumber"
625
+ }
626
+ ],
627
+ "responses": {
628
+ "200": {
629
+ "description": "Successful response",
630
+ "content": {
631
+ "application/vnd.quipu.v1+json": {
632
+ "schema": {
633
+ "$ref": "#/components/schemas/PaysheetCollection"
634
+ }
635
+ }
636
+ }
637
+ }
638
+ }
639
+ },
640
+ "post": {
641
+ "summary": "Create a new paysheet",
642
+ "operationId": "createPaysheet",
643
+ "tags": ["Paysheets"],
644
+ "requestBody": {
645
+ "required": true,
646
+ "content": {
647
+ "application/vnd.quipu.v1+json": {
648
+ "schema": {
649
+ "$ref": "#/components/schemas/PaysheetCreate"
650
+ }
651
+ }
652
+ }
653
+ },
654
+ "responses": {
655
+ "201": {
656
+ "description": "Paysheet created successfully",
657
+ "content": {
658
+ "application/vnd.quipu.v1+json": {
659
+ "schema": {
660
+ "$ref": "#/components/schemas/PaysheetResponse"
661
+ }
662
+ }
663
+ }
664
+ },
665
+ "422": {
666
+ "description": "Validation error",
667
+ "content": {
668
+ "application/vnd.quipu.v1+json": {
669
+ "schema": {
670
+ "$ref": "#/components/schemas/ErrorResponse"
671
+ }
672
+ }
673
+ }
674
+ }
675
+ }
676
+ }
677
+ },
678
+ "/paysheets/{id}": {
679
+ "parameters": [
680
+ {
681
+ "name": "id",
682
+ "in": "path",
683
+ "required": true,
684
+ "schema": {
685
+ "type": "string"
686
+ }
687
+ }
688
+ ],
689
+ "get": {
690
+ "summary": "Retrieve a specific paysheet",
691
+ "operationId": "getPaysheet",
692
+ "tags": ["Paysheets"],
693
+ "responses": {
694
+ "200": {
695
+ "description": "Successful response",
696
+ "content": {
697
+ "application/vnd.quipu.v1+json": {
698
+ "schema": {
699
+ "$ref": "#/components/schemas/PaysheetResponse"
700
+ }
701
+ }
702
+ }
703
+ }
704
+ }
705
+ },
706
+ "patch": {
707
+ "summary": "Update a paysheet",
708
+ "operationId": "updatePaysheet",
709
+ "tags": ["Paysheets"],
710
+ "requestBody": {
711
+ "required": true,
712
+ "content": {
713
+ "application/vnd.quipu.v1+json": {
714
+ "schema": {
715
+ "$ref": "#/components/schemas/PaysheetUpdate"
716
+ }
717
+ }
718
+ }
719
+ },
720
+ "responses": {
721
+ "200": {
722
+ "description": "Paysheet updated successfully",
723
+ "content": {
724
+ "application/vnd.quipu.v1+json": {
725
+ "schema": {
726
+ "$ref": "#/components/schemas/PaysheetResponse"
727
+ }
728
+ }
729
+ }
730
+ },
731
+ "422": {
732
+ "description": "Validation error",
733
+ "content": {
734
+ "application/vnd.quipu.v1+json": {
735
+ "schema": {
736
+ "$ref": "#/components/schemas/ErrorResponse"
737
+ }
738
+ }
739
+ }
740
+ }
741
+ }
742
+ },
743
+ "delete": {
744
+ "summary": "Delete a paysheet",
745
+ "operationId": "deletePaysheet",
746
+ "tags": ["Paysheets"],
747
+ "responses": {
748
+ "204": {
749
+ "description": "Paysheet deleted successfully"
750
+ }
751
+ }
752
+ }
753
+ },
754
+ "/numbering_series": {
755
+ "get": {
756
+ "summary": "Retrieve all numbering series",
757
+ "operationId": "getNumberingSeries",
758
+ "tags": ["Numbering Series"],
759
+ "parameters": [
760
+ {
761
+ "$ref": "#/components/parameters/FilterPrefix"
762
+ },
763
+ {
764
+ "$ref": "#/components/parameters/FilterApplicableTo"
765
+ },
766
+ {
767
+ "$ref": "#/components/parameters/FilterAmending"
768
+ }
769
+ ],
770
+ "responses": {
771
+ "200": {
772
+ "description": "Successful response",
773
+ "content": {
774
+ "application/vnd.quipu.v1+json": {
775
+ "schema": {
776
+ "$ref": "#/components/schemas/NumberingSeriesCollection"
777
+ }
778
+ }
779
+ }
780
+ }
781
+ }
782
+ },
783
+ "post": {
784
+ "summary": "Create a new numbering series",
785
+ "operationId": "createNumberingSeries",
786
+ "tags": ["Numbering Series"],
787
+ "requestBody": {
788
+ "required": true,
789
+ "content": {
790
+ "application/vnd.quipu.v1+json": {
791
+ "schema": {
792
+ "$ref": "#/components/schemas/NumberingSeriesCreate"
793
+ }
794
+ }
795
+ }
796
+ },
797
+ "responses": {
798
+ "201": {
799
+ "description": "Numbering series created successfully",
800
+ "content": {
801
+ "application/vnd.quipu.v1+json": {
802
+ "schema": {
803
+ "$ref": "#/components/schemas/NumberingSeriesResponse"
804
+ }
805
+ }
806
+ }
807
+ },
808
+ "422": {
809
+ "description": "Validation error",
810
+ "content": {
811
+ "application/vnd.quipu.v1+json": {
812
+ "schema": {
813
+ "$ref": "#/components/schemas/ErrorResponse"
814
+ }
815
+ }
816
+ }
817
+ }
818
+ }
819
+ }
820
+ },
821
+ "/numbering_series/{id}": {
822
+ "parameters": [
823
+ {
824
+ "name": "id",
825
+ "in": "path",
826
+ "required": true,
827
+ "schema": {
828
+ "type": "string"
829
+ }
830
+ }
831
+ ],
832
+ "get": {
833
+ "summary": "Retrieve a specific numbering series",
834
+ "operationId": "getNumberingSerie",
835
+ "tags": ["Numbering Series"],
836
+ "responses": {
837
+ "200": {
838
+ "description": "Successful response",
839
+ "content": {
840
+ "application/vnd.quipu.v1+json": {
841
+ "schema": {
842
+ "$ref": "#/components/schemas/NumberingSeriesResponse"
843
+ }
844
+ }
845
+ }
846
+ }
847
+ }
848
+ },
849
+ "patch": {
850
+ "summary": "Update a numbering series",
851
+ "operationId": "updateNumberingSeries",
852
+ "tags": ["Numbering Series"],
853
+ "requestBody": {
854
+ "required": true,
855
+ "content": {
856
+ "application/vnd.quipu.v1+json": {
857
+ "schema": {
858
+ "$ref": "#/components/schemas/NumberingSeriesUpdate"
859
+ }
860
+ }
861
+ }
862
+ },
863
+ "responses": {
864
+ "200": {
865
+ "description": "Numbering series updated successfully",
866
+ "content": {
867
+ "application/vnd.quipu.v1+json": {
868
+ "schema": {
869
+ "$ref": "#/components/schemas/NumberingSeriesResponse"
870
+ }
871
+ }
872
+ }
873
+ },
874
+ "422": {
875
+ "description": "Validation error",
876
+ "content": {
877
+ "application/vnd.quipu.v1+json": {
878
+ "schema": {
879
+ "$ref": "#/components/schemas/ErrorResponse"
880
+ }
881
+ }
882
+ }
883
+ }
884
+ }
885
+ },
886
+ "delete": {
887
+ "summary": "Delete a numbering series",
888
+ "operationId": "deleteNumberingSeries",
889
+ "tags": ["Numbering Series"],
890
+ "responses": {
891
+ "204": {
892
+ "description": "Numbering series deleted successfully"
893
+ },
894
+ "403": {
895
+ "description": "Numbering series could not be deleted"
896
+ }
897
+ }
898
+ }
899
+ },
900
+ "/accounting_categories": {
901
+ "get": {
902
+ "summary": "Retrieve all accounting categories",
903
+ "operationId": "getAccountingCategories",
904
+ "tags": ["Accounting Categories"],
905
+ "parameters": [
906
+ {
907
+ "$ref": "#/components/parameters/FilterKind"
908
+ },
909
+ {
910
+ "$ref": "#/components/parameters/FilterAccountingPrefix"
911
+ }
912
+ ],
913
+ "responses": {
914
+ "200": {
915
+ "description": "Successful response",
916
+ "content": {
917
+ "application/vnd.quipu.v1+json": {
918
+ "schema": {
919
+ "$ref": "#/components/schemas/AccountingCategoryCollection"
920
+ }
921
+ }
922
+ }
923
+ }
924
+ }
925
+ }
926
+ },
927
+ "/accounting_categories/{id}": {
928
+ "parameters": [
929
+ {
930
+ "name": "id",
931
+ "in": "path",
932
+ "required": true,
933
+ "schema": {
934
+ "type": "string"
935
+ }
936
+ }
937
+ ],
938
+ "get": {
939
+ "summary": "Retrieve a specific accounting category",
940
+ "operationId": "getAccountingCategory",
941
+ "tags": ["Accounting Categories"],
942
+ "responses": {
943
+ "200": {
944
+ "description": "Successful response",
945
+ "content": {
946
+ "application/vnd.quipu.v1+json": {
947
+ "schema": {
948
+ "$ref": "#/components/schemas/AccountingCategoryResponse"
949
+ }
950
+ }
951
+ }
952
+ }
953
+ }
954
+ }
955
+ },
956
+ "/accounting_subcategories": {
957
+ "get": {
958
+ "summary": "Retrieve all accounting subcategories",
959
+ "operationId": "getAccountingSubcategories",
960
+ "tags": ["Accounting Subcategories"],
961
+ "parameters": [
962
+ {
963
+ "$ref": "#/components/parameters/FilterAccountingCategoryId"
964
+ }
965
+ ],
966
+ "responses": {
967
+ "200": {
968
+ "description": "Successful response",
969
+ "content": {
970
+ "application/vnd.quipu.v1+json": {
971
+ "schema": {
972
+ "$ref": "#/components/schemas/AccountingSubcategoryCollection"
973
+ }
974
+ }
975
+ }
976
+ }
977
+ }
978
+ },
979
+ "post": {
980
+ "summary": "Create a new accounting subcategory",
981
+ "operationId": "createAccountingSubcategory",
982
+ "tags": ["Accounting Subcategories"],
983
+ "requestBody": {
984
+ "required": true,
985
+ "content": {
986
+ "application/vnd.quipu.v1+json": {
987
+ "schema": {
988
+ "$ref": "#/components/schemas/AccountingSubcategoryCreate"
989
+ }
990
+ }
991
+ }
992
+ },
993
+ "responses": {
994
+ "201": {
995
+ "description": "Accounting subcategory created successfully",
996
+ "content": {
997
+ "application/vnd.quipu.v1+json": {
998
+ "schema": {
999
+ "$ref": "#/components/schemas/AccountingSubcategoryResponse"
1000
+ }
1001
+ }
1002
+ }
1003
+ },
1004
+ "422": {
1005
+ "description": "Validation error",
1006
+ "content": {
1007
+ "application/vnd.quipu.v1+json": {
1008
+ "schema": {
1009
+ "$ref": "#/components/schemas/ErrorResponse"
1010
+ }
1011
+ }
1012
+ }
1013
+ }
1014
+ }
1015
+ }
1016
+ },
1017
+ "/accounting_subcategories/{id}": {
1018
+ "parameters": [
1019
+ {
1020
+ "name": "id",
1021
+ "in": "path",
1022
+ "required": true,
1023
+ "schema": {
1024
+ "type": "string"
1025
+ }
1026
+ }
1027
+ ],
1028
+ "get": {
1029
+ "summary": "Retrieve a specific accounting subcategory",
1030
+ "operationId": "getAccountingSubcategory",
1031
+ "tags": ["Accounting Subcategories"],
1032
+ "responses": {
1033
+ "200": {
1034
+ "description": "Successful response",
1035
+ "content": {
1036
+ "application/vnd.quipu.v1+json": {
1037
+ "schema": {
1038
+ "$ref": "#/components/schemas/AccountingSubcategoryResponse"
1039
+ }
1040
+ }
1041
+ }
1042
+ }
1043
+ }
1044
+ },
1045
+ "patch": {
1046
+ "summary": "Update an accounting subcategory",
1047
+ "operationId": "updateAccountingSubcategory",
1048
+ "tags": ["Accounting Subcategories"],
1049
+ "requestBody": {
1050
+ "required": true,
1051
+ "content": {
1052
+ "application/vnd.quipu.v1+json": {
1053
+ "schema": {
1054
+ "$ref": "#/components/schemas/AccountingSubcategoryUpdate"
1055
+ }
1056
+ }
1057
+ }
1058
+ },
1059
+ "responses": {
1060
+ "200": {
1061
+ "description": "Accounting subcategory updated successfully",
1062
+ "content": {
1063
+ "application/vnd.quipu.v1+json": {
1064
+ "schema": {
1065
+ "$ref": "#/components/schemas/AccountingSubcategoryResponse"
1066
+ }
1067
+ }
1068
+ }
1069
+ },
1070
+ "422": {
1071
+ "description": "Validation error",
1072
+ "content": {
1073
+ "application/vnd.quipu.v1+json": {
1074
+ "schema": {
1075
+ "$ref": "#/components/schemas/ErrorResponse"
1076
+ }
1077
+ }
1078
+ }
1079
+ }
1080
+ }
1081
+ },
1082
+ "delete": {
1083
+ "summary": "Delete an accounting subcategory",
1084
+ "operationId": "deleteAccountingSubcategory",
1085
+ "tags": ["Accounting Subcategories"],
1086
+ "responses": {
1087
+ "204": {
1088
+ "description": "Accounting subcategory deleted successfully"
1089
+ }
1090
+ }
1091
+ }
1092
+ },
1093
+ "/attachments": {
1094
+ "post": {
1095
+ "summary": "Upload a new attachment",
1096
+ "operationId": "createAttachment",
1097
+ "tags": ["Attachments"],
1098
+ "requestBody": {
1099
+ "required": true,
1100
+ "content": {
1101
+ "multipart/form-data": {
1102
+ "schema": {
1103
+ "type": "object",
1104
+ "required": ["file", "book_entry_id"],
1105
+ "properties": {
1106
+ "file": {
1107
+ "type": "string",
1108
+ "format": "binary"
1109
+ },
1110
+ "book_entry_id": {
1111
+ "type": "string"
1112
+ }
1113
+ }
1114
+ }
1115
+ }
1116
+ }
1117
+ },
1118
+ "responses": {
1119
+ "201": {
1120
+ "description": "Attachment created successfully",
1121
+ "content": {
1122
+ "application/vnd.quipu.v1+json": {
1123
+ "schema": {
1124
+ "$ref": "#/components/schemas/AttachmentResponse"
1125
+ }
1126
+ }
1127
+ }
1128
+ },
1129
+ "422": {
1130
+ "description": "Validation error",
1131
+ "content": {
1132
+ "application/vnd.quipu.v1+json": {
1133
+ "schema": {
1134
+ "$ref": "#/components/schemas/ErrorResponse"
1135
+ }
1136
+ }
1137
+ }
1138
+ }
1139
+ }
1140
+ }
1141
+ },
1142
+ "/attachments/{id}": {
1143
+ "parameters": [
1144
+ {
1145
+ "name": "id",
1146
+ "in": "path",
1147
+ "required": true,
1148
+ "schema": {
1149
+ "type": "string"
1150
+ }
1151
+ }
1152
+ ],
1153
+ "get": {
1154
+ "summary": "Retrieve a specific attachment",
1155
+ "operationId": "getAttachment",
1156
+ "tags": ["Attachments"],
1157
+ "responses": {
1158
+ "200": {
1159
+ "description": "Successful response",
1160
+ "content": {
1161
+ "application/vnd.quipu.v1+json": {
1162
+ "schema": {
1163
+ "$ref": "#/components/schemas/AttachmentResponse"
1164
+ }
1165
+ }
1166
+ }
1167
+ }
1168
+ }
1169
+ },
1170
+ "delete": {
1171
+ "summary": "Delete an attachment",
1172
+ "operationId": "deleteAttachment",
1173
+ "tags": ["Attachments"],
1174
+ "responses": {
1175
+ "204": {
1176
+ "description": "Attachment deleted successfully"
1177
+ }
1178
+ }
1179
+ }
1180
+ }
1181
+ },
1182
+ "components": {
1183
+ "securitySchemes": {
1184
+ "oauth2": {
1185
+ "type": "oauth2",
1186
+ "flows": {
1187
+ "clientCredentials": {
1188
+ "tokenUrl": "/oauth/token",
1189
+ "scopes": {
1190
+ "ecommerce": "Access to ecommerce operations"
1191
+ }
1192
+ }
1193
+ }
1194
+ }
1195
+ },
1196
+ "parameters": {
1197
+ "FilterQ": {
1198
+ "name": "filter[q]",
1199
+ "in": "query",
1200
+ "description": "Search query",
1201
+ "schema": {
1202
+ "type": "string"
1203
+ }
1204
+ },
1205
+ "FilterKind": {
1206
+ "name": "filter[kind]",
1207
+ "in": "query",
1208
+ "description": "Filter by kind",
1209
+ "schema": {
1210
+ "type": "string",
1211
+ "enum": [
1212
+ "income",
1213
+ "expenses",
1214
+ "employee",
1215
+ "supplier",
1216
+ "client",
1217
+ "assets"
1218
+ ]
1219
+ }
1220
+ },
1221
+ "FilterTaxId": {
1222
+ "name": "filter[tax_id]",
1223
+ "in": "query",
1224
+ "description": "Filter by tax ID",
1225
+ "schema": {
1226
+ "type": "string"
1227
+ }
1228
+ },
1229
+ "FilterCountry": {
1230
+ "name": "filter[country]",
1231
+ "in": "query",
1232
+ "description": "Filter by countries (comma separated)",
1233
+ "schema": {
1234
+ "type": "string"
1235
+ }
1236
+ },
1237
+ "FilterEmail": {
1238
+ "name": "filter[email]",
1239
+ "in": "query",
1240
+ "description": "Filter by email",
1241
+ "schema": {
1242
+ "type": "string"
1243
+ }
1244
+ },
1245
+ "FilterType": {
1246
+ "name": "filter[type]",
1247
+ "in": "query",
1248
+ "description": "Filter by type",
1249
+ "schema": {
1250
+ "type": "string",
1251
+ "enum": ["invoices", "tickets", "paysheets"]
1252
+ }
1253
+ },
1254
+ "FilterPeriod": {
1255
+ "name": "filter[period]",
1256
+ "in": "query",
1257
+ "description": "Filter by period",
1258
+ "schema": {
1259
+ "type": "string",
1260
+ "example": "2015-Q1"
1261
+ }
1262
+ },
1263
+ "FilterPaymentStatus": {
1264
+ "name": "filter[payment_status]",
1265
+ "in": "query",
1266
+ "description": "Filter by payment status",
1267
+ "schema": {
1268
+ "type": "string",
1269
+ "enum": ["paid", "unpaid", "due", "pending"]
1270
+ }
1271
+ },
1272
+ "FilterContactId": {
1273
+ "name": "filter[contact_id]",
1274
+ "in": "query",
1275
+ "description": "Filter by contact ID",
1276
+ "schema": {
1277
+ "type": "string"
1278
+ }
1279
+ },
1280
+ "FilterFieldQuery": {
1281
+ "name": "filter[field_query]",
1282
+ "in": "query",
1283
+ "description": "Filter by field and term",
1284
+ "schema": {
1285
+ "type": "object",
1286
+ "properties": {
1287
+ "field": {
1288
+ "type": "string"
1289
+ },
1290
+ "term": {
1291
+ "type": "string"
1292
+ }
1293
+ }
1294
+ }
1295
+ },
1296
+ "FilterPrefix": {
1297
+ "name": "filter[prefix]",
1298
+ "in": "query",
1299
+ "description": "Filter by prefix",
1300
+ "schema": {
1301
+ "type": "string"
1302
+ }
1303
+ },
1304
+ "FilterApplicableTo": {
1305
+ "name": "filter[applicable_to]",
1306
+ "in": "query",
1307
+ "description": "Filter by applicable document type",
1308
+ "schema": {
1309
+ "type": "string",
1310
+ "enum": ["invoices", "tickets", "budgets"]
1311
+ }
1312
+ },
1313
+ "FilterAmending": {
1314
+ "name": "filter[amending]",
1315
+ "in": "query",
1316
+ "description": "Filter by amending status",
1317
+ "schema": {
1318
+ "type": "string",
1319
+ "enum": [true, false]
1320
+ }
1321
+ },
1322
+ "FilterAccountingPrefix": {
1323
+ "name": "filter[prefix]",
1324
+ "in": "query",
1325
+ "description": "Filter by accounting prefix",
1326
+ "schema": {
1327
+ "type": "string"
1328
+ }
1329
+ },
1330
+ "FilterAccountingCategoryId": {
1331
+ "name": "filter[accounting_category_id]",
1332
+ "in": "query",
1333
+ "description": "Filter by accounting category ID",
1334
+ "schema": {
1335
+ "type": "string"
1336
+ }
1337
+ },
1338
+ "SortParameter": {
1339
+ "name": "sort",
1340
+ "in": "query",
1341
+ "description": "Sort criteria",
1342
+ "schema": {
1343
+ "type": "string",
1344
+ "example": "-issue_date,total_amount"
1345
+ }
1346
+ },
1347
+ "PageNumber": {
1348
+ "name": "page[number]",
1349
+ "in": "query",
1350
+ "description": "Page number for pagination",
1351
+ "schema": {
1352
+ "type": "integer"
1353
+ }
1354
+ },
1355
+ "IncludeItems": {
1356
+ "name": "include",
1357
+ "in": "query",
1358
+ "description": "Include related resources",
1359
+ "schema": {
1360
+ "type": "string",
1361
+ "enum": ["items"]
1362
+ }
1363
+ }
1364
+ },
1365
+ "schemas": {
1366
+ "TokenResponse": {
1367
+ "type": "object",
1368
+ "properties": {
1369
+ "token_type": {
1370
+ "type": "string",
1371
+ "example": "bearer"
1372
+ },
1373
+ "created_at": {
1374
+ "type": "integer",
1375
+ "format": "int64"
1376
+ },
1377
+ "access_token": {
1378
+ "type": "string"
1379
+ },
1380
+ "refresh_token": {
1381
+ "type": "string",
1382
+ "nullable": true
1383
+ },
1384
+ "expires_in": {
1385
+ "type": "integer",
1386
+ "format": "int64"
1387
+ }
1388
+ }
1389
+ },
1390
+ "PaginationMeta": {
1391
+ "type": "object",
1392
+ "properties": {
1393
+ "meta": {
1394
+ "type": "object",
1395
+ "properties": {
1396
+ "pagination_info": {
1397
+ "type": "object",
1398
+ "properties": {
1399
+ "total_pages": {
1400
+ "type": "integer"
1401
+ },
1402
+ "current_page": {
1403
+ "type": "integer"
1404
+ },
1405
+ "total_results": {
1406
+ "type": "integer"
1407
+ }
1408
+ }
1409
+ }
1410
+ }
1411
+ }
1412
+ }
1413
+ },
1414
+ "ErrorResponse": {
1415
+ "type": "object",
1416
+ "properties": {
1417
+ "errors": {
1418
+ "type": "array",
1419
+ "items": {
1420
+ "type": "object",
1421
+ "properties": {
1422
+ "detail": {
1423
+ "type": "string"
1424
+ },
1425
+ "source": {
1426
+ "type": "object",
1427
+ "properties": {
1428
+ "pointer": {
1429
+ "type": "string"
1430
+ }
1431
+ }
1432
+ }
1433
+ }
1434
+ }
1435
+ }
1436
+ }
1437
+ },
1438
+ "ContactAttributes": {
1439
+ "type": "object",
1440
+ "properties": {
1441
+ "name": {
1442
+ "type": "string"
1443
+ },
1444
+ "tax_id": {
1445
+ "type": "string"
1446
+ },
1447
+ "phone": {
1448
+ "type": "string"
1449
+ },
1450
+ "email": {
1451
+ "type": "string"
1452
+ },
1453
+ "address": {
1454
+ "type": "string"
1455
+ },
1456
+ "town": {
1457
+ "type": "string"
1458
+ },
1459
+ "zip_code": {
1460
+ "type": "string"
1461
+ },
1462
+ "country_code": {
1463
+ "type": "string"
1464
+ },
1465
+ "total_paid_incomes": {
1466
+ "type": "string",
1467
+ "readOnly": true
1468
+ },
1469
+ "total_unpaid_incomes": {
1470
+ "type": "string",
1471
+ "readOnly": true
1472
+ },
1473
+ "total_incomes": {
1474
+ "type": "string",
1475
+ "readOnly": true
1476
+ },
1477
+ "total_paid_expenses": {
1478
+ "type": "string",
1479
+ "readOnly": true
1480
+ },
1481
+ "total_unpaid_expenses": {
1482
+ "type": "string",
1483
+ "readOnly": true
1484
+ },
1485
+ "total_expenses": {
1486
+ "type": "string",
1487
+ "readOnly": true
1488
+ },
1489
+ "client_number": {
1490
+ "type": "string"
1491
+ },
1492
+ "supplier_number": {
1493
+ "type": "string",
1494
+ "nullable": true
1495
+ },
1496
+ "is_client": {
1497
+ "type": "boolean",
1498
+ "readOnly": true
1499
+ },
1500
+ "is_supplier": {
1501
+ "type": "boolean",
1502
+ "readOnly": true
1503
+ },
1504
+ "is_employee": {
1505
+ "type": "boolean",
1506
+ "readOnly": true
1507
+ },
1508
+ "is_supplier_of_direct_goods": {
1509
+ "type": "boolean"
1510
+ },
1511
+ "bank_account_number": {
1512
+ "type": "string"
1513
+ },
1514
+ "bank_account_swift_bic": {
1515
+ "type": "string"
1516
+ },
1517
+ "deletable": {
1518
+ "type": "boolean",
1519
+ "readOnly": true
1520
+ }
1521
+ }
1522
+ },
1523
+ "ContactCreate": {
1524
+ "type": "object",
1525
+ "required": ["data"],
1526
+ "properties": {
1527
+ "data": {
1528
+ "type": "object",
1529
+ "required": ["type", "attributes"],
1530
+ "properties": {
1531
+ "type": {
1532
+ "type": "string",
1533
+ "enum": ["contacts"]
1534
+ },
1535
+ "attributes": {
1536
+ "$ref": "#/components/schemas/ContactAttributes"
1537
+ }
1538
+ }
1539
+ }
1540
+ }
1541
+ },
1542
+ "ContactUpdate": {
1543
+ "type": "object",
1544
+ "required": ["data"],
1545
+ "properties": {
1546
+ "data": {
1547
+ "type": "object",
1548
+ "required": ["type", "attributes"],
1549
+ "properties": {
1550
+ "type": {
1551
+ "type": "string",
1552
+ "enum": ["contacts"]
1553
+ },
1554
+ "attributes": {
1555
+ "$ref": "#/components/schemas/ContactAttributes"
1556
+ }
1557
+ }
1558
+ }
1559
+ }
1560
+ },
1561
+ "ContactResponse": {
1562
+ "type": "object",
1563
+ "properties": {
1564
+ "data": {
1565
+ "type": "object",
1566
+ "properties": {
1567
+ "id": {
1568
+ "type": "string"
1569
+ },
1570
+ "type": {
1571
+ "type": "string",
1572
+ "enum": ["contacts"]
1573
+ },
1574
+ "attributes": {
1575
+ "$ref": "#/components/schemas/ContactAttributes"
1576
+ }
1577
+ }
1578
+ }
1579
+ }
1580
+ },
1581
+ "ContactCollection": {
1582
+ "allOf": [
1583
+ {
1584
+ "$ref": "#/components/schemas/PaginationMeta"
1585
+ },
1586
+ {
1587
+ "type": "object",
1588
+ "properties": {
1589
+ "data": {
1590
+ "type": "array",
1591
+ "items": {
1592
+ "type": "object",
1593
+ "properties": {
1594
+ "id": {
1595
+ "type": "string"
1596
+ },
1597
+ "type": {
1598
+ "type": "string"
1599
+ },
1600
+ "attributes": {
1601
+ "$ref": "#/components/schemas/ContactAttributes"
1602
+ }
1603
+ }
1604
+ }
1605
+ }
1606
+ }
1607
+ }
1608
+ ]
1609
+ },
1610
+ "ItemAttributes": {
1611
+ "type": "object",
1612
+ "properties": {
1613
+ "concept": {
1614
+ "type": "string"
1615
+ },
1616
+ "unitary_amount": {
1617
+ "type": "string"
1618
+ },
1619
+ "quantity": {
1620
+ "type": "string"
1621
+ },
1622
+ "kind": {
1623
+ "type": "string",
1624
+ "enum": ["current", "assets", "reimbursement"],
1625
+ "default": "current"
1626
+ },
1627
+ "vat_percent": {
1628
+ "type": "string"
1629
+ },
1630
+ "retention_percent": {
1631
+ "type": "string"
1632
+ },
1633
+ "discount_percent": {
1634
+ "type": "string"
1635
+ },
1636
+ "deductible_vat_percent": {
1637
+ "type": "string"
1638
+ },
1639
+ "deductible_expense_percent": {
1640
+ "type": "string"
1641
+ },
1642
+ "description": {
1643
+ "type": "string"
1644
+ },
1645
+ "vat_amount": {
1646
+ "type": "string",
1647
+ "readOnly": true
1648
+ },
1649
+ "retention_amount": {
1650
+ "type": "string",
1651
+ "readOnly": true
1652
+ },
1653
+ "discount_amount": {
1654
+ "type": "string",
1655
+ "readOnly": true
1656
+ },
1657
+ "total_amount": {
1658
+ "type": "string",
1659
+ "readOnly": true
1660
+ }
1661
+ }
1662
+ },
1663
+ "ItemInvoiceCreate": {
1664
+ "type": "object",
1665
+ "properties": {
1666
+ "type": {
1667
+ "type": "string",
1668
+ "enum": ["book_entry_items"]
1669
+ },
1670
+ "attributes": {
1671
+ "$ref": "#/components/schemas/ItemAttributes"
1672
+ }
1673
+ }
1674
+ },
1675
+ "ItemInvoiceUpdate": {
1676
+ "type": "object",
1677
+ "properties": {
1678
+ "id": {
1679
+ "type": "string"
1680
+ },
1681
+ "type": {
1682
+ "type": "string",
1683
+ "enum": ["book_entry_items"]
1684
+ },
1685
+ "attributes": {
1686
+ "$ref": "#/components/schemas/ItemAttributes"
1687
+ }
1688
+ }
1689
+ },
1690
+ "BookEntryCollection": {
1691
+ "allOf": [
1692
+ {
1693
+ "$ref": "#/components/schemas/PaginationMeta"
1694
+ },
1695
+ {
1696
+ "type": "object",
1697
+ "properties": {
1698
+ "data": {
1699
+ "type": "array",
1700
+ "items": {
1701
+ "oneOf": [
1702
+ {
1703
+ "$ref": "#/components/schemas/InvoiceData"
1704
+ },
1705
+ {
1706
+ "$ref": "#/components/schemas/TicketData"
1707
+ },
1708
+ {
1709
+ "$ref": "#/components/schemas/PaysheetData"
1710
+ }
1711
+ ]
1712
+ }
1713
+ }
1714
+ }
1715
+ }
1716
+ ]
1717
+ },
1718
+ "InvoiceAttributes": {
1719
+ "type": "object",
1720
+ "properties": {
1721
+ "kind": {
1722
+ "type": "string",
1723
+ "enum": ["income", "expenses"]
1724
+ },
1725
+ "number": {
1726
+ "type": "string"
1727
+ },
1728
+ "issue_date": {
1729
+ "type": "string",
1730
+ "format": "date"
1731
+ },
1732
+ "due_dates": {
1733
+ "type": "array",
1734
+ "items": {
1735
+ "type": "string",
1736
+ "format": "date"
1737
+ }
1738
+ },
1739
+ "paid_at": {
1740
+ "type": "string",
1741
+ "format": "date",
1742
+ "nullable": true
1743
+ },
1744
+ "payment_method": {
1745
+ "type": "string",
1746
+ "enum": [
1747
+ "cash",
1748
+ "bank_transfer",
1749
+ "bank_card",
1750
+ "direct_debit",
1751
+ "paypal",
1752
+ "check",
1753
+ "factoring"
1754
+ ]
1755
+ },
1756
+ "payment_status": {
1757
+ "type": "string",
1758
+ "enum": ["paid", "unpaid", "due", "pending"],
1759
+ "readOnly": true
1760
+ },
1761
+ "validation_status": {
1762
+ "type": "string",
1763
+ "enum": ["pending", "verified"],
1764
+ "readOnly": true
1765
+ },
1766
+ "total_amount": {
1767
+ "type": "string",
1768
+ "readOnly": true
1769
+ },
1770
+ "total_amount_without_taxes": {
1771
+ "type": "string",
1772
+ "readOnly": true
1773
+ },
1774
+ "vat_amount": {
1775
+ "type": "string",
1776
+ "readOnly": true
1777
+ },
1778
+ "retention_amount": {
1779
+ "type": "string",
1780
+ "readOnly": true
1781
+ },
1782
+ "issuing_name": {
1783
+ "type": "string",
1784
+ "readOnly": true
1785
+ },
1786
+ "issuing_tax_id": {
1787
+ "type": "string",
1788
+ "readOnly": true
1789
+ },
1790
+ "issuing_address": {
1791
+ "type": "string",
1792
+ "readOnly": true
1793
+ },
1794
+ "issuing_phone": {
1795
+ "type": "string",
1796
+ "readOnly": true
1797
+ },
1798
+ "issuing_town": {
1799
+ "type": "string",
1800
+ "readOnly": true
1801
+ },
1802
+ "issuing_zip_code": {
1803
+ "type": "string",
1804
+ "readOnly": true
1805
+ },
1806
+ "issuing_country_code": {
1807
+ "type": "string",
1808
+ "readOnly": true
1809
+ },
1810
+ "recipient_name": {
1811
+ "type": "string",
1812
+ "readOnly": true
1813
+ },
1814
+ "recipient_tax_id": {
1815
+ "type": "string",
1816
+ "readOnly": true
1817
+ },
1818
+ "recipient_address": {
1819
+ "type": "string",
1820
+ "readOnly": true
1821
+ },
1822
+ "recipient_phone": {
1823
+ "type": "string",
1824
+ "readOnly": true
1825
+ },
1826
+ "recipient_town": {
1827
+ "type": "string",
1828
+ "readOnly": true
1829
+ },
1830
+ "recipient_zip_code": {
1831
+ "type": "string",
1832
+ "readOnly": true
1833
+ },
1834
+ "recipient_country_code": {
1835
+ "type": "string",
1836
+ "readOnly": true
1837
+ },
1838
+ "last_sent_at": {
1839
+ "type": "integer",
1840
+ "format": "int64"
1841
+ },
1842
+ "tags": {
1843
+ "type": "string"
1844
+ },
1845
+ "notes": {
1846
+ "type": "string"
1847
+ },
1848
+ "download_pdf_url": {
1849
+ "type": "string",
1850
+ "readOnly": true
1851
+ },
1852
+ "ephemeral_open_download_pdf_url": {
1853
+ "type": "string",
1854
+ "readOnly": true
1855
+ }
1856
+ }
1857
+ },
1858
+ "InvoiceRelationships": {
1859
+ "type": "object",
1860
+ "properties": {
1861
+ "contact": {
1862
+ "type": "object",
1863
+ "properties": {
1864
+ "data": {
1865
+ "type": "object",
1866
+ "properties": {
1867
+ "id": {
1868
+ "type": "string"
1869
+ },
1870
+ "type": {
1871
+ "type": "string",
1872
+ "enum": ["contacts"]
1873
+ }
1874
+ }
1875
+ }
1876
+ }
1877
+ },
1878
+ "accounting_category": {
1879
+ "type": "object",
1880
+ "properties": {
1881
+ "data": {
1882
+ "type": "object",
1883
+ "nullable": true,
1884
+ "properties": {
1885
+ "id": {
1886
+ "type": "string"
1887
+ },
1888
+ "type": {
1889
+ "type": "string",
1890
+ "enum": ["accounting_categories"]
1891
+ }
1892
+ }
1893
+ }
1894
+ }
1895
+ },
1896
+ "accounting_subcategory": {
1897
+ "type": "object",
1898
+ "properties": {
1899
+ "data": {
1900
+ "type": "object",
1901
+ "nullable": true,
1902
+ "properties": {
1903
+ "id": {
1904
+ "type": "string"
1905
+ },
1906
+ "type": {
1907
+ "type": "string",
1908
+ "enum": ["accounting_subcategories"]
1909
+ }
1910
+ }
1911
+ }
1912
+ }
1913
+ },
1914
+ "numeration": {
1915
+ "type": "object",
1916
+ "properties": {
1917
+ "data": {
1918
+ "type": "object",
1919
+ "nullable": true,
1920
+ "properties": {
1921
+ "id": {
1922
+ "type": "string"
1923
+ },
1924
+ "type": {
1925
+ "type": "string",
1926
+ "enum": ["numbering_series"]
1927
+ }
1928
+ }
1929
+ }
1930
+ }
1931
+ },
1932
+ "analytic_categories": {
1933
+ "type": "object",
1934
+ "properties": {
1935
+ "data": {
1936
+ "type": "array",
1937
+ "items": {
1938
+ "type": "object",
1939
+ "properties": {
1940
+ "id": {
1941
+ "type": "string"
1942
+ },
1943
+ "type": {
1944
+ "type": "string",
1945
+ "enum": ["analytic_categories"]
1946
+ }
1947
+ }
1948
+ }
1949
+ }
1950
+ }
1951
+ },
1952
+ "items": {
1953
+ "type": "object",
1954
+ "properties": {
1955
+ "data": {
1956
+ "type": "array",
1957
+ "items": {
1958
+ "oneOf": [
1959
+ {
1960
+ "$ref": "#/components/schemas/ItemInvoiceCreate"
1961
+ },
1962
+ {
1963
+ "$ref": "#/components/schemas/ItemInvoiceUpdate"
1964
+ }
1965
+ ]
1966
+ }
1967
+ }
1968
+ }
1969
+ },
1970
+ "amended_invoice": {
1971
+ "type": "object",
1972
+ "properties": {
1973
+ "data": {
1974
+ "type": "object",
1975
+ "nullable": true,
1976
+ "properties": {
1977
+ "id": {
1978
+ "type": "string"
1979
+ },
1980
+ "type": {
1981
+ "type": "string",
1982
+ "enum": ["invoices"]
1983
+ }
1984
+ }
1985
+ }
1986
+ }
1987
+ },
1988
+ "amending_invoices": {
1989
+ "type": "object",
1990
+ "readOnly": true,
1991
+ "properties": {
1992
+ "data": {
1993
+ "type": "array",
1994
+ "items": {
1995
+ "type": "object",
1996
+ "properties": {
1997
+ "id": {
1998
+ "type": "string"
1999
+ },
2000
+ "type": {
2001
+ "type": "string",
2002
+ "enum": ["invoices"]
2003
+ }
2004
+ }
2005
+ }
2006
+ }
2007
+ }
2008
+ }
2009
+ }
2010
+ },
2011
+ "InvoiceData": {
2012
+ "type": "object",
2013
+ "properties": {
2014
+ "id": {
2015
+ "type": "string"
2016
+ },
2017
+ "type": {
2018
+ "type": "string",
2019
+ "enum": ["invoices"]
2020
+ },
2021
+ "attributes": {
2022
+ "$ref": "#/components/schemas/InvoiceAttributes"
2023
+ },
2024
+ "relationships": {
2025
+ "$ref": "#/components/schemas/InvoiceRelationships"
2026
+ }
2027
+ }
2028
+ },
2029
+ "InvoiceCreate": {
2030
+ "type": "object",
2031
+ "required": ["data"],
2032
+ "properties": {
2033
+ "data": {
2034
+ "type": "object",
2035
+ "required": ["type"],
2036
+ "properties": {
2037
+ "type": {
2038
+ "type": "string",
2039
+ "enum": ["invoices"]
2040
+ },
2041
+ "attributes": {
2042
+ "$ref": "#/components/schemas/InvoiceAttributes"
2043
+ },
2044
+ "relationships": {
2045
+ "$ref": "#/components/schemas/InvoiceRelationships"
2046
+ }
2047
+ }
2048
+ }
2049
+ }
2050
+ },
2051
+ "InvoiceUpdate": {
2052
+ "type": "object",
2053
+ "required": ["data"],
2054
+ "properties": {
2055
+ "data": {
2056
+ "type": "object",
2057
+ "required": ["type", "id"],
2058
+ "properties": {
2059
+ "id": {
2060
+ "type": "string"
2061
+ },
2062
+ "type": {
2063
+ "type": "string",
2064
+ "enum": ["invoices"]
2065
+ },
2066
+ "attributes": {
2067
+ "$ref": "#/components/schemas/InvoiceAttributes"
2068
+ },
2069
+ "relationships": {
2070
+ "$ref": "#/components/schemas/InvoiceRelationships"
2071
+ }
2072
+ }
2073
+ }
2074
+ }
2075
+ },
2076
+ "InvoiceResponse": {
2077
+ "type": "object",
2078
+ "properties": {
2079
+ "data": {
2080
+ "$ref": "#/components/schemas/InvoiceData"
2081
+ },
2082
+ "included": {
2083
+ "type": "array",
2084
+ "items": {
2085
+ "type": "object",
2086
+ "properties": {
2087
+ "id": {
2088
+ "type": "string"
2089
+ },
2090
+ "type": {
2091
+ "type": "string"
2092
+ },
2093
+ "attributes": {
2094
+ "type": "object"
2095
+ }
2096
+ }
2097
+ }
2098
+ }
2099
+ }
2100
+ },
2101
+ "InvoiceCollection": {
2102
+ "allOf": [
2103
+ {
2104
+ "$ref": "#/components/schemas/PaginationMeta"
2105
+ },
2106
+ {
2107
+ "type": "object",
2108
+ "properties": {
2109
+ "data": {
2110
+ "type": "array",
2111
+ "items": {
2112
+ "$ref": "#/components/schemas/InvoiceData"
2113
+ }
2114
+ },
2115
+ "included": {
2116
+ "type": "array",
2117
+ "items": {
2118
+ "type": "object",
2119
+ "properties": {
2120
+ "id": {
2121
+ "type": "string"
2122
+ },
2123
+ "type": {
2124
+ "type": "string"
2125
+ },
2126
+ "attributes": {
2127
+ "type": "object"
2128
+ }
2129
+ }
2130
+ }
2131
+ }
2132
+ }
2133
+ }
2134
+ ]
2135
+ },
2136
+ "TicketAttributes": {
2137
+ "type": "object",
2138
+ "properties": {
2139
+ "kind": {
2140
+ "type": "string",
2141
+ "enum": ["income", "expenses"]
2142
+ },
2143
+ "number": {
2144
+ "type": "string"
2145
+ },
2146
+ "issue_date": {
2147
+ "type": "string",
2148
+ "format": "date"
2149
+ },
2150
+ "paid_at": {
2151
+ "type": "string",
2152
+ "format": "date",
2153
+ "nullable": true
2154
+ },
2155
+ "payment_method": {
2156
+ "type": "string",
2157
+ "enum": [
2158
+ "cash",
2159
+ "bank_transfer",
2160
+ "bank_card",
2161
+ "direct_debit",
2162
+ "paypal",
2163
+ "check",
2164
+ "factoring"
2165
+ ]
2166
+ },
2167
+ "payment_status": {
2168
+ "type": "string",
2169
+ "enum": ["paid", "unpaid", "due", "pending"],
2170
+ "readOnly": true
2171
+ },
2172
+ "validation_status": {
2173
+ "type": "string",
2174
+ "enum": ["pending", "verified"],
2175
+ "readOnly": true
2176
+ },
2177
+ "total_amount": {
2178
+ "type": "string",
2179
+ "readOnly": true
2180
+ },
2181
+ "total_amount_without_taxes": {
2182
+ "type": "string",
2183
+ "readOnly": true
2184
+ },
2185
+ "vat_amount": {
2186
+ "type": "string",
2187
+ "readOnly": true
2188
+ },
2189
+ "issuing_name": {
2190
+ "type": "string"
2191
+ },
2192
+ "issuing_tax_id": {
2193
+ "type": "string",
2194
+ "readOnly": true,
2195
+ "nullable": true
2196
+ },
2197
+ "issuing_address": {
2198
+ "type": "string",
2199
+ "readOnly": true,
2200
+ "nullable": true
2201
+ },
2202
+ "issuing_phone": {
2203
+ "type": "string",
2204
+ "readOnly": true,
2205
+ "nullable": true
2206
+ },
2207
+ "issuing_town": {
2208
+ "type": "string",
2209
+ "readOnly": true,
2210
+ "nullable": true
2211
+ },
2212
+ "issuing_zip_code": {
2213
+ "type": "string",
2214
+ "readOnly": true,
2215
+ "nullable": true
2216
+ },
2217
+ "issuing_country_code": {
2218
+ "type": "string",
2219
+ "readOnly": true,
2220
+ "nullable": true
2221
+ },
2222
+ "recipient_name": {
2223
+ "type": "string"
2224
+ },
2225
+ "recipient_tax_id": {
2226
+ "type": "string",
2227
+ "readOnly": true
2228
+ },
2229
+ "recipient_address": {
2230
+ "type": "string",
2231
+ "readOnly": true
2232
+ },
2233
+ "recipient_phone": {
2234
+ "type": "string",
2235
+ "readOnly": true
2236
+ },
2237
+ "recipient_town": {
2238
+ "type": "string",
2239
+ "readOnly": true
2240
+ },
2241
+ "recipient_zip_code": {
2242
+ "type": "string",
2243
+ "readOnly": true
2244
+ },
2245
+ "recipient_country_code": {
2246
+ "type": "string",
2247
+ "readOnly": true
2248
+ },
2249
+ "tags": {
2250
+ "type": "string"
2251
+ },
2252
+ "notes": {
2253
+ "type": "string"
2254
+ },
2255
+ "download_pdf_url": {
2256
+ "type": "string",
2257
+ "readOnly": true
2258
+ }
2259
+ }
2260
+ },
2261
+ "TicketRelationships": {
2262
+ "type": "object",
2263
+ "properties": {
2264
+ "accounting_category": {
2265
+ "type": "object",
2266
+ "properties": {
2267
+ "data": {
2268
+ "type": "object",
2269
+ "nullable": true,
2270
+ "properties": {
2271
+ "id": {
2272
+ "type": "string"
2273
+ },
2274
+ "type": {
2275
+ "type": "string",
2276
+ "enum": ["accounting_categories"]
2277
+ }
2278
+ }
2279
+ }
2280
+ }
2281
+ },
2282
+ "accounting_subcategory": {
2283
+ "type": "object",
2284
+ "properties": {
2285
+ "data": {
2286
+ "type": "object",
2287
+ "nullable": true,
2288
+ "properties": {
2289
+ "id": {
2290
+ "type": "string"
2291
+ },
2292
+ "type": {
2293
+ "type": "string",
2294
+ "enum": ["accounting_subcategories"]
2295
+ }
2296
+ }
2297
+ }
2298
+ }
2299
+ },
2300
+ "numeration": {
2301
+ "type": "object",
2302
+ "properties": {
2303
+ "data": {
2304
+ "type": "object",
2305
+ "nullable": true,
2306
+ "properties": {
2307
+ "id": {
2308
+ "type": "string"
2309
+ },
2310
+ "type": {
2311
+ "type": "string",
2312
+ "enum": ["numbering_series"]
2313
+ }
2314
+ }
2315
+ }
2316
+ }
2317
+ },
2318
+ "analytic_categories": {
2319
+ "type": "object",
2320
+ "properties": {
2321
+ "data": {
2322
+ "type": "array",
2323
+ "items": {
2324
+ "type": "object",
2325
+ "properties": {
2326
+ "id": {
2327
+ "type": "string"
2328
+ },
2329
+ "type": {
2330
+ "type": "string",
2331
+ "enum": ["analytic_categories"]
2332
+ }
2333
+ }
2334
+ }
2335
+ }
2336
+ }
2337
+ },
2338
+ "items": {
2339
+ "type": "object",
2340
+ "properties": {
2341
+ "data": {
2342
+ "type": "array",
2343
+ "items": {
2344
+ "oneOf": [
2345
+ {
2346
+ "$ref": "#/components/schemas/ItemInvoiceCreate"
2347
+ },
2348
+ {
2349
+ "$ref": "#/components/schemas/ItemInvoiceUpdate"
2350
+ }
2351
+ ]
2352
+ }
2353
+ }
2354
+ }
2355
+ },
2356
+ "amended_ticket": {
2357
+ "type": "object",
2358
+ "properties": {
2359
+ "data": {
2360
+ "type": "object",
2361
+ "nullable": true,
2362
+ "properties": {
2363
+ "id": {
2364
+ "type": "string"
2365
+ },
2366
+ "type": {
2367
+ "type": "string",
2368
+ "enum": ["tickets"]
2369
+ }
2370
+ }
2371
+ }
2372
+ }
2373
+ },
2374
+ "amending_tickets": {
2375
+ "type": "object",
2376
+ "readOnly": true,
2377
+ "properties": {
2378
+ "data": {
2379
+ "type": "array",
2380
+ "items": {
2381
+ "type": "object",
2382
+ "properties": {
2383
+ "id": {
2384
+ "type": "string"
2385
+ },
2386
+ "type": {
2387
+ "type": "string",
2388
+ "enum": ["tickets"]
2389
+ }
2390
+ }
2391
+ }
2392
+ }
2393
+ }
2394
+ }
2395
+ }
2396
+ },
2397
+ "TicketData": {
2398
+ "type": "object",
2399
+ "properties": {
2400
+ "id": {
2401
+ "type": "string"
2402
+ },
2403
+ "type": {
2404
+ "type": "string",
2405
+ "enum": ["tickets"]
2406
+ },
2407
+ "attributes": {
2408
+ "$ref": "#/components/schemas/TicketAttributes"
2409
+ },
2410
+ "relationships": {
2411
+ "$ref": "#/components/schemas/TicketRelationships"
2412
+ }
2413
+ }
2414
+ },
2415
+ "TicketCreate": {
2416
+ "type": "object",
2417
+ "required": ["data"],
2418
+ "properties": {
2419
+ "data": {
2420
+ "type": "object",
2421
+ "required": ["type"],
2422
+ "properties": {
2423
+ "type": {
2424
+ "type": "string",
2425
+ "enum": ["tickets"]
2426
+ },
2427
+ "attributes": {
2428
+ "$ref": "#/components/schemas/TicketAttributes"
2429
+ },
2430
+ "relationships": {
2431
+ "$ref": "#/components/schemas/TicketRelationships"
2432
+ }
2433
+ }
2434
+ }
2435
+ }
2436
+ },
2437
+ "TicketUpdate": {
2438
+ "type": "object",
2439
+ "required": ["data"],
2440
+ "properties": {
2441
+ "data": {
2442
+ "type": "object",
2443
+ "required": ["type", "id"],
2444
+ "properties": {
2445
+ "id": {
2446
+ "type": "string"
2447
+ },
2448
+ "type": {
2449
+ "type": "string",
2450
+ "enum": ["tickets"]
2451
+ },
2452
+ "attributes": {
2453
+ "$ref": "#/components/schemas/TicketAttributes"
2454
+ },
2455
+ "relationships": {
2456
+ "$ref": "#/components/schemas/TicketRelationships"
2457
+ }
2458
+ }
2459
+ }
2460
+ }
2461
+ },
2462
+ "TicketResponse": {
2463
+ "type": "object",
2464
+ "properties": {
2465
+ "data": {
2466
+ "$ref": "#/components/schemas/TicketData"
2467
+ },
2468
+ "included": {
2469
+ "type": "array",
2470
+ "items": {
2471
+ "type": "object",
2472
+ "properties": {
2473
+ "id": {
2474
+ "type": "string"
2475
+ },
2476
+ "type": {
2477
+ "type": "string"
2478
+ },
2479
+ "attributes": {
2480
+ "type": "object"
2481
+ }
2482
+ }
2483
+ }
2484
+ }
2485
+ }
2486
+ },
2487
+ "TicketCollection": {
2488
+ "allOf": [
2489
+ {
2490
+ "$ref": "#/components/schemas/PaginationMeta"
2491
+ },
2492
+ {
2493
+ "type": "object",
2494
+ "properties": {
2495
+ "data": {
2496
+ "type": "array",
2497
+ "items": {
2498
+ "$ref": "#/components/schemas/TicketData"
2499
+ }
2500
+ },
2501
+ "included": {
2502
+ "type": "array",
2503
+ "items": {
2504
+ "type": "object",
2505
+ "properties": {
2506
+ "id": {
2507
+ "type": "string"
2508
+ },
2509
+ "type": {
2510
+ "type": "string"
2511
+ },
2512
+ "attributes": {
2513
+ "type": "object"
2514
+ }
2515
+ }
2516
+ }
2517
+ }
2518
+ }
2519
+ }
2520
+ ]
2521
+ },
2522
+ "PaysheetAttributes": {
2523
+ "type": "object",
2524
+ "properties": {
2525
+ "kind": {
2526
+ "type": "string",
2527
+ "enum": ["expenses"],
2528
+ "readOnly": true
2529
+ },
2530
+ "number": {
2531
+ "type": "string"
2532
+ },
2533
+ "issue_date": {
2534
+ "type": "string",
2535
+ "format": "date"
2536
+ },
2537
+ "paid_at": {
2538
+ "type": "string",
2539
+ "format": "date",
2540
+ "nullable": true
2541
+ },
2542
+ "payment_method": {
2543
+ "type": "string",
2544
+ "enum": [
2545
+ "cash",
2546
+ "bank_transfer",
2547
+ "bank_card",
2548
+ "direct_debit",
2549
+ "paypal",
2550
+ "check",
2551
+ "factoring"
2552
+ ]
2553
+ },
2554
+ "payment_status": {
2555
+ "type": "string",
2556
+ "enum": ["paid", "unpaid", "due", "pending"],
2557
+ "readOnly": true
2558
+ },
2559
+ "net_pay": {
2560
+ "type": "string"
2561
+ },
2562
+ "gross_pay": {
2563
+ "type": "string",
2564
+ "readOnly": true
2565
+ },
2566
+ "employee_ss_amount": {
2567
+ "type": "string"
2568
+ },
2569
+ "employee_retention": {
2570
+ "type": "string"
2571
+ },
2572
+ "company_ss_amount": {
2573
+ "type": "string"
2574
+ },
2575
+ "issuing_name": {
2576
+ "type": "string",
2577
+ "readOnly": true
2578
+ },
2579
+ "issuing_tax_id": {
2580
+ "type": "string",
2581
+ "readOnly": true
2582
+ },
2583
+ "issuing_address": {
2584
+ "type": "string",
2585
+ "readOnly": true
2586
+ },
2587
+ "issuing_phone": {
2588
+ "type": "string",
2589
+ "readOnly": true
2590
+ },
2591
+ "issuing_town": {
2592
+ "type": "string",
2593
+ "readOnly": true
2594
+ },
2595
+ "issuing_zip_code": {
2596
+ "type": "string",
2597
+ "readOnly": true
2598
+ },
2599
+ "issuing_country_code": {
2600
+ "type": "string",
2601
+ "readOnly": true
2602
+ },
2603
+ "recipient_name": {
2604
+ "type": "string",
2605
+ "readOnly": true
2606
+ },
2607
+ "recipient_tax_id": {
2608
+ "type": "string",
2609
+ "readOnly": true
2610
+ },
2611
+ "recipient_address": {
2612
+ "type": "string",
2613
+ "readOnly": true
2614
+ },
2615
+ "recipient_phone": {
2616
+ "type": "string",
2617
+ "readOnly": true
2618
+ },
2619
+ "recipient_town": {
2620
+ "type": "string",
2621
+ "readOnly": true
2622
+ },
2623
+ "recipient_zip_code": {
2624
+ "type": "string",
2625
+ "readOnly": true
2626
+ },
2627
+ "recipient_country_code": {
2628
+ "type": "string",
2629
+ "readOnly": true
2630
+ },
2631
+ "tags": {
2632
+ "type": "string"
2633
+ }
2634
+ }
2635
+ },
2636
+ "PaysheetRelationships": {
2637
+ "type": "object",
2638
+ "properties": {
2639
+ "contact": {
2640
+ "type": "object",
2641
+ "properties": {
2642
+ "data": {
2643
+ "type": "object",
2644
+ "properties": {
2645
+ "id": {
2646
+ "type": "string"
2647
+ },
2648
+ "type": {
2649
+ "type": "string",
2650
+ "enum": ["contacts"]
2651
+ }
2652
+ }
2653
+ }
2654
+ }
2655
+ },
2656
+ "accounting_category": {
2657
+ "type": "object",
2658
+ "properties": {
2659
+ "data": {
2660
+ "type": "object",
2661
+ "nullable": true,
2662
+ "properties": {
2663
+ "id": {
2664
+ "type": "string"
2665
+ },
2666
+ "type": {
2667
+ "type": "string",
2668
+ "enum": ["accounting_categories"]
2669
+ }
2670
+ }
2671
+ }
2672
+ }
2673
+ },
2674
+ "accounting_subcategory": {
2675
+ "type": "object",
2676
+ "properties": {
2677
+ "data": {
2678
+ "type": "object",
2679
+ "nullable": true,
2680
+ "properties": {
2681
+ "id": {
2682
+ "type": "string"
2683
+ },
2684
+ "type": {
2685
+ "type": "string",
2686
+ "enum": ["accounting_subcategories"]
2687
+ }
2688
+ }
2689
+ }
2690
+ }
2691
+ },
2692
+ "numeration": {
2693
+ "type": "object",
2694
+ "properties": {
2695
+ "data": {
2696
+ "type": "object",
2697
+ "nullable": true,
2698
+ "properties": {
2699
+ "id": {
2700
+ "type": "string"
2701
+ },
2702
+ "type": {
2703
+ "type": "string",
2704
+ "enum": ["numbering_series"]
2705
+ }
2706
+ }
2707
+ }
2708
+ }
2709
+ },
2710
+ "analytic_categories": {
2711
+ "type": "object",
2712
+ "properties": {
2713
+ "data": {
2714
+ "type": "array",
2715
+ "items": {
2716
+ "type": "object",
2717
+ "properties": {
2718
+ "id": {
2719
+ "type": "string"
2720
+ },
2721
+ "type": {
2722
+ "type": "string",
2723
+ "enum": ["analytic_categories"]
2724
+ }
2725
+ }
2726
+ }
2727
+ }
2728
+ }
2729
+ }
2730
+ }
2731
+ },
2732
+ "PaysheetData": {
2733
+ "type": "object",
2734
+ "properties": {
2735
+ "id": {
2736
+ "type": "string"
2737
+ },
2738
+ "type": {
2739
+ "type": "string",
2740
+ "enum": ["paysheets"]
2741
+ },
2742
+ "attributes": {
2743
+ "$ref": "#/components/schemas/PaysheetAttributes"
2744
+ },
2745
+ "relationships": {
2746
+ "$ref": "#/components/schemas/PaysheetRelationships"
2747
+ }
2748
+ }
2749
+ },
2750
+ "PaysheetCreate": {
2751
+ "type": "object",
2752
+ "required": ["data"],
2753
+ "properties": {
2754
+ "data": {
2755
+ "type": "object",
2756
+ "required": ["type"],
2757
+ "properties": {
2758
+ "type": {
2759
+ "type": "string",
2760
+ "enum": ["paysheets"]
2761
+ },
2762
+ "attributes": {
2763
+ "$ref": "#/components/schemas/PaysheetAttributes"
2764
+ },
2765
+ "relationships": {
2766
+ "$ref": "#/components/schemas/PaysheetRelationships"
2767
+ }
2768
+ }
2769
+ }
2770
+ }
2771
+ },
2772
+ "PaysheetUpdate": {
2773
+ "type": "object",
2774
+ "required": ["data"],
2775
+ "properties": {
2776
+ "data": {
2777
+ "type": "object",
2778
+ "required": ["type", "id"],
2779
+ "properties": {
2780
+ "id": {
2781
+ "type": "string"
2782
+ },
2783
+ "type": {
2784
+ "type": "string",
2785
+ "enum": ["paysheets"]
2786
+ },
2787
+ "attributes": {
2788
+ "$ref": "#/components/schemas/PaysheetAttributes"
2789
+ },
2790
+ "relationships": {
2791
+ "$ref": "#/components/schemas/PaysheetRelationships"
2792
+ }
2793
+ }
2794
+ }
2795
+ }
2796
+ },
2797
+ "PaysheetResponse": {
2798
+ "type": "object",
2799
+ "properties": {
2800
+ "data": {
2801
+ "$ref": "#/components/schemas/PaysheetData"
2802
+ }
2803
+ }
2804
+ },
2805
+ "PaysheetCollection": {
2806
+ "allOf": [
2807
+ {
2808
+ "$ref": "#/components/schemas/PaginationMeta"
2809
+ },
2810
+ {
2811
+ "type": "object",
2812
+ "properties": {
2813
+ "data": {
2814
+ "type": "array",
2815
+ "items": {
2816
+ "$ref": "#/components/schemas/PaysheetData"
2817
+ }
2818
+ }
2819
+ }
2820
+ }
2821
+ ]
2822
+ },
2823
+ "NumberingSeriesAttributes": {
2824
+ "type": "object",
2825
+ "properties": {
2826
+ "prefix": {
2827
+ "type": "string"
2828
+ },
2829
+ "applicable_to": {
2830
+ "type": "string",
2831
+ "enum": ["invoices", "tickets"]
2832
+ },
2833
+ "default": {
2834
+ "type": "boolean"
2835
+ },
2836
+ "amending": {
2837
+ "type": "boolean"
2838
+ },
2839
+ "deletable": {
2840
+ "type": "boolean",
2841
+ "readOnly": true
2842
+ }
2843
+ }
2844
+ },
2845
+ "NumberingSeriesData": {
2846
+ "type": "object",
2847
+ "properties": {
2848
+ "id": {
2849
+ "type": "string"
2850
+ },
2851
+ "type": {
2852
+ "type": "string",
2853
+ "enum": ["numbering_series"]
2854
+ },
2855
+ "attributes": {
2856
+ "$ref": "#/components/schemas/NumberingSeriesAttributes"
2857
+ }
2858
+ }
2859
+ },
2860
+ "NumberingSeriesCreate": {
2861
+ "type": "object",
2862
+ "required": ["data"],
2863
+ "properties": {
2864
+ "data": {
2865
+ "type": "object",
2866
+ "required": ["type", "attributes"],
2867
+ "properties": {
2868
+ "type": {
2869
+ "type": "string",
2870
+ "enum": ["numbering_series"]
2871
+ },
2872
+ "attributes": {
2873
+ "$ref": "#/components/schemas/NumberingSeriesAttributes"
2874
+ }
2875
+ }
2876
+ }
2877
+ }
2878
+ },
2879
+ "NumberingSeriesUpdate": {
2880
+ "type": "object",
2881
+ "required": ["data"],
2882
+ "properties": {
2883
+ "data": {
2884
+ "type": "object",
2885
+ "required": ["type", "id"],
2886
+ "properties": {
2887
+ "id": {
2888
+ "type": "string"
2889
+ },
2890
+ "type": {
2891
+ "type": "string",
2892
+ "enum": ["numbering_series"]
2893
+ },
2894
+ "attributes": {
2895
+ "$ref": "#/components/schemas/NumberingSeriesAttributes"
2896
+ }
2897
+ }
2898
+ }
2899
+ }
2900
+ },
2901
+ "NumberingSeriesResponse": {
2902
+ "type": "object",
2903
+ "properties": {
2904
+ "data": {
2905
+ "$ref": "#/components/schemas/NumberingSeriesData"
2906
+ }
2907
+ }
2908
+ },
2909
+ "NumberingSeriesCollection": {
2910
+ "type": "object",
2911
+ "properties": {
2912
+ "data": {
2913
+ "type": "array",
2914
+ "items": {
2915
+ "$ref": "#/components/schemas/NumberingSeriesData"
2916
+ }
2917
+ }
2918
+ }
2919
+ },
2920
+ "AccountingCategoryAttributes": {
2921
+ "type": "object",
2922
+ "properties": {
2923
+ "prefix": {
2924
+ "type": "string",
2925
+ "readOnly": true
2926
+ },
2927
+ "name": {
2928
+ "type": "string",
2929
+ "readOnly": true
2930
+ },
2931
+ "kind": {
2932
+ "type": "string",
2933
+ "enum": ["income", "expenses", "assets"],
2934
+ "readOnly": true
2935
+ }
2936
+ }
2937
+ },
2938
+ "AccountingCategoryData": {
2939
+ "type": "object",
2940
+ "properties": {
2941
+ "id": {
2942
+ "type": "string"
2943
+ },
2944
+ "type": {
2945
+ "type": "string",
2946
+ "enum": ["accounting_categories"]
2947
+ },
2948
+ "attributes": {
2949
+ "$ref": "#/components/schemas/AccountingCategoryAttributes"
2950
+ }
2951
+ }
2952
+ },
2953
+ "AccountingCategoryResponse": {
2954
+ "type": "object",
2955
+ "properties": {
2956
+ "data": {
2957
+ "$ref": "#/components/schemas/AccountingCategoryData"
2958
+ }
2959
+ }
2960
+ },
2961
+ "AccountingCategoryCollection": {
2962
+ "type": "object",
2963
+ "properties": {
2964
+ "data": {
2965
+ "type": "array",
2966
+ "items": {
2967
+ "$ref": "#/components/schemas/AccountingCategoryData"
2968
+ }
2969
+ }
2970
+ }
2971
+ },
2972
+ "AccountingSubcategoryAttributes": {
2973
+ "type": "object",
2974
+ "properties": {
2975
+ "suffix": {
2976
+ "type": "string"
2977
+ },
2978
+ "name": {
2979
+ "type": "string"
2980
+ }
2981
+ }
2982
+ },
2983
+ "AccountingSubcategoryRelationships": {
2984
+ "type": "object",
2985
+ "properties": {
2986
+ "accounting_category": {
2987
+ "type": "object",
2988
+ "properties": {
2989
+ "data": {
2990
+ "type": "object",
2991
+ "properties": {
2992
+ "id": {
2993
+ "type": "string"
2994
+ },
2995
+ "type": {
2996
+ "type": "string",
2997
+ "enum": ["accounting_categories"]
2998
+ }
2999
+ }
3000
+ }
3001
+ }
3002
+ }
3003
+ }
3004
+ },
3005
+ "AccountingSubcategoryData": {
3006
+ "type": "object",
3007
+ "properties": {
3008
+ "id": {
3009
+ "type": "string"
3010
+ },
3011
+ "type": {
3012
+ "type": "string",
3013
+ "enum": ["accounting_subcategories"]
3014
+ },
3015
+ "attributes": {
3016
+ "$ref": "#/components/schemas/AccountingSubcategoryAttributes"
3017
+ },
3018
+ "relationships": {
3019
+ "$ref": "#/components/schemas/AccountingSubcategoryRelationships"
3020
+ }
3021
+ }
3022
+ },
3023
+ "AccountingSubcategoryCreate": {
3024
+ "type": "object",
3025
+ "required": ["data"],
3026
+ "properties": {
3027
+ "data": {
3028
+ "type": "object",
3029
+ "required": ["type", "attributes", "relationships"],
3030
+ "properties": {
3031
+ "type": {
3032
+ "type": "string",
3033
+ "enum": ["accounting_subcategories"]
3034
+ },
3035
+ "attributes": {
3036
+ "$ref": "#/components/schemas/AccountingSubcategoryAttributes"
3037
+ },
3038
+ "relationships": {
3039
+ "$ref": "#/components/schemas/AccountingSubcategoryRelationships"
3040
+ }
3041
+ }
3042
+ }
3043
+ }
3044
+ },
3045
+ "AccountingSubcategoryUpdate": {
3046
+ "type": "object",
3047
+ "required": ["data"],
3048
+ "properties": {
3049
+ "data": {
3050
+ "type": "object",
3051
+ "required": ["type", "attributes"],
3052
+ "properties": {
3053
+ "type": {
3054
+ "type": "string",
3055
+ "enum": ["accounting_subcategories"]
3056
+ },
3057
+ "attributes": {
3058
+ "$ref": "#/components/schemas/AccountingSubcategoryAttributes"
3059
+ }
3060
+ }
3061
+ }
3062
+ }
3063
+ },
3064
+ "AccountingSubcategoryResponse": {
3065
+ "type": "object",
3066
+ "properties": {
3067
+ "data": {
3068
+ "$ref": "#/components/schemas/AccountingSubcategoryData"
3069
+ }
3070
+ }
3071
+ },
3072
+ "AccountingSubcategoryCollection": {
3073
+ "type": "object",
3074
+ "properties": {
3075
+ "data": {
3076
+ "type": "array",
3077
+ "items": {
3078
+ "$ref": "#/components/schemas/AccountingSubcategoryData"
3079
+ }
3080
+ }
3081
+ }
3082
+ },
3083
+ "AttachmentAttributes": {
3084
+ "type": "object",
3085
+ "properties": {
3086
+ "url": {
3087
+ "type": "string"
3088
+ },
3089
+ "small_url": {
3090
+ "type": "string"
3091
+ },
3092
+ "thumbnail_url": {
3093
+ "type": "string"
3094
+ }
3095
+ }
3096
+ },
3097
+ "AttachmentRelationships": {
3098
+ "type": "object",
3099
+ "properties": {
3100
+ "book_entry": {
3101
+ "type": "object",
3102
+ "properties": {
3103
+ "data": {
3104
+ "type": "object",
3105
+ "properties": {
3106
+ "id": {
3107
+ "type": "string"
3108
+ },
3109
+ "type": {
3110
+ "type": "string",
3111
+ "enum": ["invoices", "tickets", "paysheets"]
3112
+ }
3113
+ }
3114
+ }
3115
+ }
3116
+ }
3117
+ }
3118
+ },
3119
+ "AttachmentData": {
3120
+ "type": "object",
3121
+ "properties": {
3122
+ "id": {
3123
+ "type": "string"
3124
+ },
3125
+ "type": {
3126
+ "type": "string",
3127
+ "enum": ["attachments"]
3128
+ },
3129
+ "attributes": {
3130
+ "$ref": "#/components/schemas/AttachmentAttributes"
3131
+ },
3132
+ "relationships": {
3133
+ "$ref": "#/components/schemas/AttachmentRelationships"
3134
+ }
3135
+ }
3136
+ },
3137
+ "AttachmentResponse": {
3138
+ "type": "object",
3139
+ "properties": {
3140
+ "data": {
3141
+ "$ref": "#/components/schemas/AttachmentData"
3142
+ }
3143
+ }
3144
+ }
3145
+ }
3146
+ }
3147
+ }