@teamleader/focus-api-specification 1.20.0 → 1.22.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.
@@ -3,7 +3,7 @@ info:
3
3
  title: Teamleader API
4
4
  description: This is the documentation of the Teamleader Focus API. If you have any feedback, or are you missing functionality to support your use case? Let us know via [api@teamleader.eu](mailto:api@teamleader.eu).
5
5
  contact: {}
6
- version: 1.20.0
6
+ version: 1.22.0
7
7
  servers:
8
8
  - url: https://api.focus.teamleader.eu
9
9
  variables: {}
@@ -177,6 +177,27 @@ tags:
177
177
  - name: payment_methods
178
178
  x-displayName: Payment Methods
179
179
  description: Payment Methods
180
+ - name: expenses
181
+ description: Expenses
182
+ x-displayName: Expenses
183
+ - name: bookkeeping_submissions
184
+ description: Bookkeeping Submissions
185
+ x-displayName: Bookkeeping Submissions
186
+ - name: incoming_credit_notes
187
+ description: |
188
+ Incoming credit notes are credit notes received from your suppliers. They
189
+ can be added, approved, refused or sent to bookkeeping.
190
+ x-displayName: Incoming Credit Notes
191
+ - name: incoming_invoices
192
+ description: |
193
+ Incoming invoices are invoices received from your suppliers. They can be
194
+ added, approved, refused or sent to bookkeeping.
195
+ x-displayName: Incoming Invoices
196
+ - name: receipts
197
+ description: |
198
+ Receipts are expenses for which you have a receipt, but no invoice. They can
199
+ be added, approved, refused or sent to bookkeeping.
200
+ x-displayName: Receipts
180
201
  - name: product_categories
181
202
  description: |
182
203
  Product categories are used to group specific products. They can be linked
@@ -15137,230 +15158,1928 @@ paths:
15137
15158
  /withholdingTaxRates.list:
15138
15159
  post:
15139
15160
  tags:
15140
- - withholding_tax_rates
15141
- summary: withholdingTaxRates.list
15142
- description: Get a list of available withholding tax rates.
15143
- operationId: withholdingTaxRates.list
15161
+ - withholding_tax_rates
15162
+ summary: withholdingTaxRates.list
15163
+ description: Get a list of available withholding tax rates.
15164
+ operationId: withholdingTaxRates.list
15165
+ parameters: []
15166
+ requestBody:
15167
+ description: ''
15168
+ content:
15169
+ application/json:
15170
+ schema:
15171
+ allOf:
15172
+ - title: withholdingTaxRates.listrequest
15173
+ type: object
15174
+ properties: &ref_417
15175
+ filter:
15176
+ type: object
15177
+ properties:
15178
+ department_id:
15179
+ type: string
15180
+ description: The ID of the department you wish to filter on.
15181
+ example: 080aac72-ff1a-4627-bfe3-146b6eee979c
15182
+ - example:
15183
+ filter:
15184
+ department_id: 080aac72-ff1a-4627-bfe3-146b6eee979c
15185
+ example:
15186
+ filter:
15187
+ department_id: 080aac72-ff1a-4627-bfe3-146b6eee979c
15188
+ required: true
15189
+ responses:
15190
+ '200':
15191
+ description: ''
15192
+ headers: {}
15193
+ content:
15194
+ application/json:
15195
+ schema:
15196
+ allOf:
15197
+ - title: withholdingTaxRates.listresponse
15198
+ type: object
15199
+ properties: &ref_418
15200
+ data:
15201
+ type: array
15202
+ items:
15203
+ type: object
15204
+ properties:
15205
+ id:
15206
+ type: string
15207
+ example: c93ddb52-0af8-47d9-8551-441435be66a7
15208
+ description:
15209
+ type: string
15210
+ example: 21%
15211
+ rate:
15212
+ type: number
15213
+ example: 0.21
15214
+ department:
15215
+ title: TypeAndId
15216
+ type: object
15217
+ properties: *ref_1
15218
+ description: ''
15219
+ - example:
15220
+ data:
15221
+ - id: c93ddb52-0af8-47d9-8551-441435be66a7
15222
+ department:
15223
+ type: department
15224
+ id: 182af0a8-3f68-409b-8941-cf8caf8f28a0
15225
+ description: Ritenuta d'acconto 23% su 20%
15226
+ rate: 0.046
15227
+ example:
15228
+ data:
15229
+ - id: c93ddb52-0af8-47d9-8551-441435be66a7
15230
+ department:
15231
+ type: department
15232
+ id: 182af0a8-3f68-409b-8941-cf8caf8f28a0
15233
+ description: Ritenuta d'acconto 23% su 20%
15234
+ rate: 0.046
15235
+ deprecated: false
15236
+ /commercialDiscounts.list:
15237
+ post:
15238
+ tags:
15239
+ - commercial_discounts
15240
+ summary: commercialDiscounts.list
15241
+ description: Get a list of commercial discounts.
15242
+ operationId: commercialDiscounts.list
15243
+ parameters: []
15244
+ requestBody:
15245
+ description: ''
15246
+ content:
15247
+ application/json:
15248
+ schema:
15249
+ allOf:
15250
+ - title: commercialDiscounts.listrequest
15251
+ type: object
15252
+ properties: &ref_419
15253
+ filter:
15254
+ type: object
15255
+ properties:
15256
+ department_id:
15257
+ type: string
15258
+ example: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
15259
+ - example:
15260
+ filter:
15261
+ department_id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
15262
+ example:
15263
+ filter:
15264
+ department_id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
15265
+ required: true
15266
+ responses:
15267
+ '200':
15268
+ description: ''
15269
+ headers: {}
15270
+ content:
15271
+ application/json:
15272
+ schema:
15273
+ allOf:
15274
+ - title: commercialDiscounts.listresponse
15275
+ type: object
15276
+ properties: &ref_420
15277
+ data:
15278
+ type: array
15279
+ items:
15280
+ type: object
15281
+ properties:
15282
+ name:
15283
+ type: string
15284
+ example: My holiday discount
15285
+ department:
15286
+ title: TypeAndId
15287
+ type: object
15288
+ properties: *ref_1
15289
+ description: ''
15290
+ - example:
15291
+ data:
15292
+ - name: My holiday discount
15293
+ department:
15294
+ type: department
15295
+ id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
15296
+ example:
15297
+ data:
15298
+ - name: My holiday discount
15299
+ department:
15300
+ type: department
15301
+ id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
15302
+ deprecated: false
15303
+ /paymentMethods.list:
15304
+ post:
15305
+ tags:
15306
+ - payment_methods
15307
+ summary: paymentMethods.list
15308
+ description: Get a list of payment methods.
15309
+ operationId: paymentMethods.list
15310
+ parameters: []
15311
+ requestBody:
15312
+ description: ''
15313
+ content:
15314
+ application/json:
15315
+ schema:
15316
+ allOf:
15317
+ - title: paymentMethods.listrequest
15318
+ type: object
15319
+ properties: &ref_421
15320
+ filter:
15321
+ type: object
15322
+ properties:
15323
+ ids:
15324
+ type: array
15325
+ items:
15326
+ type: string
15327
+ example:
15328
+ - 92296ad0-2d61-4179-b174-9f354ca2157f
15329
+ - 53635682-c382-4fbf-9fd9-9506ca4fbcdd
15330
+ status:
15331
+ type: array
15332
+ items:
15333
+ type: string
15334
+ enum:
15335
+ - active
15336
+ - archived
15337
+ description: Filters on status
15338
+ page:
15339
+ title: Page
15340
+ type: object
15341
+ properties: *ref_6
15342
+ required: true
15343
+ responses:
15344
+ '200':
15345
+ description: ''
15346
+ headers: {}
15347
+ content:
15348
+ application/json:
15349
+ schema:
15350
+ allOf:
15351
+ - title: paymentMethods.listresponse
15352
+ type: object
15353
+ properties: &ref_422
15354
+ data:
15355
+ type: array
15356
+ items:
15357
+ type: object
15358
+ required:
15359
+ - status
15360
+ properties:
15361
+ id:
15362
+ type: string
15363
+ example: 49b403be-a32e-0901-9b1c-25214f9027c6
15364
+ name:
15365
+ type: string
15366
+ example: Coupons
15367
+ status:
15368
+ type: string
15369
+ enum:
15370
+ - active
15371
+ - archived
15372
+ example: active
15373
+ description: ''
15374
+ - example:
15375
+ data:
15376
+ - id: 49b403be-a32e-0901-9b1c-25214f9027c6
15377
+ name: Coupons
15378
+ status: active
15379
+ example:
15380
+ data:
15381
+ - id: 49b403be-a32e-0901-9b1c-25214f9027c6
15382
+ name: Coupons
15383
+ status: active
15384
+ deprecated: false
15385
+ /bookkeepingSubmissions.list:
15386
+ post:
15387
+ summary: bookkeepingSubmissions.list
15388
+ operationId: bookkeepingSubmissions.list
15389
+ description: List all bookkeeping submissions belonging to a specific financial document id and type
15390
+ tags:
15391
+ - bookkeeping_submissions
15392
+ parameters: []
15393
+ requestBody:
15394
+ content:
15395
+ application/json:
15396
+ example:
15397
+ filter:
15398
+ subject:
15399
+ id: 018d5965-19fb-701a-af11-e80451931551
15400
+ type: incoming_invoice
15401
+ schema:
15402
+ type: object
15403
+ properties:
15404
+ filter:
15405
+ type: object
15406
+ properties:
15407
+ subject:
15408
+ type: object
15409
+ properties:
15410
+ id:
15411
+ type: string
15412
+ description: UUID of the financial document
15413
+ type:
15414
+ type: string
15415
+ enum:
15416
+ - incoming_invoice
15417
+ - incoming_credit_note
15418
+ - receipt
15419
+ required:
15420
+ - subject
15421
+ responses:
15422
+ '200':
15423
+ description: OK
15424
+ headers: {}
15425
+ content:
15426
+ application/json:
15427
+ schema:
15428
+ type: object
15429
+ properties:
15430
+ data:
15431
+ type: array
15432
+ items:
15433
+ type: object
15434
+ properties:
15435
+ id:
15436
+ type: string
15437
+ description: UUID of the Bookkeeping Submission
15438
+ subject:
15439
+ type: object
15440
+ properties:
15441
+ id:
15442
+ type: string
15443
+ type:
15444
+ type: string
15445
+ enum:
15446
+ - incoming_invoice
15447
+ - incoming_credit_note
15448
+ - receipt
15449
+ email_address:
15450
+ type: string
15451
+ description: email address where the bookkeeping submission was sent
15452
+ status:
15453
+ type: string
15454
+ enum:
15455
+ - sending
15456
+ - confirmed
15457
+ - failed
15458
+ description: the current status of the bookkeeping submission
15459
+ created_at:
15460
+ type: string
15461
+ example:
15462
+ data:
15463
+ - id: 018d5965-19fb-701a-af11-e80451931551
15464
+ subject:
15465
+ id: 018d5965-19fb-701a-af11-e80451931551
15466
+ type: incoming_invoice
15467
+ email_address: john.doe@example.com
15468
+ status: sending
15469
+ created_at: '2025-02-26 15:56:40'
15470
+ /expenses.list:
15471
+ post:
15472
+ summary: expenses.list
15473
+ operationId: expenses.list
15474
+ description: Get a list of all expenses.
15475
+ tags:
15476
+ - expenses
15477
+ parameters: []
15478
+ requestBody:
15479
+ content:
15480
+ application/json:
15481
+ example:
15482
+ filter:
15483
+ term: search terms
15484
+ source_types:
15485
+ - incomingInvoice
15486
+ - incomingCreditNote
15487
+ - receipt
15488
+ review_statuses:
15489
+ - pending
15490
+ - approved
15491
+ - refused
15492
+ bookkeeping_statuses:
15493
+ - sent
15494
+ - not_sent
15495
+ document_date:
15496
+ operator: is_empty
15497
+ value: YYYY-MM-DD
15498
+ start: YYYY-MM-DD
15499
+ end: YYYY-MM-DD
15500
+ page:
15501
+ size: 20
15502
+ number: 1
15503
+ schema:
15504
+ type: object
15505
+ properties:
15506
+ filter:
15507
+ type: object
15508
+ properties:
15509
+ term:
15510
+ type: string
15511
+ description: Filters by document number and supplier name, case-insensitive
15512
+ source_types:
15513
+ type: array
15514
+ description: Filters by one or more source types
15515
+ items:
15516
+ type: string
15517
+ enum:
15518
+ - incomingInvoice
15519
+ - incomingCreditNote
15520
+ - receipt
15521
+ review_statuses:
15522
+ type: array
15523
+ description: Filters by one or more review statuses
15524
+ items:
15525
+ type: string
15526
+ enum:
15527
+ - pending
15528
+ - approved
15529
+ - refused
15530
+ bookkeeping_statuses:
15531
+ type: array
15532
+ description: Filters by one or more bookkeeping statuses
15533
+ items:
15534
+ type: string
15535
+ enum:
15536
+ - sent
15537
+ - not_sent
15538
+ document_date:
15539
+ type: object
15540
+ properties:
15541
+ operator:
15542
+ type: string
15543
+ enum:
15544
+ - is_empty
15545
+ - between
15546
+ - equals
15547
+ - before
15548
+ - after
15549
+ value:
15550
+ type: string
15551
+ description: Required if operator is `equals`, `before`, or `after`
15552
+ start:
15553
+ type: string
15554
+ description: Required if operator is `between`
15555
+ end:
15556
+ type: string
15557
+ description: Required if operator is `between`
15558
+ required:
15559
+ - operator
15560
+ page:
15561
+ type: object
15562
+ properties:
15563
+ size:
15564
+ type: number
15565
+ default: 20
15566
+ number:
15567
+ type: number
15568
+ default: 1
15569
+ responses:
15570
+ '200':
15571
+ description: OK
15572
+ headers: {}
15573
+ content:
15574
+ application/json:
15575
+ schema:
15576
+ type: object
15577
+ properties:
15578
+ data:
15579
+ type: array
15580
+ items:
15581
+ type: object
15582
+ properties:
15583
+ source:
15584
+ type: object
15585
+ properties:
15586
+ type:
15587
+ type: string
15588
+ enum:
15589
+ - incomingInvoice
15590
+ - incomingCreditNote
15591
+ - receipt
15592
+ id:
15593
+ type: string
15594
+ origin:
15595
+ type: object
15596
+ properties:
15597
+ type:
15598
+ type: string
15599
+ enum:
15600
+ - user
15601
+ - peppolIncomingDocument
15602
+ id:
15603
+ type: string
15604
+ title:
15605
+ type: string
15606
+ supplier:
15607
+ type: object
15608
+ properties:
15609
+ type:
15610
+ type: string
15611
+ enum:
15612
+ - company
15613
+ - contact
15614
+ id:
15615
+ type: string
15616
+ nullable: true
15617
+ document_number:
15618
+ type: string
15619
+ nullable: true
15620
+ document_date:
15621
+ type: string
15622
+ nullable: true
15623
+ due_date:
15624
+ type: string
15625
+ nullable: true
15626
+ currency:
15627
+ type: object
15628
+ properties:
15629
+ code:
15630
+ title: CurrencyCode
15631
+ enum: *ref_10
15632
+ type: string
15633
+ total:
15634
+ type: object
15635
+ properties:
15636
+ tax_exclusive:
15637
+ type: object
15638
+ properties:
15639
+ amount:
15640
+ type: number
15641
+ nullable: true
15642
+ tax_inclusive:
15643
+ type: object
15644
+ properties:
15645
+ amount:
15646
+ type: number
15647
+ nullable: true
15648
+ company_entity:
15649
+ type: object
15650
+ properties:
15651
+ type:
15652
+ type: string
15653
+ id:
15654
+ type: string
15655
+ nullable: true
15656
+ file:
15657
+ type: object
15658
+ properties:
15659
+ type:
15660
+ type: string
15661
+ id:
15662
+ type: string
15663
+ nullable: true
15664
+ payment_reference:
15665
+ type: string
15666
+ nullable: true
15667
+ review_status:
15668
+ type: string
15669
+ enum:
15670
+ - pending
15671
+ - approved
15672
+ - refused
15673
+ bookkeeping_status:
15674
+ type: string
15675
+ enum:
15676
+ - not_sent
15677
+ - sent
15678
+ iban_number:
15679
+ type: string
15680
+ nullable: true
15681
+ meta:
15682
+ allOf:
15683
+ - title: Meta
15684
+ type: object
15685
+ properties: *ref_13
15686
+ description: Only included with request parameter `includes=pagination`
15687
+ - description: Only included with request parameter `includes=pagination`
15688
+ example:
15689
+ data:
15690
+ - source:
15691
+ type: incomingInvoice
15692
+ id: 018d5965-19fb-701a-af11-e80451931551
15693
+ origin:
15694
+ type: user
15695
+ id: cde0bc5f-8602-4e12-b5d3-f03436b54c0d
15696
+ title: Cost
15697
+ supplier:
15698
+ type: company
15699
+ id: f29abf48-337d-44b4-aad4-585f5277a456
15700
+ document_number: DOC-2032039
15701
+ document_date: '2024-05-11'
15702
+ due_date: '2024-06-11'
15703
+ currency:
15704
+ code: EUR
15705
+ total:
15706
+ tax_exclusive:
15707
+ amount: 100
15708
+ tax_inclusive:
15709
+ amount: 100
15710
+ company_entity:
15711
+ type: department
15712
+ id: 018fcef1-4f96-7349-9f57-1c7857023c42
15713
+ file:
15714
+ type: file
15715
+ id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
15716
+ payment_reference: PR-12345
15717
+ review_status: pending
15718
+ bookkeeping_status: not_sent
15719
+ iban_number: FR7630006000011234567890189
15720
+ meta:
15721
+ page:
15722
+ size: 10
15723
+ number: 2
15724
+ matches: 12
15725
+ /incomingCreditNotes.add:
15726
+ post:
15727
+ summary: incomingCreditNotes.add
15728
+ operationId: incomingCreditNotes.add
15729
+ description: Adds an incoming credit note.
15730
+ tags:
15731
+ - incoming_credit_notes
15732
+ parameters: []
15733
+ requestBody:
15734
+ content:
15735
+ application/json:
15736
+ example:
15737
+ title: Incoming credit note
15738
+ supplier_id: ac4a3bc5-b11f-0eb6-8c20-0f0d697f8c2a
15739
+ document_number: DOC-2032039
15740
+ invoice_date: '2024-05-11'
15741
+ due_date: '2024-06-11'
15742
+ currency:
15743
+ code: EUR
15744
+ total:
15745
+ tax_exclusive:
15746
+ amount: 100
15747
+ tax_inclusive:
15748
+ amount: 100
15749
+ company_entity_id: 018fcef1-4f96-7349-9f57-1c7857023c42
15750
+ file_id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
15751
+ payment_reference: REF-3578296
15752
+ iban_number: BE68539007547034
15753
+ schema:
15754
+ type: object
15755
+ properties:
15756
+ title:
15757
+ type: string
15758
+ supplier_id:
15759
+ type: string
15760
+ nullable: true
15761
+ document_number:
15762
+ type: string
15763
+ nullable: true
15764
+ invoice_date:
15765
+ type: string
15766
+ nullable: true
15767
+ due_date:
15768
+ type: string
15769
+ nullable: true
15770
+ currency:
15771
+ type: object
15772
+ properties:
15773
+ code:
15774
+ allOf:
15775
+ - title: CurrencyCode
15776
+ enum: *ref_10
15777
+ type: string
15778
+ - example: EUR
15779
+ required:
15780
+ - code
15781
+ total:
15782
+ type: object
15783
+ properties:
15784
+ tax_exclusive:
15785
+ type: object
15786
+ properties:
15787
+ amount:
15788
+ type: number
15789
+ required:
15790
+ - amount
15791
+ nullable: true
15792
+ tax_inclusive:
15793
+ type: object
15794
+ properties:
15795
+ amount:
15796
+ type: number
15797
+ required:
15798
+ - amount
15799
+ nullable: true
15800
+ company_entity_id:
15801
+ type: string
15802
+ description: Default company entity will be used if not provided
15803
+ file_id:
15804
+ type: string
15805
+ nullable: true
15806
+ payment_reference:
15807
+ type: string
15808
+ nullable: true
15809
+ iban_number:
15810
+ type: string
15811
+ nullable: true
15812
+ required:
15813
+ - title
15814
+ - currency
15815
+ responses:
15816
+ '201':
15817
+ description: Created
15818
+ headers: {}
15819
+ content:
15820
+ application/json:
15821
+ schema:
15822
+ type: object
15823
+ properties:
15824
+ data:
15825
+ type: object
15826
+ properties:
15827
+ type:
15828
+ type: string
15829
+ id:
15830
+ type: string
15831
+ example:
15832
+ data:
15833
+ type: incomingCreditNote
15834
+ id: 018d5965-19fb-701a-af11-e80451931551
15835
+ /incomingCreditNotes.approve:
15836
+ post:
15837
+ summary: incomingCreditNotes.approve
15838
+ operationId: incomingCreditNotes.approve
15839
+ description: Approve an incoming credit note.
15840
+ tags:
15841
+ - incoming_credit_notes
15842
+ parameters: []
15843
+ requestBody:
15844
+ content:
15845
+ application/json:
15846
+ example:
15847
+ id: 018d5965-19fb-701a-af11-e80451931551
15848
+ schema:
15849
+ type: object
15850
+ properties:
15851
+ id:
15852
+ type: string
15853
+ required:
15854
+ - id
15855
+ responses:
15856
+ '204':
15857
+ description: No Content
15858
+ headers: {}
15859
+ content: {}
15860
+ /incomingCreditNotes.delete:
15861
+ post:
15862
+ summary: incomingCreditNotes.delete
15863
+ operationId: incomingCreditNotes.delete
15864
+ description: Deletes an incoming credit note.
15865
+ tags:
15866
+ - incoming_credit_notes
15867
+ parameters: []
15868
+ requestBody:
15869
+ content:
15870
+ application/json:
15871
+ example:
15872
+ id: 018d5965-19fb-701a-af11-e80451931551
15873
+ schema:
15874
+ type: object
15875
+ properties:
15876
+ id:
15877
+ type: string
15878
+ required:
15879
+ - id
15880
+ responses:
15881
+ '204':
15882
+ description: No Content
15883
+ headers: {}
15884
+ content: {}
15885
+ /incomingCreditNotes.info:
15886
+ post:
15887
+ summary: incomingCreditNotes.info
15888
+ operationId: incomingCreditNotes.info
15889
+ description: Get details for a single incoming credit note.
15890
+ tags:
15891
+ - incoming_credit_notes
15892
+ parameters: []
15893
+ requestBody:
15894
+ content:
15895
+ application/json:
15896
+ example:
15897
+ id: 018d5965-19fb-701a-af11-e80451931551
15898
+ schema:
15899
+ type: object
15900
+ properties:
15901
+ id:
15902
+ type: string
15903
+ required:
15904
+ - id
15905
+ responses:
15906
+ '200':
15907
+ description: OK
15908
+ headers: {}
15909
+ content:
15910
+ application/json:
15911
+ schema:
15912
+ type: object
15913
+ properties:
15914
+ data:
15915
+ type: object
15916
+ properties:
15917
+ id:
15918
+ type: string
15919
+ title:
15920
+ type: string
15921
+ origin:
15922
+ type: object
15923
+ properties:
15924
+ type:
15925
+ type: string
15926
+ enum:
15927
+ - user
15928
+ - peppolIncomingDocument
15929
+ id:
15930
+ type: string
15931
+ supplier:
15932
+ type: object
15933
+ properties:
15934
+ type:
15935
+ type: string
15936
+ enum:
15937
+ - company
15938
+ - contact
15939
+ id:
15940
+ type: string
15941
+ nullable: true
15942
+ document_number:
15943
+ type: string
15944
+ nullable: true
15945
+ invoice_date:
15946
+ type: string
15947
+ nullable: true
15948
+ due_date:
15949
+ type: string
15950
+ nullable: true
15951
+ currency:
15952
+ type: object
15953
+ properties:
15954
+ code:
15955
+ title: CurrencyCode
15956
+ enum: *ref_10
15957
+ type: string
15958
+ total:
15959
+ type: object
15960
+ properties:
15961
+ tax_exclusive:
15962
+ type: object
15963
+ properties:
15964
+ amount:
15965
+ type: number
15966
+ nullable: true
15967
+ tax_inclusive:
15968
+ type: object
15969
+ properties:
15970
+ amount:
15971
+ type: number
15972
+ nullable: true
15973
+ company_entity:
15974
+ type: object
15975
+ properties:
15976
+ type:
15977
+ type: string
15978
+ id:
15979
+ type: string
15980
+ file:
15981
+ type: object
15982
+ properties:
15983
+ type:
15984
+ type: string
15985
+ id:
15986
+ type: string
15987
+ nullable: true
15988
+ payment_reference:
15989
+ type: string
15990
+ nullable: true
15991
+ review_status:
15992
+ type: string
15993
+ enum:
15994
+ - pending
15995
+ - approved
15996
+ - refused
15997
+ iban_number:
15998
+ type: string
15999
+ nullable: true
16000
+ example:
16001
+ data:
16002
+ id: 018d5965-19fb-701a-af11-e80451931551
16003
+ title: Incoming credit note
16004
+ origin:
16005
+ type: user
16006
+ id: 018d5965-19fb-701a-af11-e80451931551
16007
+ supplier:
16008
+ type: company
16009
+ id: f29abf48-337d-44b4-aad4-585f5277a456
16010
+ document_number: DOC-2032039
16011
+ invoice_date: '2024-05-11'
16012
+ due_date: '2024-06-11'
16013
+ currency:
16014
+ code: EUR
16015
+ total:
16016
+ tax_exclusive:
16017
+ amount: 100
16018
+ tax_inclusive:
16019
+ amount: 100
16020
+ company_entity:
16021
+ type: department
16022
+ id: 018fcef1-4f96-7349-9f57-1c7857023c42
16023
+ file:
16024
+ type: file
16025
+ id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
16026
+ payment_reference: REF-3578296
16027
+ review_status: pending
16028
+ iban_number: BE68539007547034
16029
+ /incomingCreditNotes.markAsPendingReview:
16030
+ post:
16031
+ summary: incomingCreditNotes.markAsPendingReview
16032
+ operationId: incomingCreditNotes.markAsPendingReview
16033
+ description: Mark an incoming credit note as pending review.
16034
+ tags:
16035
+ - incoming_credit_notes
16036
+ parameters: []
16037
+ requestBody:
16038
+ content:
16039
+ application/json:
16040
+ example:
16041
+ id: 018d5965-19fb-701a-af11-e80451931551
16042
+ schema:
16043
+ type: object
16044
+ properties:
16045
+ id:
16046
+ type: string
16047
+ required:
16048
+ - id
16049
+ responses:
16050
+ '204':
16051
+ description: No Content
16052
+ headers: {}
16053
+ content: {}
16054
+ /incomingCreditNotes.refuse:
16055
+ post:
16056
+ summary: incomingCreditNotes.refuse
16057
+ operationId: incomingCreditNotes.refuse
16058
+ description: Refuse an incoming credit note.
16059
+ tags:
16060
+ - incoming_credit_notes
16061
+ parameters: []
16062
+ requestBody:
16063
+ content:
16064
+ application/json:
16065
+ example:
16066
+ id: 018d5965-19fb-701a-af11-e80451931551
16067
+ schema:
16068
+ type: object
16069
+ properties:
16070
+ id:
16071
+ type: string
16072
+ required:
16073
+ - id
16074
+ responses:
16075
+ '204':
16076
+ description: No Content
16077
+ headers: {}
16078
+ content: {}
16079
+ /incomingCreditNotes.sendToBookkeeping:
16080
+ post:
16081
+ summary: incomingCreditNotes.sendToBookkeeping
16082
+ operationId: incomingCreditNotes.sendToBookkeeping
16083
+ description: Send an incoming credit note to bookkeeping.
16084
+ tags:
16085
+ - incoming_credit_notes
16086
+ parameters: []
16087
+ requestBody:
16088
+ content:
16089
+ application/json:
16090
+ example:
16091
+ id: 018d5965-19fb-701a-af11-e80451931551
16092
+ schema:
16093
+ type: object
16094
+ properties:
16095
+ id:
16096
+ type: string
16097
+ required:
16098
+ - id
16099
+ responses:
16100
+ '204':
16101
+ description: No Content
16102
+ headers: {}
16103
+ content: {}
16104
+ /incomingCreditNotes.update:
16105
+ post:
16106
+ summary: incomingCreditNotes.update
16107
+ operationId: incomingCreditNotes.update
16108
+ description: Updates an incoming credit note.
16109
+ tags:
16110
+ - incoming_credit_notes
16111
+ parameters: []
16112
+ requestBody:
16113
+ content:
16114
+ application/json:
16115
+ example:
16116
+ id: 018d5965-19fb-701a-af11-e80451931551
16117
+ title: Incoming credit note
16118
+ supplier_id: ac4a3bc5-b11f-0eb6-8c20-0f0d697f8c2a
16119
+ document_number: DOC-2032039
16120
+ invoice_date: '2024-05-11'
16121
+ due_date: '2024-06-11'
16122
+ currency:
16123
+ code: EUR
16124
+ total:
16125
+ tax_exclusive:
16126
+ amount: 100
16127
+ tax_inclusive:
16128
+ amount: 100
16129
+ company_entity_id: 018fcef1-4f96-7349-9f57-1c7857023c42
16130
+ file_id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
16131
+ payment_reference: REF-3578296
16132
+ iban_number: BE68539007547034
16133
+ schema:
16134
+ type: object
16135
+ properties:
16136
+ id:
16137
+ type: string
16138
+ title:
16139
+ type: string
16140
+ supplier_id:
16141
+ type: string
16142
+ nullable: true
16143
+ document_number:
16144
+ type: string
16145
+ nullable: true
16146
+ invoice_date:
16147
+ type: string
16148
+ nullable: true
16149
+ due_date:
16150
+ type: string
16151
+ nullable: true
16152
+ currency:
16153
+ type: object
16154
+ properties:
16155
+ code:
16156
+ allOf:
16157
+ - title: CurrencyCode
16158
+ enum: *ref_10
16159
+ type: string
16160
+ - example: EUR
16161
+ required:
16162
+ - code
16163
+ total:
16164
+ type: object
16165
+ properties:
16166
+ tax_exclusive:
16167
+ type: object
16168
+ properties:
16169
+ amount:
16170
+ type: number
16171
+ required:
16172
+ - amount
16173
+ nullable: true
16174
+ tax_inclusive:
16175
+ type: object
16176
+ properties:
16177
+ amount:
16178
+ type: number
16179
+ required:
16180
+ - amount
16181
+ nullable: true
16182
+ company_entity_id:
16183
+ type: string
16184
+ file_id:
16185
+ type: string
16186
+ nullable: true
16187
+ payment_reference:
16188
+ type: string
16189
+ nullable: true
16190
+ iban_number:
16191
+ type: string
16192
+ nullable: true
16193
+ required:
16194
+ - id
16195
+ responses:
16196
+ '204':
16197
+ description: No Content
16198
+ headers: {}
16199
+ content: {}
16200
+ /incomingInvoices.add:
16201
+ post:
16202
+ summary: incomingInvoices.add
16203
+ operationId: incomingInvoices.add
16204
+ description: Adds an incoming invoice.
16205
+ tags:
16206
+ - incoming_invoices
16207
+ parameters: []
16208
+ requestBody:
16209
+ content:
16210
+ application/json:
16211
+ example:
16212
+ title: Incoming invoice
16213
+ supplier_id: ac4a3bc5-b11f-0eb6-8c20-0f0d697f8c2a
16214
+ document_number: DOC-2032039
16215
+ invoice_date: '2024-05-11'
16216
+ due_date: '2024-06-11'
16217
+ currency:
16218
+ code: EUR
16219
+ total:
16220
+ tax_exclusive:
16221
+ amount: 100
16222
+ tax_inclusive:
16223
+ amount: 100
16224
+ company_entity_id: 018fcef1-4f96-7349-9f57-1c7857023c42
16225
+ file_id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
16226
+ payment_reference: REF-3578296
16227
+ iban_number: BE68539007547034
16228
+ schema:
16229
+ type: object
16230
+ properties:
16231
+ title:
16232
+ type: string
16233
+ supplier_id:
16234
+ type: string
16235
+ nullable: true
16236
+ document_number:
16237
+ type: string
16238
+ nullable: true
16239
+ invoice_date:
16240
+ type: string
16241
+ nullable: true
16242
+ due_date:
16243
+ type: string
16244
+ nullable: true
16245
+ currency:
16246
+ type: object
16247
+ properties:
16248
+ code:
16249
+ allOf:
16250
+ - title: CurrencyCode
16251
+ enum: *ref_10
16252
+ type: string
16253
+ - example: EUR
16254
+ required:
16255
+ - code
16256
+ total:
16257
+ type: object
16258
+ properties:
16259
+ tax_exclusive:
16260
+ type: object
16261
+ properties:
16262
+ amount:
16263
+ type: number
16264
+ required:
16265
+ - amount
16266
+ nullable: true
16267
+ tax_inclusive:
16268
+ type: object
16269
+ properties:
16270
+ amount:
16271
+ type: number
16272
+ required:
16273
+ - amount
16274
+ nullable: true
16275
+ company_entity_id:
16276
+ type: string
16277
+ description: Default company entity will be used if not provided
16278
+ file_id:
16279
+ type: string
16280
+ nullable: true
16281
+ payment_reference:
16282
+ type: string
16283
+ nullable: true
16284
+ iban_number:
16285
+ type: string
16286
+ nullable: true
16287
+ required:
16288
+ - title
16289
+ - currency
16290
+ responses:
16291
+ '201':
16292
+ description: Created
16293
+ headers: {}
16294
+ content:
16295
+ application/json:
16296
+ schema:
16297
+ type: object
16298
+ properties:
16299
+ data:
16300
+ type: object
16301
+ properties:
16302
+ type:
16303
+ type: string
16304
+ id:
16305
+ type: string
16306
+ example:
16307
+ data:
16308
+ type: incomingInvoice
16309
+ id: 018d5965-19fb-701a-af11-e80451931551
16310
+ /incomingInvoices.approve:
16311
+ post:
16312
+ summary: incomingInvoices.approve
16313
+ operationId: incomingInvoices.approve
16314
+ description: Approve an incoming invoice.
16315
+ tags:
16316
+ - incoming_invoices
16317
+ parameters: []
16318
+ requestBody:
16319
+ content:
16320
+ application/json:
16321
+ example:
16322
+ id: 018d5965-19fb-701a-af11-e80451931551
16323
+ schema:
16324
+ type: object
16325
+ properties:
16326
+ id:
16327
+ type: string
16328
+ required:
16329
+ - id
16330
+ responses:
16331
+ '204':
16332
+ description: No Content
16333
+ headers: {}
16334
+ content: {}
16335
+ /incomingInvoices.delete:
16336
+ post:
16337
+ summary: incomingInvoices.delete
16338
+ operationId: incomingInvoices.delete
16339
+ description: Deletes an incoming invoice.
16340
+ tags:
16341
+ - incoming_invoices
16342
+ parameters: []
16343
+ requestBody:
16344
+ content:
16345
+ application/json:
16346
+ example:
16347
+ id: 018d5965-19fb-701a-af11-e80451931551
16348
+ schema:
16349
+ type: object
16350
+ properties:
16351
+ id:
16352
+ type: string
16353
+ required:
16354
+ - id
16355
+ responses:
16356
+ '204':
16357
+ description: No Content
16358
+ headers: {}
16359
+ content: {}
16360
+ /incomingInvoices.info:
16361
+ post:
16362
+ summary: incomingInvoices.info
16363
+ operationId: incomingInvoices.info
16364
+ description: Get details for a single incoming invoice.
16365
+ tags:
16366
+ - incoming_invoices
16367
+ parameters: []
16368
+ requestBody:
16369
+ content:
16370
+ application/json:
16371
+ example:
16372
+ id: 018d5965-19fb-701a-af11-e80451931551
16373
+ schema:
16374
+ type: object
16375
+ properties:
16376
+ id:
16377
+ type: string
16378
+ required:
16379
+ - id
16380
+ responses:
16381
+ '200':
16382
+ description: OK
16383
+ headers: {}
16384
+ content:
16385
+ application/json:
16386
+ schema:
16387
+ type: object
16388
+ properties:
16389
+ data:
16390
+ type: object
16391
+ properties:
16392
+ id:
16393
+ type: string
16394
+ title:
16395
+ type: string
16396
+ origin:
16397
+ type: object
16398
+ properties:
16399
+ type:
16400
+ type: string
16401
+ enum:
16402
+ - user
16403
+ - peppolIncomingDocument
16404
+ id:
16405
+ type: string
16406
+ supplier:
16407
+ type: object
16408
+ properties:
16409
+ type:
16410
+ type: string
16411
+ enum:
16412
+ - company
16413
+ - contact
16414
+ id:
16415
+ type: string
16416
+ nullable: true
16417
+ document_number:
16418
+ type: string
16419
+ nullable: true
16420
+ invoice_date:
16421
+ type: string
16422
+ nullable: true
16423
+ due_date:
16424
+ type: string
16425
+ nullable: true
16426
+ currency:
16427
+ type: object
16428
+ properties:
16429
+ code:
16430
+ title: CurrencyCode
16431
+ enum: *ref_10
16432
+ type: string
16433
+ total:
16434
+ type: object
16435
+ properties:
16436
+ tax_exclusive:
16437
+ type: object
16438
+ properties:
16439
+ amount:
16440
+ type: number
16441
+ nullable: true
16442
+ tax_inclusive:
16443
+ type: object
16444
+ properties:
16445
+ amount:
16446
+ type: number
16447
+ nullable: true
16448
+ company_entity:
16449
+ type: object
16450
+ properties:
16451
+ type:
16452
+ type: string
16453
+ id:
16454
+ type: string
16455
+ file:
16456
+ type: object
16457
+ properties:
16458
+ type:
16459
+ type: string
16460
+ id:
16461
+ type: string
16462
+ nullable: true
16463
+ payment_reference:
16464
+ type: string
16465
+ nullable: true
16466
+ review_status:
16467
+ type: string
16468
+ enum:
16469
+ - pending
16470
+ - approved
16471
+ - refused
16472
+ iban_number:
16473
+ type: string
16474
+ nullable: true
16475
+ example:
16476
+ data:
16477
+ id: 018d5965-19fb-701a-af11-e80451931551
16478
+ title: Incoming invoice
16479
+ origin:
16480
+ type: user
16481
+ id: 018d5965-19fb-701a-af11-e80451931551
16482
+ supplier:
16483
+ type: company
16484
+ id: f29abf48-337d-44b4-aad4-585f5277a456
16485
+ document_number: DOC-2032039
16486
+ invoice_date: '2024-05-11'
16487
+ due_date: '2024-06-11'
16488
+ currency:
16489
+ code: EUR
16490
+ total:
16491
+ tax_exclusive:
16492
+ amount: 100
16493
+ tax_inclusive:
16494
+ amount: 100
16495
+ company_entity:
16496
+ type: department
16497
+ id: 018fcef1-4f96-7349-9f57-1c7857023c42
16498
+ file:
16499
+ type: file
16500
+ id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
16501
+ payment_reference: REF-3578296
16502
+ review_status: pending
16503
+ iban_number: BE68539007547034
16504
+ /incomingInvoices.markAsPendingReview:
16505
+ post:
16506
+ summary: incomingInvoices.markAsPendingReview
16507
+ operationId: incomingInvoices.markAsPendingReview
16508
+ description: Mark an incoming invoice as pending review.
16509
+ tags:
16510
+ - incoming_invoices
16511
+ parameters: []
16512
+ requestBody:
16513
+ content:
16514
+ application/json:
16515
+ example:
16516
+ id: 018d5965-19fb-701a-af11-e80451931551
16517
+ schema:
16518
+ type: object
16519
+ properties:
16520
+ id:
16521
+ type: string
16522
+ required:
16523
+ - id
16524
+ responses:
16525
+ '204':
16526
+ description: No Content
16527
+ headers: {}
16528
+ content: {}
16529
+ /incomingInvoices.refuse:
16530
+ post:
16531
+ summary: incomingInvoices.refuse
16532
+ operationId: incomingInvoices.refuse
16533
+ description: Refuse an incoming invoice.
16534
+ tags:
16535
+ - incoming_invoices
16536
+ parameters: []
16537
+ requestBody:
16538
+ content:
16539
+ application/json:
16540
+ example:
16541
+ id: 018d5965-19fb-701a-af11-e80451931551
16542
+ schema:
16543
+ type: object
16544
+ properties:
16545
+ id:
16546
+ type: string
16547
+ required:
16548
+ - id
16549
+ responses:
16550
+ '204':
16551
+ description: No Content
16552
+ headers: {}
16553
+ content: {}
16554
+ /incomingInvoices.sendToBookkeeping:
16555
+ post:
16556
+ summary: incomingInvoices.sendToBookkeeping
16557
+ operationId: incomingInvoices.sendToBookkeeping
16558
+ description: Send an incoming invoice to bookkeeping.
16559
+ tags:
16560
+ - incoming_invoices
16561
+ parameters: []
16562
+ requestBody:
16563
+ content:
16564
+ application/json:
16565
+ example:
16566
+ id: 018d5965-19fb-701a-af11-e80451931551
16567
+ schema:
16568
+ type: object
16569
+ properties:
16570
+ id:
16571
+ type: string
16572
+ required:
16573
+ - id
16574
+ responses:
16575
+ '204':
16576
+ description: No Content
16577
+ headers: {}
16578
+ content: {}
16579
+ /incomingInvoices.update:
16580
+ post:
16581
+ summary: incomingInvoices.update
16582
+ operationId: incomingInvoices.update
16583
+ description: Updates an incoming invoice.
16584
+ tags:
16585
+ - incoming_invoices
16586
+ parameters: []
16587
+ requestBody:
16588
+ content:
16589
+ application/json:
16590
+ example:
16591
+ id: 018d5965-19fb-701a-af11-e80451931551
16592
+ title: Incoming invoice
16593
+ supplier_id: ac4a3bc5-b11f-0eb6-8c20-0f0d697f8c2a
16594
+ document_number: DOC-2032039
16595
+ invoice_date: '2024-05-11'
16596
+ due_date: '2024-06-11'
16597
+ currency:
16598
+ code: EUR
16599
+ total:
16600
+ tax_exclusive:
16601
+ amount: 100
16602
+ tax_inclusive:
16603
+ amount: 100
16604
+ company_entity_id: 018fcef1-4f96-7349-9f57-1c7857023c42
16605
+ file_id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
16606
+ payment_reference: REF-3578296
16607
+ iban_number: BE68539007547034
16608
+ schema:
16609
+ type: object
16610
+ properties:
16611
+ id:
16612
+ type: string
16613
+ title:
16614
+ type: string
16615
+ supplier_id:
16616
+ type: string
16617
+ nullable: true
16618
+ document_number:
16619
+ type: string
16620
+ nullable: true
16621
+ invoice_date:
16622
+ type: string
16623
+ nullable: true
16624
+ due_date:
16625
+ type: string
16626
+ nullable: true
16627
+ currency:
16628
+ type: object
16629
+ properties:
16630
+ code:
16631
+ allOf:
16632
+ - title: CurrencyCode
16633
+ enum: *ref_10
16634
+ type: string
16635
+ - example: EUR
16636
+ required:
16637
+ - code
16638
+ total:
16639
+ type: object
16640
+ properties:
16641
+ tax_exclusive:
16642
+ type: object
16643
+ properties:
16644
+ amount:
16645
+ type: number
16646
+ required:
16647
+ - amount
16648
+ nullable: true
16649
+ tax_inclusive:
16650
+ type: object
16651
+ properties:
16652
+ amount:
16653
+ type: number
16654
+ required:
16655
+ - amount
16656
+ nullable: true
16657
+ company_entity_id:
16658
+ type: string
16659
+ file_id:
16660
+ type: string
16661
+ nullable: true
16662
+ payment_reference:
16663
+ type: string
16664
+ nullable: true
16665
+ iban_number:
16666
+ type: string
16667
+ nullable: true
16668
+ required:
16669
+ - id
16670
+ responses:
16671
+ '204':
16672
+ description: No Content
16673
+ headers: {}
16674
+ content: {}
16675
+ /receipts.add:
16676
+ post:
16677
+ summary: receipts.add
16678
+ operationId: receipts.add
16679
+ description: Adds a receipt.
16680
+ tags:
16681
+ - receipts
16682
+ parameters: []
16683
+ requestBody:
16684
+ content:
16685
+ application/json:
16686
+ example:
16687
+ title: Receipt note
16688
+ supplier_id: ac4a3bc5-b11f-0eb6-8c20-0f0d697f8c2a
16689
+ document_number: DOC-2032039
16690
+ receipt_date: '2024-05-11'
16691
+ currency:
16692
+ code: EUR
16693
+ total:
16694
+ tax_inclusive:
16695
+ amount: 100
16696
+ company_entity_id: 018fcef1-4f96-7349-9f57-1c7857023c42
16697
+ file_id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
16698
+ schema:
16699
+ type: object
16700
+ properties:
16701
+ title:
16702
+ type: string
16703
+ supplier_id:
16704
+ type: string
16705
+ nullable: true
16706
+ document_number:
16707
+ type: string
16708
+ nullable: true
16709
+ receipt_date:
16710
+ type: string
16711
+ nullable: true
16712
+ currency:
16713
+ type: object
16714
+ properties:
16715
+ code:
16716
+ allOf:
16717
+ - title: CurrencyCode
16718
+ enum: *ref_10
16719
+ type: string
16720
+ - example: EUR
16721
+ required:
16722
+ - code
16723
+ total:
16724
+ type: object
16725
+ properties:
16726
+ tax_inclusive:
16727
+ type: object
16728
+ properties:
16729
+ amount:
16730
+ type: number
16731
+ required:
16732
+ - amount
16733
+ nullable: true
16734
+ company_entity_id:
16735
+ type: string
16736
+ description: Default company entity will be used if not provided
16737
+ file_id:
16738
+ type: string
16739
+ nullable: true
16740
+ required:
16741
+ - title
16742
+ - currency
16743
+ responses:
16744
+ '201':
16745
+ description: Created
16746
+ headers: {}
16747
+ content:
16748
+ application/json:
16749
+ schema:
16750
+ type: object
16751
+ properties:
16752
+ data:
16753
+ type: object
16754
+ properties:
16755
+ type:
16756
+ type: string
16757
+ id:
16758
+ type: string
16759
+ example:
16760
+ data:
16761
+ type: receipt
16762
+ id: 018d5965-19fb-701a-af11-e80451931551
16763
+ /receipts.approve:
16764
+ post:
16765
+ summary: receipts.approve
16766
+ operationId: receipts.approve
16767
+ description: Approve a receipt.
16768
+ tags:
16769
+ - receipts
16770
+ parameters: []
16771
+ requestBody:
16772
+ content:
16773
+ application/json:
16774
+ example:
16775
+ id: 018d5965-19fb-701a-af11-e80451931551
16776
+ schema:
16777
+ type: object
16778
+ properties:
16779
+ id:
16780
+ type: string
16781
+ required:
16782
+ - id
16783
+ responses:
16784
+ '204':
16785
+ description: No Content
16786
+ headers: {}
16787
+ content: {}
16788
+ /receipts.delete:
16789
+ post:
16790
+ summary: receipts.delete
16791
+ operationId: receipts.delete
16792
+ description: Deletes a receipt.
16793
+ tags:
16794
+ - receipts
16795
+ parameters: []
16796
+ requestBody:
16797
+ content:
16798
+ application/json:
16799
+ example:
16800
+ id: 018d5965-19fb-701a-af11-e80451931551
16801
+ schema:
16802
+ type: object
16803
+ properties:
16804
+ id:
16805
+ type: string
16806
+ required:
16807
+ - id
16808
+ responses:
16809
+ '204':
16810
+ description: No Content
16811
+ headers: {}
16812
+ content: {}
16813
+ /receipts.info:
16814
+ post:
16815
+ summary: receipts.info
16816
+ operationId: receipts.info
16817
+ description: Get details for a single receipt.
16818
+ tags:
16819
+ - receipts
16820
+ parameters: []
16821
+ requestBody:
16822
+ content:
16823
+ application/json:
16824
+ example:
16825
+ id: 018d5965-19fb-701a-af11-e80451931551
16826
+ schema:
16827
+ type: object
16828
+ properties:
16829
+ id:
16830
+ type: string
16831
+ required:
16832
+ - id
16833
+ responses:
16834
+ '200':
16835
+ description: OK
16836
+ headers: {}
16837
+ content:
16838
+ application/json:
16839
+ schema:
16840
+ type: object
16841
+ properties:
16842
+ data:
16843
+ type: object
16844
+ properties:
16845
+ id:
16846
+ type: string
16847
+ title:
16848
+ type: string
16849
+ origin:
16850
+ type: object
16851
+ properties:
16852
+ type:
16853
+ type: string
16854
+ id:
16855
+ type: string
16856
+ supplier:
16857
+ type: object
16858
+ properties:
16859
+ type:
16860
+ type: string
16861
+ enum:
16862
+ - company
16863
+ - contact
16864
+ id:
16865
+ type: string
16866
+ nullable: true
16867
+ document_number:
16868
+ type: string
16869
+ nullable: true
16870
+ receipt_date:
16871
+ type: string
16872
+ nullable: true
16873
+ currency:
16874
+ type: object
16875
+ properties:
16876
+ code:
16877
+ title: CurrencyCode
16878
+ enum: *ref_10
16879
+ type: string
16880
+ total:
16881
+ type: object
16882
+ properties:
16883
+ tax_inclusive:
16884
+ type: object
16885
+ properties:
16886
+ amount:
16887
+ type: number
16888
+ nullable: true
16889
+ company_entity:
16890
+ type: object
16891
+ properties:
16892
+ type:
16893
+ type: string
16894
+ id:
16895
+ type: string
16896
+ file:
16897
+ type: object
16898
+ properties:
16899
+ type:
16900
+ type: string
16901
+ id:
16902
+ type: string
16903
+ nullable: true
16904
+ review_status:
16905
+ type: string
16906
+ enum:
16907
+ - pending
16908
+ - approved
16909
+ - refused
16910
+ example:
16911
+ data:
16912
+ id: 018d5965-19fb-701a-af11-e80451931551
16913
+ title: Receipt note
16914
+ origin:
16915
+ type: user
16916
+ id: 018d5965-19fb-701a-af11-e80451931551
16917
+ supplier:
16918
+ type: company
16919
+ id: f29abf48-337d-44b4-aad4-585f5277a456
16920
+ document_number: DOC-2032039
16921
+ receipt_date: '2024-05-11'
16922
+ currency:
16923
+ code: EUR
16924
+ total:
16925
+ tax_inclusive:
16926
+ amount: 100
16927
+ company_entity:
16928
+ type: department
16929
+ id: 018fcef1-4f96-7349-9f57-1c7857023c42
16930
+ file:
16931
+ type: file
16932
+ id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
16933
+ review_status: pending
16934
+ /receipts.markAsPendingReview:
16935
+ post:
16936
+ summary: receipts.markAsPendingReview
16937
+ operationId: receipts.markAsPendingReview
16938
+ description: Mark a receipts as pending review.
16939
+ tags:
16940
+ - receipts
16941
+ parameters: []
16942
+ requestBody:
16943
+ content:
16944
+ application/json:
16945
+ example:
16946
+ id: 018d5965-19fb-701a-af11-e80451931551
16947
+ schema:
16948
+ type: object
16949
+ properties:
16950
+ id:
16951
+ type: string
16952
+ required:
16953
+ - id
16954
+ responses:
16955
+ '204':
16956
+ description: No Content
16957
+ headers: {}
16958
+ content: {}
16959
+ /receipts.refuse:
16960
+ post:
16961
+ summary: receipts.refuse
16962
+ operationId: receipts.refuse
16963
+ description: Refuse a receipts.
16964
+ tags:
16965
+ - receipts
15144
16966
  parameters: []
15145
16967
  requestBody:
15146
- description: ''
15147
16968
  content:
15148
16969
  application/json:
15149
- schema:
15150
- allOf:
15151
- - title: withholdingTaxRates.listrequest
15152
- type: object
15153
- properties: &ref_417
15154
- filter:
15155
- type: object
15156
- properties:
15157
- department_id:
15158
- type: string
15159
- description: The ID of the department you wish to filter on.
15160
- example: 080aac72-ff1a-4627-bfe3-146b6eee979c
15161
- - example:
15162
- filter:
15163
- department_id: 080aac72-ff1a-4627-bfe3-146b6eee979c
15164
16970
  example:
15165
- filter:
15166
- department_id: 080aac72-ff1a-4627-bfe3-146b6eee979c
15167
- required: true
16971
+ id: 018d5965-19fb-701a-af11-e80451931551
16972
+ schema:
16973
+ type: object
16974
+ properties:
16975
+ id:
16976
+ type: string
16977
+ required:
16978
+ - id
15168
16979
  responses:
15169
- '200':
15170
- description: ''
16980
+ '204':
16981
+ description: No Content
15171
16982
  headers: {}
15172
- content:
15173
- application/json:
15174
- schema:
15175
- allOf:
15176
- - title: withholdingTaxRates.listresponse
15177
- type: object
15178
- properties: &ref_418
15179
- data:
15180
- type: array
15181
- items:
15182
- type: object
15183
- properties:
15184
- id:
15185
- type: string
15186
- example: c93ddb52-0af8-47d9-8551-441435be66a7
15187
- description:
15188
- type: string
15189
- example: 21%
15190
- rate:
15191
- type: number
15192
- example: 0.21
15193
- department:
15194
- title: TypeAndId
15195
- type: object
15196
- properties: *ref_1
15197
- description: ''
15198
- - example:
15199
- data:
15200
- - id: c93ddb52-0af8-47d9-8551-441435be66a7
15201
- department:
15202
- type: department
15203
- id: 182af0a8-3f68-409b-8941-cf8caf8f28a0
15204
- description: Ritenuta d'acconto 23% su 20%
15205
- rate: 0.046
15206
- example:
15207
- data:
15208
- - id: c93ddb52-0af8-47d9-8551-441435be66a7
15209
- department:
15210
- type: department
15211
- id: 182af0a8-3f68-409b-8941-cf8caf8f28a0
15212
- description: Ritenuta d'acconto 23% su 20%
15213
- rate: 0.046
15214
- deprecated: false
15215
- /commercialDiscounts.list:
16983
+ content: {}
16984
+ /receipts.sendToBookkeeping:
15216
16985
  post:
16986
+ summary: receipts.sendToBookkeeping
16987
+ operationId: receipts.sendToBookkeeping
16988
+ description: Send a receipt to bookkeeping for processing.
15217
16989
  tags:
15218
- - commercial_discounts
15219
- summary: commercialDiscounts.list
15220
- description: Get a list of commercial discounts.
15221
- operationId: commercialDiscounts.list
16990
+ - receipts
15222
16991
  parameters: []
15223
16992
  requestBody:
15224
- description: ''
15225
16993
  content:
15226
16994
  application/json:
15227
- schema:
15228
- allOf:
15229
- - title: commercialDiscounts.listrequest
15230
- type: object
15231
- properties: &ref_419
15232
- filter:
15233
- type: object
15234
- properties:
15235
- department_id:
15236
- type: string
15237
- example: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
15238
- - example:
15239
- filter:
15240
- department_id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
15241
16995
  example:
15242
- filter:
15243
- department_id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
15244
- required: true
16996
+ id: 018d5965-19fb-701a-af11-e80451931551
16997
+ schema:
16998
+ type: object
16999
+ properties:
17000
+ id:
17001
+ type: string
17002
+ required:
17003
+ - id
15245
17004
  responses:
15246
- '200':
15247
- description: ''
17005
+ '204':
17006
+ description: No Content
15248
17007
  headers: {}
15249
- content:
15250
- application/json:
15251
- schema:
15252
- allOf:
15253
- - title: commercialDiscounts.listresponse
15254
- type: object
15255
- properties: &ref_420
15256
- data:
15257
- type: array
15258
- items:
15259
- type: object
15260
- properties:
15261
- name:
15262
- type: string
15263
- example: My holiday discount
15264
- department:
15265
- title: TypeAndId
15266
- type: object
15267
- properties: *ref_1
15268
- description: ''
15269
- - example:
15270
- data:
15271
- - name: My holiday discount
15272
- department:
15273
- type: department
15274
- id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
15275
- example:
15276
- data:
15277
- - name: My holiday discount
15278
- department:
15279
- type: department
15280
- id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
15281
- deprecated: false
15282
- /paymentMethods.list:
17008
+ content: {}
17009
+ /receipts.update:
15283
17010
  post:
17011
+ summary: receipts.update
17012
+ operationId: receipts.update
17013
+ description: Updates a receipt.
15284
17014
  tags:
15285
- - payment_methods
15286
- summary: paymentMethods.list
15287
- description: Get a list of payment methods.
15288
- operationId: paymentMethods.list
17015
+ - receipts
15289
17016
  parameters: []
15290
17017
  requestBody:
15291
- description: ''
15292
17018
  content:
15293
17019
  application/json:
17020
+ example:
17021
+ id: 018d5965-19fb-701a-af11-e80451931551
17022
+ title: Receipt note
17023
+ supplier_id: ac4a3bc5-b11f-0eb6-8c20-0f0d697f8c2a
17024
+ document_number: DOC-2032039
17025
+ receipt_date: '2024-05-11'
17026
+ currency:
17027
+ code: EUR
17028
+ total:
17029
+ tax_inclusive:
17030
+ amount: 100
17031
+ company_entity_id: 018fcef1-4f96-7349-9f57-1c7857023c42
17032
+ file_id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
15294
17033
  schema:
15295
- allOf:
15296
- - title: paymentMethods.listrequest
17034
+ type: object
17035
+ properties:
17036
+ id:
17037
+ type: string
17038
+ title:
17039
+ type: string
17040
+ supplier_id:
17041
+ type: string
17042
+ nullable: true
17043
+ document_number:
17044
+ type: string
17045
+ nullable: true
17046
+ receipt_date:
17047
+ type: string
17048
+ nullable: true
17049
+ currency:
15297
17050
  type: object
15298
- properties: &ref_421
15299
- filter:
17051
+ properties:
17052
+ code:
17053
+ allOf:
17054
+ - title: CurrencyCode
17055
+ enum: *ref_10
17056
+ type: string
17057
+ - example: EUR
17058
+ required:
17059
+ - code
17060
+ total:
17061
+ type: object
17062
+ properties:
17063
+ tax_inclusive:
15300
17064
  type: object
15301
17065
  properties:
15302
- ids:
15303
- type: array
15304
- items:
15305
- type: string
15306
- example:
15307
- - 92296ad0-2d61-4179-b174-9f354ca2157f
15308
- - 53635682-c382-4fbf-9fd9-9506ca4fbcdd
15309
- status:
15310
- type: array
15311
- items:
15312
- type: string
15313
- enum:
15314
- - active
15315
- - archived
15316
- description: Filters on status
15317
- page:
15318
- title: Page
15319
- type: object
15320
- properties: *ref_6
15321
- required: true
17066
+ amount:
17067
+ type: number
17068
+ required:
17069
+ - amount
17070
+ nullable: true
17071
+ company_entity_id:
17072
+ type: string
17073
+ file_id:
17074
+ type: string
17075
+ nullable: true
17076
+ required:
17077
+ - id
15322
17078
  responses:
15323
- '200':
15324
- description: ''
17079
+ '204':
17080
+ description: No Content
15325
17081
  headers: {}
15326
- content:
15327
- application/json:
15328
- schema:
15329
- allOf:
15330
- - title: paymentMethods.listresponse
15331
- type: object
15332
- properties: &ref_422
15333
- data:
15334
- type: array
15335
- items:
15336
- type: object
15337
- required:
15338
- - status
15339
- properties:
15340
- id:
15341
- type: string
15342
- example: 49b403be-a32e-0901-9b1c-25214f9027c6
15343
- name:
15344
- type: string
15345
- example: Coupons
15346
- status:
15347
- type: string
15348
- enum:
15349
- - active
15350
- - archived
15351
- example: active
15352
- description: ''
15353
- - example:
15354
- data:
15355
- - id: 49b403be-a32e-0901-9b1c-25214f9027c6
15356
- name: Coupons
15357
- status: active
15358
- example:
15359
- data:
15360
- - id: 49b403be-a32e-0901-9b1c-25214f9027c6
15361
- name: Coupons
15362
- status: active
15363
- deprecated: false
17082
+ content: {}
15364
17083
  /productCategories.list:
15365
17084
  post:
15366
17085
  tags:
@@ -31507,6 +33226,13 @@ x-tagGroups:
31507
33226
  - withholding_tax_rates
31508
33227
  - commercial_discounts
31509
33228
  - payment_methods
33229
+ - name: Expenses
33230
+ tags:
33231
+ - expenses
33232
+ - bookkeeping_submissions
33233
+ - incoming_invoices
33234
+ - incoming_credit_notes
33235
+ - receipts
31510
33236
  - name: Products
31511
33237
  tags:
31512
33238
  - product_categories