@teamleader/focus-api-specification 1.21.0 → 1.23.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.
|
|
6
|
+
version: 1.23.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
|
|
@@ -6546,6 +6567,29 @@ paths:
|
|
|
6546
6567
|
headers: {}
|
|
6547
6568
|
content: {}
|
|
6548
6569
|
deprecated: false
|
|
6570
|
+
/invoices.sendViaPeppol:
|
|
6571
|
+
post:
|
|
6572
|
+
tags:
|
|
6573
|
+
- invoices
|
|
6574
|
+
summary: invoices.sendViaPeppol
|
|
6575
|
+
description: Send an invoice via the Peppol network.
|
|
6576
|
+
operationId: invoices.sendViaPeppol
|
|
6577
|
+
parameters: []
|
|
6578
|
+
requestBody:
|
|
6579
|
+
content:
|
|
6580
|
+
application/json:
|
|
6581
|
+
schema:
|
|
6582
|
+
allOf:
|
|
6583
|
+
- $ref: '#/components/schemas/invoices.sendViaPeppol'
|
|
6584
|
+
- example:
|
|
6585
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
6586
|
+
example:
|
|
6587
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
6588
|
+
responses:
|
|
6589
|
+
'204':
|
|
6590
|
+
description: No Content
|
|
6591
|
+
headers: {}
|
|
6592
|
+
content: {}
|
|
6549
6593
|
/creditNotes.list:
|
|
6550
6594
|
post:
|
|
6551
6595
|
tags:
|
|
@@ -7101,198 +7145,1873 @@ paths:
|
|
|
7101
7145
|
required: true
|
|
7102
7146
|
responses:
|
|
7103
7147
|
'200':
|
|
7104
|
-
description: ''
|
|
7148
|
+
description: ''
|
|
7149
|
+
headers: {}
|
|
7150
|
+
content:
|
|
7151
|
+
application/json:
|
|
7152
|
+
schema:
|
|
7153
|
+
allOf:
|
|
7154
|
+
- $ref: '#/components/schemas/taxRates.listresponse'
|
|
7155
|
+
- example:
|
|
7156
|
+
data:
|
|
7157
|
+
- id: c93ddb52-0af8-47d9-8551-441435be66a7
|
|
7158
|
+
description: 21%
|
|
7159
|
+
rate: 0.21
|
|
7160
|
+
department:
|
|
7161
|
+
type: department
|
|
7162
|
+
id: 182af0a8-3f68-409b-8941-cf8caf8f28a0
|
|
7163
|
+
example:
|
|
7164
|
+
data:
|
|
7165
|
+
- id: c93ddb52-0af8-47d9-8551-441435be66a7
|
|
7166
|
+
description: 21%
|
|
7167
|
+
rate: 0.21
|
|
7168
|
+
department:
|
|
7169
|
+
type: department
|
|
7170
|
+
id: 182af0a8-3f68-409b-8941-cf8caf8f28a0
|
|
7171
|
+
deprecated: false
|
|
7172
|
+
/paymentTerms.list:
|
|
7173
|
+
post:
|
|
7174
|
+
tags:
|
|
7175
|
+
- payment_terms
|
|
7176
|
+
summary: paymentTerms.list
|
|
7177
|
+
description: Get a list of available payment terms.
|
|
7178
|
+
operationId: paymentTerms.list
|
|
7179
|
+
parameters:
|
|
7180
|
+
- name: Content-Type
|
|
7181
|
+
in: header
|
|
7182
|
+
description: ''
|
|
7183
|
+
required: true
|
|
7184
|
+
style: simple
|
|
7185
|
+
schema:
|
|
7186
|
+
enum:
|
|
7187
|
+
- application/json
|
|
7188
|
+
type: string
|
|
7189
|
+
example: application/json
|
|
7190
|
+
responses:
|
|
7191
|
+
'200':
|
|
7192
|
+
description: ''
|
|
7193
|
+
headers: {}
|
|
7194
|
+
content:
|
|
7195
|
+
application/json:
|
|
7196
|
+
schema:
|
|
7197
|
+
allOf:
|
|
7198
|
+
- $ref: '#/components/schemas/paymentTerms.listresponse'
|
|
7199
|
+
- example:
|
|
7200
|
+
data:
|
|
7201
|
+
- id: c93ddb52-0af8-47d9-8551-441435be66a7
|
|
7202
|
+
type: cash
|
|
7203
|
+
meta:
|
|
7204
|
+
default: c93ddb52-0af8-47d9-8551-441435be66a7
|
|
7205
|
+
example:
|
|
7206
|
+
data:
|
|
7207
|
+
- id: c93ddb52-0af8-47d9-8551-441435be66a7
|
|
7208
|
+
type: cash
|
|
7209
|
+
meta:
|
|
7210
|
+
default: c93ddb52-0af8-47d9-8551-441435be66a7
|
|
7211
|
+
deprecated: false
|
|
7212
|
+
/withholdingTaxRates.list:
|
|
7213
|
+
post:
|
|
7214
|
+
tags:
|
|
7215
|
+
- withholding_tax_rates
|
|
7216
|
+
summary: withholdingTaxRates.list
|
|
7217
|
+
description: Get a list of available withholding tax rates.
|
|
7218
|
+
operationId: withholdingTaxRates.list
|
|
7219
|
+
parameters: []
|
|
7220
|
+
requestBody:
|
|
7221
|
+
description: ''
|
|
7222
|
+
content:
|
|
7223
|
+
application/json:
|
|
7224
|
+
schema:
|
|
7225
|
+
allOf:
|
|
7226
|
+
- $ref: '#/components/schemas/withholdingTaxRates.listrequest'
|
|
7227
|
+
- example:
|
|
7228
|
+
filter:
|
|
7229
|
+
department_id: 080aac72-ff1a-4627-bfe3-146b6eee979c
|
|
7230
|
+
example:
|
|
7231
|
+
filter:
|
|
7232
|
+
department_id: 080aac72-ff1a-4627-bfe3-146b6eee979c
|
|
7233
|
+
required: true
|
|
7234
|
+
responses:
|
|
7235
|
+
'200':
|
|
7236
|
+
description: ''
|
|
7237
|
+
headers: {}
|
|
7238
|
+
content:
|
|
7239
|
+
application/json:
|
|
7240
|
+
schema:
|
|
7241
|
+
allOf:
|
|
7242
|
+
- $ref: '#/components/schemas/withholdingTaxRates.listresponse'
|
|
7243
|
+
- example:
|
|
7244
|
+
data:
|
|
7245
|
+
- id: c93ddb52-0af8-47d9-8551-441435be66a7
|
|
7246
|
+
department:
|
|
7247
|
+
type: department
|
|
7248
|
+
id: 182af0a8-3f68-409b-8941-cf8caf8f28a0
|
|
7249
|
+
description: Ritenuta d'acconto 23% su 20%
|
|
7250
|
+
rate: 0.046
|
|
7251
|
+
example:
|
|
7252
|
+
data:
|
|
7253
|
+
- id: c93ddb52-0af8-47d9-8551-441435be66a7
|
|
7254
|
+
department:
|
|
7255
|
+
type: department
|
|
7256
|
+
id: 182af0a8-3f68-409b-8941-cf8caf8f28a0
|
|
7257
|
+
description: Ritenuta d'acconto 23% su 20%
|
|
7258
|
+
rate: 0.046
|
|
7259
|
+
deprecated: false
|
|
7260
|
+
/commercialDiscounts.list:
|
|
7261
|
+
post:
|
|
7262
|
+
tags:
|
|
7263
|
+
- commercial_discounts
|
|
7264
|
+
summary: commercialDiscounts.list
|
|
7265
|
+
description: Get a list of commercial discounts.
|
|
7266
|
+
operationId: commercialDiscounts.list
|
|
7267
|
+
parameters: []
|
|
7268
|
+
requestBody:
|
|
7269
|
+
description: ''
|
|
7270
|
+
content:
|
|
7271
|
+
application/json:
|
|
7272
|
+
schema:
|
|
7273
|
+
allOf:
|
|
7274
|
+
- $ref: '#/components/schemas/commercialDiscounts.listrequest'
|
|
7275
|
+
- example:
|
|
7276
|
+
filter:
|
|
7277
|
+
department_id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
|
|
7278
|
+
example:
|
|
7279
|
+
filter:
|
|
7280
|
+
department_id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
|
|
7281
|
+
required: true
|
|
7282
|
+
responses:
|
|
7283
|
+
'200':
|
|
7284
|
+
description: ''
|
|
7285
|
+
headers: {}
|
|
7286
|
+
content:
|
|
7287
|
+
application/json:
|
|
7288
|
+
schema:
|
|
7289
|
+
allOf:
|
|
7290
|
+
- $ref: '#/components/schemas/commercialDiscounts.listresponse'
|
|
7291
|
+
- example:
|
|
7292
|
+
data:
|
|
7293
|
+
- name: My holiday discount
|
|
7294
|
+
department:
|
|
7295
|
+
type: department
|
|
7296
|
+
id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
|
|
7297
|
+
example:
|
|
7298
|
+
data:
|
|
7299
|
+
- name: My holiday discount
|
|
7300
|
+
department:
|
|
7301
|
+
type: department
|
|
7302
|
+
id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
|
|
7303
|
+
deprecated: false
|
|
7304
|
+
/paymentMethods.list:
|
|
7305
|
+
post:
|
|
7306
|
+
tags:
|
|
7307
|
+
- payment_methods
|
|
7308
|
+
summary: paymentMethods.list
|
|
7309
|
+
description: Get a list of payment methods.
|
|
7310
|
+
operationId: paymentMethods.list
|
|
7311
|
+
parameters: []
|
|
7312
|
+
requestBody:
|
|
7313
|
+
description: ''
|
|
7314
|
+
content:
|
|
7315
|
+
application/json:
|
|
7316
|
+
schema:
|
|
7317
|
+
allOf:
|
|
7318
|
+
- $ref: '#/components/schemas/paymentMethods.listrequest'
|
|
7319
|
+
required: true
|
|
7320
|
+
responses:
|
|
7321
|
+
'200':
|
|
7322
|
+
description: ''
|
|
7323
|
+
headers: {}
|
|
7324
|
+
content:
|
|
7325
|
+
application/json:
|
|
7326
|
+
schema:
|
|
7327
|
+
allOf:
|
|
7328
|
+
- $ref: '#/components/schemas/paymentMethods.listresponse'
|
|
7329
|
+
- example:
|
|
7330
|
+
data:
|
|
7331
|
+
- id: 49b403be-a32e-0901-9b1c-25214f9027c6
|
|
7332
|
+
name: Coupons
|
|
7333
|
+
status: active
|
|
7334
|
+
example:
|
|
7335
|
+
data:
|
|
7336
|
+
- id: 49b403be-a32e-0901-9b1c-25214f9027c6
|
|
7337
|
+
name: Coupons
|
|
7338
|
+
status: active
|
|
7339
|
+
deprecated: false
|
|
7340
|
+
/bookkeepingSubmissions.list:
|
|
7341
|
+
post:
|
|
7342
|
+
summary: bookkeepingSubmissions.list
|
|
7343
|
+
operationId: bookkeepingSubmissions.list
|
|
7344
|
+
description: List all bookkeeping submissions belonging to a specific financial document id and type
|
|
7345
|
+
tags:
|
|
7346
|
+
- bookkeeping_submissions
|
|
7347
|
+
parameters: []
|
|
7348
|
+
requestBody:
|
|
7349
|
+
content:
|
|
7350
|
+
application/json:
|
|
7351
|
+
example:
|
|
7352
|
+
filter:
|
|
7353
|
+
subject:
|
|
7354
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
7355
|
+
type: incoming_invoice
|
|
7356
|
+
schema:
|
|
7357
|
+
type: object
|
|
7358
|
+
properties:
|
|
7359
|
+
filter:
|
|
7360
|
+
type: object
|
|
7361
|
+
properties:
|
|
7362
|
+
subject:
|
|
7363
|
+
type: object
|
|
7364
|
+
properties:
|
|
7365
|
+
id:
|
|
7366
|
+
type: string
|
|
7367
|
+
description: UUID of the financial document
|
|
7368
|
+
type:
|
|
7369
|
+
type: string
|
|
7370
|
+
enum:
|
|
7371
|
+
- incoming_invoice
|
|
7372
|
+
- incoming_credit_note
|
|
7373
|
+
- receipt
|
|
7374
|
+
required:
|
|
7375
|
+
- subject
|
|
7376
|
+
responses:
|
|
7377
|
+
'200':
|
|
7378
|
+
description: OK
|
|
7379
|
+
headers: {}
|
|
7380
|
+
content:
|
|
7381
|
+
application/json:
|
|
7382
|
+
schema:
|
|
7383
|
+
type: object
|
|
7384
|
+
properties:
|
|
7385
|
+
data:
|
|
7386
|
+
type: array
|
|
7387
|
+
items:
|
|
7388
|
+
type: object
|
|
7389
|
+
properties:
|
|
7390
|
+
id:
|
|
7391
|
+
type: string
|
|
7392
|
+
description: UUID of the Bookkeeping Submission
|
|
7393
|
+
subject:
|
|
7394
|
+
type: object
|
|
7395
|
+
properties:
|
|
7396
|
+
id:
|
|
7397
|
+
type: string
|
|
7398
|
+
type:
|
|
7399
|
+
type: string
|
|
7400
|
+
enum:
|
|
7401
|
+
- incoming_invoice
|
|
7402
|
+
- incoming_credit_note
|
|
7403
|
+
- receipt
|
|
7404
|
+
email_address:
|
|
7405
|
+
type: string
|
|
7406
|
+
description: email address where the bookkeeping submission was sent
|
|
7407
|
+
status:
|
|
7408
|
+
type: string
|
|
7409
|
+
enum:
|
|
7410
|
+
- sending
|
|
7411
|
+
- confirmed
|
|
7412
|
+
- failed
|
|
7413
|
+
description: the current status of the bookkeeping submission
|
|
7414
|
+
created_at:
|
|
7415
|
+
type: string
|
|
7416
|
+
example:
|
|
7417
|
+
data:
|
|
7418
|
+
- id: 018d5965-19fb-701a-af11-e80451931551
|
|
7419
|
+
subject:
|
|
7420
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
7421
|
+
type: incoming_invoice
|
|
7422
|
+
email_address: john.doe@example.com
|
|
7423
|
+
status: sending
|
|
7424
|
+
created_at: '2025-02-26 15:56:40'
|
|
7425
|
+
/expenses.list:
|
|
7426
|
+
post:
|
|
7427
|
+
summary: expenses.list
|
|
7428
|
+
operationId: expenses.list
|
|
7429
|
+
description: Get a list of all expenses.
|
|
7430
|
+
tags:
|
|
7431
|
+
- expenses
|
|
7432
|
+
parameters: []
|
|
7433
|
+
requestBody:
|
|
7434
|
+
content:
|
|
7435
|
+
application/json:
|
|
7436
|
+
example:
|
|
7437
|
+
filter:
|
|
7438
|
+
term: search terms
|
|
7439
|
+
source_types:
|
|
7440
|
+
- incomingInvoice
|
|
7441
|
+
- incomingCreditNote
|
|
7442
|
+
- receipt
|
|
7443
|
+
review_statuses:
|
|
7444
|
+
- pending
|
|
7445
|
+
- approved
|
|
7446
|
+
- refused
|
|
7447
|
+
bookkeeping_statuses:
|
|
7448
|
+
- sent
|
|
7449
|
+
- not_sent
|
|
7450
|
+
document_date:
|
|
7451
|
+
operator: is_empty
|
|
7452
|
+
value: YYYY-MM-DD
|
|
7453
|
+
start: YYYY-MM-DD
|
|
7454
|
+
end: YYYY-MM-DD
|
|
7455
|
+
page:
|
|
7456
|
+
size: 20
|
|
7457
|
+
number: 1
|
|
7458
|
+
schema:
|
|
7459
|
+
type: object
|
|
7460
|
+
properties:
|
|
7461
|
+
filter:
|
|
7462
|
+
type: object
|
|
7463
|
+
properties:
|
|
7464
|
+
term:
|
|
7465
|
+
type: string
|
|
7466
|
+
description: Filters by document number and supplier name, case-insensitive
|
|
7467
|
+
source_types:
|
|
7468
|
+
type: array
|
|
7469
|
+
description: Filters by one or more source types
|
|
7470
|
+
items:
|
|
7471
|
+
type: string
|
|
7472
|
+
enum:
|
|
7473
|
+
- incomingInvoice
|
|
7474
|
+
- incomingCreditNote
|
|
7475
|
+
- receipt
|
|
7476
|
+
review_statuses:
|
|
7477
|
+
type: array
|
|
7478
|
+
description: Filters by one or more review statuses
|
|
7479
|
+
items:
|
|
7480
|
+
type: string
|
|
7481
|
+
enum:
|
|
7482
|
+
- pending
|
|
7483
|
+
- approved
|
|
7484
|
+
- refused
|
|
7485
|
+
bookkeeping_statuses:
|
|
7486
|
+
type: array
|
|
7487
|
+
description: Filters by one or more bookkeeping statuses
|
|
7488
|
+
items:
|
|
7489
|
+
type: string
|
|
7490
|
+
enum:
|
|
7491
|
+
- sent
|
|
7492
|
+
- not_sent
|
|
7493
|
+
document_date:
|
|
7494
|
+
type: object
|
|
7495
|
+
properties:
|
|
7496
|
+
operator:
|
|
7497
|
+
type: string
|
|
7498
|
+
enum:
|
|
7499
|
+
- is_empty
|
|
7500
|
+
- between
|
|
7501
|
+
- equals
|
|
7502
|
+
- before
|
|
7503
|
+
- after
|
|
7504
|
+
value:
|
|
7505
|
+
type: string
|
|
7506
|
+
description: Required if operator is `equals`, `before`, or `after`
|
|
7507
|
+
start:
|
|
7508
|
+
type: string
|
|
7509
|
+
description: Required if operator is `between`
|
|
7510
|
+
end:
|
|
7511
|
+
type: string
|
|
7512
|
+
description: Required if operator is `between`
|
|
7513
|
+
required:
|
|
7514
|
+
- operator
|
|
7515
|
+
page:
|
|
7516
|
+
type: object
|
|
7517
|
+
properties:
|
|
7518
|
+
size:
|
|
7519
|
+
type: number
|
|
7520
|
+
default: 20
|
|
7521
|
+
number:
|
|
7522
|
+
type: number
|
|
7523
|
+
default: 1
|
|
7524
|
+
responses:
|
|
7525
|
+
'200':
|
|
7526
|
+
description: OK
|
|
7527
|
+
headers: {}
|
|
7528
|
+
content:
|
|
7529
|
+
application/json:
|
|
7530
|
+
schema:
|
|
7531
|
+
type: object
|
|
7532
|
+
properties:
|
|
7533
|
+
data:
|
|
7534
|
+
type: array
|
|
7535
|
+
items:
|
|
7536
|
+
type: object
|
|
7537
|
+
properties:
|
|
7538
|
+
source:
|
|
7539
|
+
type: object
|
|
7540
|
+
properties:
|
|
7541
|
+
type:
|
|
7542
|
+
type: string
|
|
7543
|
+
enum:
|
|
7544
|
+
- incomingInvoice
|
|
7545
|
+
- incomingCreditNote
|
|
7546
|
+
- receipt
|
|
7547
|
+
id:
|
|
7548
|
+
type: string
|
|
7549
|
+
origin:
|
|
7550
|
+
type: object
|
|
7551
|
+
properties:
|
|
7552
|
+
type:
|
|
7553
|
+
type: string
|
|
7554
|
+
enum:
|
|
7555
|
+
- user
|
|
7556
|
+
- peppolIncomingDocument
|
|
7557
|
+
id:
|
|
7558
|
+
type: string
|
|
7559
|
+
title:
|
|
7560
|
+
type: string
|
|
7561
|
+
supplier:
|
|
7562
|
+
type: object
|
|
7563
|
+
properties:
|
|
7564
|
+
type:
|
|
7565
|
+
type: string
|
|
7566
|
+
enum:
|
|
7567
|
+
- company
|
|
7568
|
+
- contact
|
|
7569
|
+
id:
|
|
7570
|
+
type: string
|
|
7571
|
+
nullable: true
|
|
7572
|
+
document_number:
|
|
7573
|
+
type: string
|
|
7574
|
+
nullable: true
|
|
7575
|
+
document_date:
|
|
7576
|
+
type: string
|
|
7577
|
+
nullable: true
|
|
7578
|
+
due_date:
|
|
7579
|
+
type: string
|
|
7580
|
+
nullable: true
|
|
7581
|
+
currency:
|
|
7582
|
+
type: object
|
|
7583
|
+
properties:
|
|
7584
|
+
code:
|
|
7585
|
+
$ref: '#/components/schemas/CurrencyCode'
|
|
7586
|
+
total:
|
|
7587
|
+
type: object
|
|
7588
|
+
properties:
|
|
7589
|
+
tax_exclusive:
|
|
7590
|
+
type: object
|
|
7591
|
+
properties:
|
|
7592
|
+
amount:
|
|
7593
|
+
type: number
|
|
7594
|
+
nullable: true
|
|
7595
|
+
tax_inclusive:
|
|
7596
|
+
type: object
|
|
7597
|
+
properties:
|
|
7598
|
+
amount:
|
|
7599
|
+
type: number
|
|
7600
|
+
nullable: true
|
|
7601
|
+
company_entity:
|
|
7602
|
+
type: object
|
|
7603
|
+
properties:
|
|
7604
|
+
type:
|
|
7605
|
+
type: string
|
|
7606
|
+
id:
|
|
7607
|
+
type: string
|
|
7608
|
+
nullable: true
|
|
7609
|
+
file:
|
|
7610
|
+
type: object
|
|
7611
|
+
properties:
|
|
7612
|
+
type:
|
|
7613
|
+
type: string
|
|
7614
|
+
id:
|
|
7615
|
+
type: string
|
|
7616
|
+
nullable: true
|
|
7617
|
+
payment_reference:
|
|
7618
|
+
type: string
|
|
7619
|
+
nullable: true
|
|
7620
|
+
review_status:
|
|
7621
|
+
type: string
|
|
7622
|
+
enum:
|
|
7623
|
+
- pending
|
|
7624
|
+
- approved
|
|
7625
|
+
- refused
|
|
7626
|
+
bookkeeping_status:
|
|
7627
|
+
type: string
|
|
7628
|
+
enum:
|
|
7629
|
+
- not_sent
|
|
7630
|
+
- sent
|
|
7631
|
+
iban_number:
|
|
7632
|
+
type: string
|
|
7633
|
+
nullable: true
|
|
7634
|
+
meta:
|
|
7635
|
+
allOf:
|
|
7636
|
+
- $ref: '#/components/schemas/Meta'
|
|
7637
|
+
- description: Only included with request parameter `includes=pagination`
|
|
7638
|
+
example:
|
|
7639
|
+
data:
|
|
7640
|
+
- source:
|
|
7641
|
+
type: incomingInvoice
|
|
7642
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
7643
|
+
origin:
|
|
7644
|
+
type: user
|
|
7645
|
+
id: cde0bc5f-8602-4e12-b5d3-f03436b54c0d
|
|
7646
|
+
title: Cost
|
|
7647
|
+
supplier:
|
|
7648
|
+
type: company
|
|
7649
|
+
id: f29abf48-337d-44b4-aad4-585f5277a456
|
|
7650
|
+
document_number: DOC-2032039
|
|
7651
|
+
document_date: '2024-05-11'
|
|
7652
|
+
due_date: '2024-06-11'
|
|
7653
|
+
currency:
|
|
7654
|
+
code: EUR
|
|
7655
|
+
total:
|
|
7656
|
+
tax_exclusive:
|
|
7657
|
+
amount: 100
|
|
7658
|
+
tax_inclusive:
|
|
7659
|
+
amount: 100
|
|
7660
|
+
company_entity:
|
|
7661
|
+
type: department
|
|
7662
|
+
id: 018fcef1-4f96-7349-9f57-1c7857023c42
|
|
7663
|
+
file:
|
|
7664
|
+
type: file
|
|
7665
|
+
id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
|
|
7666
|
+
payment_reference: PR-12345
|
|
7667
|
+
review_status: pending
|
|
7668
|
+
bookkeeping_status: not_sent
|
|
7669
|
+
iban_number: FR7630006000011234567890189
|
|
7670
|
+
meta:
|
|
7671
|
+
page:
|
|
7672
|
+
size: 10
|
|
7673
|
+
number: 2
|
|
7674
|
+
matches: 12
|
|
7675
|
+
/incomingCreditNotes.add:
|
|
7676
|
+
post:
|
|
7677
|
+
summary: incomingCreditNotes.add
|
|
7678
|
+
operationId: incomingCreditNotes.add
|
|
7679
|
+
description: Adds an incoming credit note.
|
|
7680
|
+
tags:
|
|
7681
|
+
- incoming_credit_notes
|
|
7682
|
+
parameters: []
|
|
7683
|
+
requestBody:
|
|
7684
|
+
content:
|
|
7685
|
+
application/json:
|
|
7686
|
+
example:
|
|
7687
|
+
title: Incoming credit note
|
|
7688
|
+
supplier_id: ac4a3bc5-b11f-0eb6-8c20-0f0d697f8c2a
|
|
7689
|
+
document_number: DOC-2032039
|
|
7690
|
+
invoice_date: '2024-05-11'
|
|
7691
|
+
due_date: '2024-06-11'
|
|
7692
|
+
currency:
|
|
7693
|
+
code: EUR
|
|
7694
|
+
total:
|
|
7695
|
+
tax_exclusive:
|
|
7696
|
+
amount: 100
|
|
7697
|
+
tax_inclusive:
|
|
7698
|
+
amount: 100
|
|
7699
|
+
company_entity_id: 018fcef1-4f96-7349-9f57-1c7857023c42
|
|
7700
|
+
file_id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
|
|
7701
|
+
payment_reference: REF-3578296
|
|
7702
|
+
iban_number: BE68539007547034
|
|
7703
|
+
schema:
|
|
7704
|
+
type: object
|
|
7705
|
+
properties:
|
|
7706
|
+
title:
|
|
7707
|
+
type: string
|
|
7708
|
+
supplier_id:
|
|
7709
|
+
type: string
|
|
7710
|
+
nullable: true
|
|
7711
|
+
document_number:
|
|
7712
|
+
type: string
|
|
7713
|
+
nullable: true
|
|
7714
|
+
invoice_date:
|
|
7715
|
+
type: string
|
|
7716
|
+
nullable: true
|
|
7717
|
+
due_date:
|
|
7718
|
+
type: string
|
|
7719
|
+
nullable: true
|
|
7720
|
+
currency:
|
|
7721
|
+
type: object
|
|
7722
|
+
properties:
|
|
7723
|
+
code:
|
|
7724
|
+
allOf:
|
|
7725
|
+
- $ref: '#/components/schemas/CurrencyCode'
|
|
7726
|
+
- example: EUR
|
|
7727
|
+
required:
|
|
7728
|
+
- code
|
|
7729
|
+
total:
|
|
7730
|
+
type: object
|
|
7731
|
+
properties:
|
|
7732
|
+
tax_exclusive:
|
|
7733
|
+
type: object
|
|
7734
|
+
properties:
|
|
7735
|
+
amount:
|
|
7736
|
+
type: number
|
|
7737
|
+
required:
|
|
7738
|
+
- amount
|
|
7739
|
+
nullable: true
|
|
7740
|
+
tax_inclusive:
|
|
7741
|
+
type: object
|
|
7742
|
+
properties:
|
|
7743
|
+
amount:
|
|
7744
|
+
type: number
|
|
7745
|
+
required:
|
|
7746
|
+
- amount
|
|
7747
|
+
nullable: true
|
|
7748
|
+
company_entity_id:
|
|
7749
|
+
type: string
|
|
7750
|
+
description: Default company entity will be used if not provided
|
|
7751
|
+
file_id:
|
|
7752
|
+
type: string
|
|
7753
|
+
nullable: true
|
|
7754
|
+
payment_reference:
|
|
7755
|
+
type: string
|
|
7756
|
+
nullable: true
|
|
7757
|
+
iban_number:
|
|
7758
|
+
type: string
|
|
7759
|
+
nullable: true
|
|
7760
|
+
required:
|
|
7761
|
+
- title
|
|
7762
|
+
- currency
|
|
7763
|
+
responses:
|
|
7764
|
+
'201':
|
|
7765
|
+
description: Created
|
|
7766
|
+
headers: {}
|
|
7767
|
+
content:
|
|
7768
|
+
application/json:
|
|
7769
|
+
schema:
|
|
7770
|
+
type: object
|
|
7771
|
+
properties:
|
|
7772
|
+
data:
|
|
7773
|
+
type: object
|
|
7774
|
+
properties:
|
|
7775
|
+
type:
|
|
7776
|
+
type: string
|
|
7777
|
+
id:
|
|
7778
|
+
type: string
|
|
7779
|
+
example:
|
|
7780
|
+
data:
|
|
7781
|
+
type: incomingCreditNote
|
|
7782
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
7783
|
+
/incomingCreditNotes.approve:
|
|
7784
|
+
post:
|
|
7785
|
+
summary: incomingCreditNotes.approve
|
|
7786
|
+
operationId: incomingCreditNotes.approve
|
|
7787
|
+
description: Approve an incoming credit note.
|
|
7788
|
+
tags:
|
|
7789
|
+
- incoming_credit_notes
|
|
7790
|
+
parameters: []
|
|
7791
|
+
requestBody:
|
|
7792
|
+
content:
|
|
7793
|
+
application/json:
|
|
7794
|
+
example:
|
|
7795
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
7796
|
+
schema:
|
|
7797
|
+
type: object
|
|
7798
|
+
properties:
|
|
7799
|
+
id:
|
|
7800
|
+
type: string
|
|
7801
|
+
required:
|
|
7802
|
+
- id
|
|
7803
|
+
responses:
|
|
7804
|
+
'204':
|
|
7805
|
+
description: No Content
|
|
7806
|
+
headers: {}
|
|
7807
|
+
content: {}
|
|
7808
|
+
/incomingCreditNotes.delete:
|
|
7809
|
+
post:
|
|
7810
|
+
summary: incomingCreditNotes.delete
|
|
7811
|
+
operationId: incomingCreditNotes.delete
|
|
7812
|
+
description: Deletes an incoming credit note.
|
|
7813
|
+
tags:
|
|
7814
|
+
- incoming_credit_notes
|
|
7815
|
+
parameters: []
|
|
7816
|
+
requestBody:
|
|
7817
|
+
content:
|
|
7818
|
+
application/json:
|
|
7819
|
+
example:
|
|
7820
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
7821
|
+
schema:
|
|
7822
|
+
type: object
|
|
7823
|
+
properties:
|
|
7824
|
+
id:
|
|
7825
|
+
type: string
|
|
7826
|
+
required:
|
|
7827
|
+
- id
|
|
7828
|
+
responses:
|
|
7829
|
+
'204':
|
|
7830
|
+
description: No Content
|
|
7831
|
+
headers: {}
|
|
7832
|
+
content: {}
|
|
7833
|
+
/incomingCreditNotes.info:
|
|
7834
|
+
post:
|
|
7835
|
+
summary: incomingCreditNotes.info
|
|
7836
|
+
operationId: incomingCreditNotes.info
|
|
7837
|
+
description: Get details for a single incoming credit note.
|
|
7838
|
+
tags:
|
|
7839
|
+
- incoming_credit_notes
|
|
7840
|
+
parameters: []
|
|
7841
|
+
requestBody:
|
|
7842
|
+
content:
|
|
7843
|
+
application/json:
|
|
7844
|
+
example:
|
|
7845
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
7846
|
+
schema:
|
|
7847
|
+
type: object
|
|
7848
|
+
properties:
|
|
7849
|
+
id:
|
|
7850
|
+
type: string
|
|
7851
|
+
required:
|
|
7852
|
+
- id
|
|
7853
|
+
responses:
|
|
7854
|
+
'200':
|
|
7855
|
+
description: OK
|
|
7856
|
+
headers: {}
|
|
7857
|
+
content:
|
|
7858
|
+
application/json:
|
|
7859
|
+
schema:
|
|
7860
|
+
type: object
|
|
7861
|
+
properties:
|
|
7862
|
+
data:
|
|
7863
|
+
type: object
|
|
7864
|
+
properties:
|
|
7865
|
+
id:
|
|
7866
|
+
type: string
|
|
7867
|
+
title:
|
|
7868
|
+
type: string
|
|
7869
|
+
origin:
|
|
7870
|
+
type: object
|
|
7871
|
+
properties:
|
|
7872
|
+
type:
|
|
7873
|
+
type: string
|
|
7874
|
+
enum:
|
|
7875
|
+
- user
|
|
7876
|
+
- peppolIncomingDocument
|
|
7877
|
+
id:
|
|
7878
|
+
type: string
|
|
7879
|
+
supplier:
|
|
7880
|
+
type: object
|
|
7881
|
+
properties:
|
|
7882
|
+
type:
|
|
7883
|
+
type: string
|
|
7884
|
+
enum:
|
|
7885
|
+
- company
|
|
7886
|
+
- contact
|
|
7887
|
+
id:
|
|
7888
|
+
type: string
|
|
7889
|
+
nullable: true
|
|
7890
|
+
document_number:
|
|
7891
|
+
type: string
|
|
7892
|
+
nullable: true
|
|
7893
|
+
invoice_date:
|
|
7894
|
+
type: string
|
|
7895
|
+
nullable: true
|
|
7896
|
+
due_date:
|
|
7897
|
+
type: string
|
|
7898
|
+
nullable: true
|
|
7899
|
+
currency:
|
|
7900
|
+
type: object
|
|
7901
|
+
properties:
|
|
7902
|
+
code:
|
|
7903
|
+
$ref: '#/components/schemas/CurrencyCode'
|
|
7904
|
+
total:
|
|
7905
|
+
type: object
|
|
7906
|
+
properties:
|
|
7907
|
+
tax_exclusive:
|
|
7908
|
+
type: object
|
|
7909
|
+
properties:
|
|
7910
|
+
amount:
|
|
7911
|
+
type: number
|
|
7912
|
+
nullable: true
|
|
7913
|
+
tax_inclusive:
|
|
7914
|
+
type: object
|
|
7915
|
+
properties:
|
|
7916
|
+
amount:
|
|
7917
|
+
type: number
|
|
7918
|
+
nullable: true
|
|
7919
|
+
company_entity:
|
|
7920
|
+
type: object
|
|
7921
|
+
properties:
|
|
7922
|
+
type:
|
|
7923
|
+
type: string
|
|
7924
|
+
id:
|
|
7925
|
+
type: string
|
|
7926
|
+
file:
|
|
7927
|
+
type: object
|
|
7928
|
+
properties:
|
|
7929
|
+
type:
|
|
7930
|
+
type: string
|
|
7931
|
+
id:
|
|
7932
|
+
type: string
|
|
7933
|
+
nullable: true
|
|
7934
|
+
payment_reference:
|
|
7935
|
+
type: string
|
|
7936
|
+
nullable: true
|
|
7937
|
+
review_status:
|
|
7938
|
+
type: string
|
|
7939
|
+
enum:
|
|
7940
|
+
- pending
|
|
7941
|
+
- approved
|
|
7942
|
+
- refused
|
|
7943
|
+
iban_number:
|
|
7944
|
+
type: string
|
|
7945
|
+
nullable: true
|
|
7946
|
+
example:
|
|
7947
|
+
data:
|
|
7948
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
7949
|
+
title: Incoming credit note
|
|
7950
|
+
origin:
|
|
7951
|
+
type: user
|
|
7952
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
7953
|
+
supplier:
|
|
7954
|
+
type: company
|
|
7955
|
+
id: f29abf48-337d-44b4-aad4-585f5277a456
|
|
7956
|
+
document_number: DOC-2032039
|
|
7957
|
+
invoice_date: '2024-05-11'
|
|
7958
|
+
due_date: '2024-06-11'
|
|
7959
|
+
currency:
|
|
7960
|
+
code: EUR
|
|
7961
|
+
total:
|
|
7962
|
+
tax_exclusive:
|
|
7963
|
+
amount: 100
|
|
7964
|
+
tax_inclusive:
|
|
7965
|
+
amount: 100
|
|
7966
|
+
company_entity:
|
|
7967
|
+
type: department
|
|
7968
|
+
id: 018fcef1-4f96-7349-9f57-1c7857023c42
|
|
7969
|
+
file:
|
|
7970
|
+
type: file
|
|
7971
|
+
id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
|
|
7972
|
+
payment_reference: REF-3578296
|
|
7973
|
+
review_status: pending
|
|
7974
|
+
iban_number: BE68539007547034
|
|
7975
|
+
/incomingCreditNotes.markAsPendingReview:
|
|
7976
|
+
post:
|
|
7977
|
+
summary: incomingCreditNotes.markAsPendingReview
|
|
7978
|
+
operationId: incomingCreditNotes.markAsPendingReview
|
|
7979
|
+
description: Mark an incoming credit note as pending review.
|
|
7980
|
+
tags:
|
|
7981
|
+
- incoming_credit_notes
|
|
7982
|
+
parameters: []
|
|
7983
|
+
requestBody:
|
|
7984
|
+
content:
|
|
7985
|
+
application/json:
|
|
7986
|
+
example:
|
|
7987
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
7988
|
+
schema:
|
|
7989
|
+
type: object
|
|
7990
|
+
properties:
|
|
7991
|
+
id:
|
|
7992
|
+
type: string
|
|
7993
|
+
required:
|
|
7994
|
+
- id
|
|
7995
|
+
responses:
|
|
7996
|
+
'204':
|
|
7997
|
+
description: No Content
|
|
7998
|
+
headers: {}
|
|
7999
|
+
content: {}
|
|
8000
|
+
/incomingCreditNotes.refuse:
|
|
8001
|
+
post:
|
|
8002
|
+
summary: incomingCreditNotes.refuse
|
|
8003
|
+
operationId: incomingCreditNotes.refuse
|
|
8004
|
+
description: Refuse an incoming credit note.
|
|
8005
|
+
tags:
|
|
8006
|
+
- incoming_credit_notes
|
|
8007
|
+
parameters: []
|
|
8008
|
+
requestBody:
|
|
8009
|
+
content:
|
|
8010
|
+
application/json:
|
|
8011
|
+
example:
|
|
8012
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8013
|
+
schema:
|
|
8014
|
+
type: object
|
|
8015
|
+
properties:
|
|
8016
|
+
id:
|
|
8017
|
+
type: string
|
|
8018
|
+
required:
|
|
8019
|
+
- id
|
|
8020
|
+
responses:
|
|
8021
|
+
'204':
|
|
8022
|
+
description: No Content
|
|
8023
|
+
headers: {}
|
|
8024
|
+
content: {}
|
|
8025
|
+
/incomingCreditNotes.sendToBookkeeping:
|
|
8026
|
+
post:
|
|
8027
|
+
summary: incomingCreditNotes.sendToBookkeeping
|
|
8028
|
+
operationId: incomingCreditNotes.sendToBookkeeping
|
|
8029
|
+
description: Send an incoming credit note to bookkeeping.
|
|
8030
|
+
tags:
|
|
8031
|
+
- incoming_credit_notes
|
|
8032
|
+
parameters: []
|
|
8033
|
+
requestBody:
|
|
8034
|
+
content:
|
|
8035
|
+
application/json:
|
|
8036
|
+
example:
|
|
8037
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8038
|
+
schema:
|
|
8039
|
+
type: object
|
|
8040
|
+
properties:
|
|
8041
|
+
id:
|
|
8042
|
+
type: string
|
|
8043
|
+
required:
|
|
8044
|
+
- id
|
|
8045
|
+
responses:
|
|
8046
|
+
'204':
|
|
8047
|
+
description: No Content
|
|
8048
|
+
headers: {}
|
|
8049
|
+
content: {}
|
|
8050
|
+
/incomingCreditNotes.update:
|
|
8051
|
+
post:
|
|
8052
|
+
summary: incomingCreditNotes.update
|
|
8053
|
+
operationId: incomingCreditNotes.update
|
|
8054
|
+
description: Updates an incoming credit note.
|
|
8055
|
+
tags:
|
|
8056
|
+
- incoming_credit_notes
|
|
8057
|
+
parameters: []
|
|
8058
|
+
requestBody:
|
|
8059
|
+
content:
|
|
8060
|
+
application/json:
|
|
8061
|
+
example:
|
|
8062
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8063
|
+
title: Incoming credit note
|
|
8064
|
+
supplier_id: ac4a3bc5-b11f-0eb6-8c20-0f0d697f8c2a
|
|
8065
|
+
document_number: DOC-2032039
|
|
8066
|
+
invoice_date: '2024-05-11'
|
|
8067
|
+
due_date: '2024-06-11'
|
|
8068
|
+
currency:
|
|
8069
|
+
code: EUR
|
|
8070
|
+
total:
|
|
8071
|
+
tax_exclusive:
|
|
8072
|
+
amount: 100
|
|
8073
|
+
tax_inclusive:
|
|
8074
|
+
amount: 100
|
|
8075
|
+
company_entity_id: 018fcef1-4f96-7349-9f57-1c7857023c42
|
|
8076
|
+
file_id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
|
|
8077
|
+
payment_reference: REF-3578296
|
|
8078
|
+
iban_number: BE68539007547034
|
|
8079
|
+
schema:
|
|
8080
|
+
type: object
|
|
8081
|
+
properties:
|
|
8082
|
+
id:
|
|
8083
|
+
type: string
|
|
8084
|
+
title:
|
|
8085
|
+
type: string
|
|
8086
|
+
supplier_id:
|
|
8087
|
+
type: string
|
|
8088
|
+
nullable: true
|
|
8089
|
+
document_number:
|
|
8090
|
+
type: string
|
|
8091
|
+
nullable: true
|
|
8092
|
+
invoice_date:
|
|
8093
|
+
type: string
|
|
8094
|
+
nullable: true
|
|
8095
|
+
due_date:
|
|
8096
|
+
type: string
|
|
8097
|
+
nullable: true
|
|
8098
|
+
currency:
|
|
8099
|
+
type: object
|
|
8100
|
+
properties:
|
|
8101
|
+
code:
|
|
8102
|
+
allOf:
|
|
8103
|
+
- $ref: '#/components/schemas/CurrencyCode'
|
|
8104
|
+
- example: EUR
|
|
8105
|
+
required:
|
|
8106
|
+
- code
|
|
8107
|
+
total:
|
|
8108
|
+
type: object
|
|
8109
|
+
properties:
|
|
8110
|
+
tax_exclusive:
|
|
8111
|
+
type: object
|
|
8112
|
+
properties:
|
|
8113
|
+
amount:
|
|
8114
|
+
type: number
|
|
8115
|
+
required:
|
|
8116
|
+
- amount
|
|
8117
|
+
nullable: true
|
|
8118
|
+
tax_inclusive:
|
|
8119
|
+
type: object
|
|
8120
|
+
properties:
|
|
8121
|
+
amount:
|
|
8122
|
+
type: number
|
|
8123
|
+
required:
|
|
8124
|
+
- amount
|
|
8125
|
+
nullable: true
|
|
8126
|
+
company_entity_id:
|
|
8127
|
+
type: string
|
|
8128
|
+
file_id:
|
|
8129
|
+
type: string
|
|
8130
|
+
nullable: true
|
|
8131
|
+
payment_reference:
|
|
8132
|
+
type: string
|
|
8133
|
+
nullable: true
|
|
8134
|
+
iban_number:
|
|
8135
|
+
type: string
|
|
8136
|
+
nullable: true
|
|
8137
|
+
required:
|
|
8138
|
+
- id
|
|
8139
|
+
responses:
|
|
8140
|
+
'204':
|
|
8141
|
+
description: No Content
|
|
8142
|
+
headers: {}
|
|
8143
|
+
content: {}
|
|
8144
|
+
/incomingInvoices.add:
|
|
8145
|
+
post:
|
|
8146
|
+
summary: incomingInvoices.add
|
|
8147
|
+
operationId: incomingInvoices.add
|
|
8148
|
+
description: Adds an incoming invoice.
|
|
8149
|
+
tags:
|
|
8150
|
+
- incoming_invoices
|
|
8151
|
+
parameters: []
|
|
8152
|
+
requestBody:
|
|
8153
|
+
content:
|
|
8154
|
+
application/json:
|
|
8155
|
+
example:
|
|
8156
|
+
title: Incoming invoice
|
|
8157
|
+
supplier_id: ac4a3bc5-b11f-0eb6-8c20-0f0d697f8c2a
|
|
8158
|
+
document_number: DOC-2032039
|
|
8159
|
+
invoice_date: '2024-05-11'
|
|
8160
|
+
due_date: '2024-06-11'
|
|
8161
|
+
currency:
|
|
8162
|
+
code: EUR
|
|
8163
|
+
total:
|
|
8164
|
+
tax_exclusive:
|
|
8165
|
+
amount: 100
|
|
8166
|
+
tax_inclusive:
|
|
8167
|
+
amount: 100
|
|
8168
|
+
company_entity_id: 018fcef1-4f96-7349-9f57-1c7857023c42
|
|
8169
|
+
file_id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
|
|
8170
|
+
payment_reference: REF-3578296
|
|
8171
|
+
iban_number: BE68539007547034
|
|
8172
|
+
schema:
|
|
8173
|
+
type: object
|
|
8174
|
+
properties:
|
|
8175
|
+
title:
|
|
8176
|
+
type: string
|
|
8177
|
+
supplier_id:
|
|
8178
|
+
type: string
|
|
8179
|
+
nullable: true
|
|
8180
|
+
document_number:
|
|
8181
|
+
type: string
|
|
8182
|
+
nullable: true
|
|
8183
|
+
invoice_date:
|
|
8184
|
+
type: string
|
|
8185
|
+
nullable: true
|
|
8186
|
+
due_date:
|
|
8187
|
+
type: string
|
|
8188
|
+
nullable: true
|
|
8189
|
+
currency:
|
|
8190
|
+
type: object
|
|
8191
|
+
properties:
|
|
8192
|
+
code:
|
|
8193
|
+
allOf:
|
|
8194
|
+
- $ref: '#/components/schemas/CurrencyCode'
|
|
8195
|
+
- example: EUR
|
|
8196
|
+
required:
|
|
8197
|
+
- code
|
|
8198
|
+
total:
|
|
8199
|
+
type: object
|
|
8200
|
+
properties:
|
|
8201
|
+
tax_exclusive:
|
|
8202
|
+
type: object
|
|
8203
|
+
properties:
|
|
8204
|
+
amount:
|
|
8205
|
+
type: number
|
|
8206
|
+
required:
|
|
8207
|
+
- amount
|
|
8208
|
+
nullable: true
|
|
8209
|
+
tax_inclusive:
|
|
8210
|
+
type: object
|
|
8211
|
+
properties:
|
|
8212
|
+
amount:
|
|
8213
|
+
type: number
|
|
8214
|
+
required:
|
|
8215
|
+
- amount
|
|
8216
|
+
nullable: true
|
|
8217
|
+
company_entity_id:
|
|
8218
|
+
type: string
|
|
8219
|
+
description: Default company entity will be used if not provided
|
|
8220
|
+
file_id:
|
|
8221
|
+
type: string
|
|
8222
|
+
nullable: true
|
|
8223
|
+
payment_reference:
|
|
8224
|
+
type: string
|
|
8225
|
+
nullable: true
|
|
8226
|
+
iban_number:
|
|
8227
|
+
type: string
|
|
8228
|
+
nullable: true
|
|
8229
|
+
required:
|
|
8230
|
+
- title
|
|
8231
|
+
- currency
|
|
8232
|
+
responses:
|
|
8233
|
+
'201':
|
|
8234
|
+
description: Created
|
|
8235
|
+
headers: {}
|
|
8236
|
+
content:
|
|
8237
|
+
application/json:
|
|
8238
|
+
schema:
|
|
8239
|
+
type: object
|
|
8240
|
+
properties:
|
|
8241
|
+
data:
|
|
8242
|
+
type: object
|
|
8243
|
+
properties:
|
|
8244
|
+
type:
|
|
8245
|
+
type: string
|
|
8246
|
+
id:
|
|
8247
|
+
type: string
|
|
8248
|
+
example:
|
|
8249
|
+
data:
|
|
8250
|
+
type: incomingInvoice
|
|
8251
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8252
|
+
/incomingInvoices.approve:
|
|
8253
|
+
post:
|
|
8254
|
+
summary: incomingInvoices.approve
|
|
8255
|
+
operationId: incomingInvoices.approve
|
|
8256
|
+
description: Approve an incoming invoice.
|
|
8257
|
+
tags:
|
|
8258
|
+
- incoming_invoices
|
|
8259
|
+
parameters: []
|
|
8260
|
+
requestBody:
|
|
8261
|
+
content:
|
|
8262
|
+
application/json:
|
|
8263
|
+
example:
|
|
8264
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8265
|
+
schema:
|
|
8266
|
+
type: object
|
|
8267
|
+
properties:
|
|
8268
|
+
id:
|
|
8269
|
+
type: string
|
|
8270
|
+
required:
|
|
8271
|
+
- id
|
|
8272
|
+
responses:
|
|
8273
|
+
'204':
|
|
8274
|
+
description: No Content
|
|
8275
|
+
headers: {}
|
|
8276
|
+
content: {}
|
|
8277
|
+
/incomingInvoices.delete:
|
|
8278
|
+
post:
|
|
8279
|
+
summary: incomingInvoices.delete
|
|
8280
|
+
operationId: incomingInvoices.delete
|
|
8281
|
+
description: Deletes an incoming invoice.
|
|
8282
|
+
tags:
|
|
8283
|
+
- incoming_invoices
|
|
8284
|
+
parameters: []
|
|
8285
|
+
requestBody:
|
|
8286
|
+
content:
|
|
8287
|
+
application/json:
|
|
8288
|
+
example:
|
|
8289
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8290
|
+
schema:
|
|
8291
|
+
type: object
|
|
8292
|
+
properties:
|
|
8293
|
+
id:
|
|
8294
|
+
type: string
|
|
8295
|
+
required:
|
|
8296
|
+
- id
|
|
8297
|
+
responses:
|
|
8298
|
+
'204':
|
|
8299
|
+
description: No Content
|
|
8300
|
+
headers: {}
|
|
8301
|
+
content: {}
|
|
8302
|
+
/incomingInvoices.info:
|
|
8303
|
+
post:
|
|
8304
|
+
summary: incomingInvoices.info
|
|
8305
|
+
operationId: incomingInvoices.info
|
|
8306
|
+
description: Get details for a single incoming invoice.
|
|
8307
|
+
tags:
|
|
8308
|
+
- incoming_invoices
|
|
8309
|
+
parameters: []
|
|
8310
|
+
requestBody:
|
|
8311
|
+
content:
|
|
8312
|
+
application/json:
|
|
8313
|
+
example:
|
|
8314
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8315
|
+
schema:
|
|
8316
|
+
type: object
|
|
8317
|
+
properties:
|
|
8318
|
+
id:
|
|
8319
|
+
type: string
|
|
8320
|
+
required:
|
|
8321
|
+
- id
|
|
8322
|
+
responses:
|
|
8323
|
+
'200':
|
|
8324
|
+
description: OK
|
|
8325
|
+
headers: {}
|
|
8326
|
+
content:
|
|
8327
|
+
application/json:
|
|
8328
|
+
schema:
|
|
8329
|
+
type: object
|
|
8330
|
+
properties:
|
|
8331
|
+
data:
|
|
8332
|
+
type: object
|
|
8333
|
+
properties:
|
|
8334
|
+
id:
|
|
8335
|
+
type: string
|
|
8336
|
+
title:
|
|
8337
|
+
type: string
|
|
8338
|
+
origin:
|
|
8339
|
+
type: object
|
|
8340
|
+
properties:
|
|
8341
|
+
type:
|
|
8342
|
+
type: string
|
|
8343
|
+
enum:
|
|
8344
|
+
- user
|
|
8345
|
+
- peppolIncomingDocument
|
|
8346
|
+
id:
|
|
8347
|
+
type: string
|
|
8348
|
+
supplier:
|
|
8349
|
+
type: object
|
|
8350
|
+
properties:
|
|
8351
|
+
type:
|
|
8352
|
+
type: string
|
|
8353
|
+
enum:
|
|
8354
|
+
- company
|
|
8355
|
+
- contact
|
|
8356
|
+
id:
|
|
8357
|
+
type: string
|
|
8358
|
+
nullable: true
|
|
8359
|
+
document_number:
|
|
8360
|
+
type: string
|
|
8361
|
+
nullable: true
|
|
8362
|
+
invoice_date:
|
|
8363
|
+
type: string
|
|
8364
|
+
nullable: true
|
|
8365
|
+
due_date:
|
|
8366
|
+
type: string
|
|
8367
|
+
nullable: true
|
|
8368
|
+
currency:
|
|
8369
|
+
type: object
|
|
8370
|
+
properties:
|
|
8371
|
+
code:
|
|
8372
|
+
$ref: '#/components/schemas/CurrencyCode'
|
|
8373
|
+
total:
|
|
8374
|
+
type: object
|
|
8375
|
+
properties:
|
|
8376
|
+
tax_exclusive:
|
|
8377
|
+
type: object
|
|
8378
|
+
properties:
|
|
8379
|
+
amount:
|
|
8380
|
+
type: number
|
|
8381
|
+
nullable: true
|
|
8382
|
+
tax_inclusive:
|
|
8383
|
+
type: object
|
|
8384
|
+
properties:
|
|
8385
|
+
amount:
|
|
8386
|
+
type: number
|
|
8387
|
+
nullable: true
|
|
8388
|
+
company_entity:
|
|
8389
|
+
type: object
|
|
8390
|
+
properties:
|
|
8391
|
+
type:
|
|
8392
|
+
type: string
|
|
8393
|
+
id:
|
|
8394
|
+
type: string
|
|
8395
|
+
file:
|
|
8396
|
+
type: object
|
|
8397
|
+
properties:
|
|
8398
|
+
type:
|
|
8399
|
+
type: string
|
|
8400
|
+
id:
|
|
8401
|
+
type: string
|
|
8402
|
+
nullable: true
|
|
8403
|
+
payment_reference:
|
|
8404
|
+
type: string
|
|
8405
|
+
nullable: true
|
|
8406
|
+
review_status:
|
|
8407
|
+
type: string
|
|
8408
|
+
enum:
|
|
8409
|
+
- pending
|
|
8410
|
+
- approved
|
|
8411
|
+
- refused
|
|
8412
|
+
iban_number:
|
|
8413
|
+
type: string
|
|
8414
|
+
nullable: true
|
|
8415
|
+
example:
|
|
8416
|
+
data:
|
|
8417
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8418
|
+
title: Incoming invoice
|
|
8419
|
+
origin:
|
|
8420
|
+
type: user
|
|
8421
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8422
|
+
supplier:
|
|
8423
|
+
type: company
|
|
8424
|
+
id: f29abf48-337d-44b4-aad4-585f5277a456
|
|
8425
|
+
document_number: DOC-2032039
|
|
8426
|
+
invoice_date: '2024-05-11'
|
|
8427
|
+
due_date: '2024-06-11'
|
|
8428
|
+
currency:
|
|
8429
|
+
code: EUR
|
|
8430
|
+
total:
|
|
8431
|
+
tax_exclusive:
|
|
8432
|
+
amount: 100
|
|
8433
|
+
tax_inclusive:
|
|
8434
|
+
amount: 100
|
|
8435
|
+
company_entity:
|
|
8436
|
+
type: department
|
|
8437
|
+
id: 018fcef1-4f96-7349-9f57-1c7857023c42
|
|
8438
|
+
file:
|
|
8439
|
+
type: file
|
|
8440
|
+
id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
|
|
8441
|
+
payment_reference: REF-3578296
|
|
8442
|
+
review_status: pending
|
|
8443
|
+
iban_number: BE68539007547034
|
|
8444
|
+
/incomingInvoices.markAsPendingReview:
|
|
8445
|
+
post:
|
|
8446
|
+
summary: incomingInvoices.markAsPendingReview
|
|
8447
|
+
operationId: incomingInvoices.markAsPendingReview
|
|
8448
|
+
description: Mark an incoming invoice as pending review.
|
|
8449
|
+
tags:
|
|
8450
|
+
- incoming_invoices
|
|
8451
|
+
parameters: []
|
|
8452
|
+
requestBody:
|
|
8453
|
+
content:
|
|
8454
|
+
application/json:
|
|
8455
|
+
example:
|
|
8456
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8457
|
+
schema:
|
|
8458
|
+
type: object
|
|
8459
|
+
properties:
|
|
8460
|
+
id:
|
|
8461
|
+
type: string
|
|
8462
|
+
required:
|
|
8463
|
+
- id
|
|
8464
|
+
responses:
|
|
8465
|
+
'204':
|
|
8466
|
+
description: No Content
|
|
8467
|
+
headers: {}
|
|
8468
|
+
content: {}
|
|
8469
|
+
/incomingInvoices.refuse:
|
|
8470
|
+
post:
|
|
8471
|
+
summary: incomingInvoices.refuse
|
|
8472
|
+
operationId: incomingInvoices.refuse
|
|
8473
|
+
description: Refuse an incoming invoice.
|
|
8474
|
+
tags:
|
|
8475
|
+
- incoming_invoices
|
|
8476
|
+
parameters: []
|
|
8477
|
+
requestBody:
|
|
8478
|
+
content:
|
|
8479
|
+
application/json:
|
|
8480
|
+
example:
|
|
8481
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8482
|
+
schema:
|
|
8483
|
+
type: object
|
|
8484
|
+
properties:
|
|
8485
|
+
id:
|
|
8486
|
+
type: string
|
|
8487
|
+
required:
|
|
8488
|
+
- id
|
|
8489
|
+
responses:
|
|
8490
|
+
'204':
|
|
8491
|
+
description: No Content
|
|
8492
|
+
headers: {}
|
|
8493
|
+
content: {}
|
|
8494
|
+
/incomingInvoices.sendToBookkeeping:
|
|
8495
|
+
post:
|
|
8496
|
+
summary: incomingInvoices.sendToBookkeeping
|
|
8497
|
+
operationId: incomingInvoices.sendToBookkeeping
|
|
8498
|
+
description: Send an incoming invoice to bookkeeping.
|
|
8499
|
+
tags:
|
|
8500
|
+
- incoming_invoices
|
|
8501
|
+
parameters: []
|
|
8502
|
+
requestBody:
|
|
8503
|
+
content:
|
|
8504
|
+
application/json:
|
|
8505
|
+
example:
|
|
8506
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8507
|
+
schema:
|
|
8508
|
+
type: object
|
|
8509
|
+
properties:
|
|
8510
|
+
id:
|
|
8511
|
+
type: string
|
|
8512
|
+
required:
|
|
8513
|
+
- id
|
|
8514
|
+
responses:
|
|
8515
|
+
'204':
|
|
8516
|
+
description: No Content
|
|
8517
|
+
headers: {}
|
|
8518
|
+
content: {}
|
|
8519
|
+
/incomingInvoices.update:
|
|
8520
|
+
post:
|
|
8521
|
+
summary: incomingInvoices.update
|
|
8522
|
+
operationId: incomingInvoices.update
|
|
8523
|
+
description: Updates an incoming invoice.
|
|
8524
|
+
tags:
|
|
8525
|
+
- incoming_invoices
|
|
8526
|
+
parameters: []
|
|
8527
|
+
requestBody:
|
|
8528
|
+
content:
|
|
8529
|
+
application/json:
|
|
8530
|
+
example:
|
|
8531
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8532
|
+
title: Incoming invoice
|
|
8533
|
+
supplier_id: ac4a3bc5-b11f-0eb6-8c20-0f0d697f8c2a
|
|
8534
|
+
document_number: DOC-2032039
|
|
8535
|
+
invoice_date: '2024-05-11'
|
|
8536
|
+
due_date: '2024-06-11'
|
|
8537
|
+
currency:
|
|
8538
|
+
code: EUR
|
|
8539
|
+
total:
|
|
8540
|
+
tax_exclusive:
|
|
8541
|
+
amount: 100
|
|
8542
|
+
tax_inclusive:
|
|
8543
|
+
amount: 100
|
|
8544
|
+
company_entity_id: 018fcef1-4f96-7349-9f57-1c7857023c42
|
|
8545
|
+
file_id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
|
|
8546
|
+
payment_reference: REF-3578296
|
|
8547
|
+
iban_number: BE68539007547034
|
|
8548
|
+
schema:
|
|
8549
|
+
type: object
|
|
8550
|
+
properties:
|
|
8551
|
+
id:
|
|
8552
|
+
type: string
|
|
8553
|
+
title:
|
|
8554
|
+
type: string
|
|
8555
|
+
supplier_id:
|
|
8556
|
+
type: string
|
|
8557
|
+
nullable: true
|
|
8558
|
+
document_number:
|
|
8559
|
+
type: string
|
|
8560
|
+
nullable: true
|
|
8561
|
+
invoice_date:
|
|
8562
|
+
type: string
|
|
8563
|
+
nullable: true
|
|
8564
|
+
due_date:
|
|
8565
|
+
type: string
|
|
8566
|
+
nullable: true
|
|
8567
|
+
currency:
|
|
8568
|
+
type: object
|
|
8569
|
+
properties:
|
|
8570
|
+
code:
|
|
8571
|
+
allOf:
|
|
8572
|
+
- $ref: '#/components/schemas/CurrencyCode'
|
|
8573
|
+
- example: EUR
|
|
8574
|
+
required:
|
|
8575
|
+
- code
|
|
8576
|
+
total:
|
|
8577
|
+
type: object
|
|
8578
|
+
properties:
|
|
8579
|
+
tax_exclusive:
|
|
8580
|
+
type: object
|
|
8581
|
+
properties:
|
|
8582
|
+
amount:
|
|
8583
|
+
type: number
|
|
8584
|
+
required:
|
|
8585
|
+
- amount
|
|
8586
|
+
nullable: true
|
|
8587
|
+
tax_inclusive:
|
|
8588
|
+
type: object
|
|
8589
|
+
properties:
|
|
8590
|
+
amount:
|
|
8591
|
+
type: number
|
|
8592
|
+
required:
|
|
8593
|
+
- amount
|
|
8594
|
+
nullable: true
|
|
8595
|
+
company_entity_id:
|
|
8596
|
+
type: string
|
|
8597
|
+
file_id:
|
|
8598
|
+
type: string
|
|
8599
|
+
nullable: true
|
|
8600
|
+
payment_reference:
|
|
8601
|
+
type: string
|
|
8602
|
+
nullable: true
|
|
8603
|
+
iban_number:
|
|
8604
|
+
type: string
|
|
8605
|
+
nullable: true
|
|
8606
|
+
required:
|
|
8607
|
+
- id
|
|
8608
|
+
responses:
|
|
8609
|
+
'204':
|
|
8610
|
+
description: No Content
|
|
8611
|
+
headers: {}
|
|
8612
|
+
content: {}
|
|
8613
|
+
/receipts.add:
|
|
8614
|
+
post:
|
|
8615
|
+
summary: receipts.add
|
|
8616
|
+
operationId: receipts.add
|
|
8617
|
+
description: Adds a receipt.
|
|
8618
|
+
tags:
|
|
8619
|
+
- receipts
|
|
8620
|
+
parameters: []
|
|
8621
|
+
requestBody:
|
|
8622
|
+
content:
|
|
8623
|
+
application/json:
|
|
8624
|
+
example:
|
|
8625
|
+
title: Receipt note
|
|
8626
|
+
supplier_id: ac4a3bc5-b11f-0eb6-8c20-0f0d697f8c2a
|
|
8627
|
+
document_number: DOC-2032039
|
|
8628
|
+
receipt_date: '2024-05-11'
|
|
8629
|
+
currency:
|
|
8630
|
+
code: EUR
|
|
8631
|
+
total:
|
|
8632
|
+
tax_inclusive:
|
|
8633
|
+
amount: 100
|
|
8634
|
+
company_entity_id: 018fcef1-4f96-7349-9f57-1c7857023c42
|
|
8635
|
+
file_id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
|
|
8636
|
+
schema:
|
|
8637
|
+
type: object
|
|
8638
|
+
properties:
|
|
8639
|
+
title:
|
|
8640
|
+
type: string
|
|
8641
|
+
supplier_id:
|
|
8642
|
+
type: string
|
|
8643
|
+
nullable: true
|
|
8644
|
+
document_number:
|
|
8645
|
+
type: string
|
|
8646
|
+
nullable: true
|
|
8647
|
+
receipt_date:
|
|
8648
|
+
type: string
|
|
8649
|
+
nullable: true
|
|
8650
|
+
currency:
|
|
8651
|
+
type: object
|
|
8652
|
+
properties:
|
|
8653
|
+
code:
|
|
8654
|
+
allOf:
|
|
8655
|
+
- $ref: '#/components/schemas/CurrencyCode'
|
|
8656
|
+
- example: EUR
|
|
8657
|
+
required:
|
|
8658
|
+
- code
|
|
8659
|
+
total:
|
|
8660
|
+
type: object
|
|
8661
|
+
properties:
|
|
8662
|
+
tax_inclusive:
|
|
8663
|
+
type: object
|
|
8664
|
+
properties:
|
|
8665
|
+
amount:
|
|
8666
|
+
type: number
|
|
8667
|
+
required:
|
|
8668
|
+
- amount
|
|
8669
|
+
nullable: true
|
|
8670
|
+
company_entity_id:
|
|
8671
|
+
type: string
|
|
8672
|
+
description: Default company entity will be used if not provided
|
|
8673
|
+
file_id:
|
|
8674
|
+
type: string
|
|
8675
|
+
nullable: true
|
|
8676
|
+
required:
|
|
8677
|
+
- title
|
|
8678
|
+
- currency
|
|
8679
|
+
responses:
|
|
8680
|
+
'201':
|
|
8681
|
+
description: Created
|
|
8682
|
+
headers: {}
|
|
8683
|
+
content:
|
|
8684
|
+
application/json:
|
|
8685
|
+
schema:
|
|
8686
|
+
type: object
|
|
8687
|
+
properties:
|
|
8688
|
+
data:
|
|
8689
|
+
type: object
|
|
8690
|
+
properties:
|
|
8691
|
+
type:
|
|
8692
|
+
type: string
|
|
8693
|
+
id:
|
|
8694
|
+
type: string
|
|
8695
|
+
example:
|
|
8696
|
+
data:
|
|
8697
|
+
type: receipt
|
|
8698
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8699
|
+
/receipts.approve:
|
|
8700
|
+
post:
|
|
8701
|
+
summary: receipts.approve
|
|
8702
|
+
operationId: receipts.approve
|
|
8703
|
+
description: Approve a receipt.
|
|
8704
|
+
tags:
|
|
8705
|
+
- receipts
|
|
8706
|
+
parameters: []
|
|
8707
|
+
requestBody:
|
|
8708
|
+
content:
|
|
8709
|
+
application/json:
|
|
8710
|
+
example:
|
|
8711
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8712
|
+
schema:
|
|
8713
|
+
type: object
|
|
8714
|
+
properties:
|
|
8715
|
+
id:
|
|
8716
|
+
type: string
|
|
8717
|
+
required:
|
|
8718
|
+
- id
|
|
8719
|
+
responses:
|
|
8720
|
+
'204':
|
|
8721
|
+
description: No Content
|
|
8722
|
+
headers: {}
|
|
8723
|
+
content: {}
|
|
8724
|
+
/receipts.delete:
|
|
8725
|
+
post:
|
|
8726
|
+
summary: receipts.delete
|
|
8727
|
+
operationId: receipts.delete
|
|
8728
|
+
description: Deletes a receipt.
|
|
8729
|
+
tags:
|
|
8730
|
+
- receipts
|
|
8731
|
+
parameters: []
|
|
8732
|
+
requestBody:
|
|
8733
|
+
content:
|
|
8734
|
+
application/json:
|
|
8735
|
+
example:
|
|
8736
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8737
|
+
schema:
|
|
8738
|
+
type: object
|
|
8739
|
+
properties:
|
|
8740
|
+
id:
|
|
8741
|
+
type: string
|
|
8742
|
+
required:
|
|
8743
|
+
- id
|
|
8744
|
+
responses:
|
|
8745
|
+
'204':
|
|
8746
|
+
description: No Content
|
|
8747
|
+
headers: {}
|
|
8748
|
+
content: {}
|
|
8749
|
+
/receipts.info:
|
|
8750
|
+
post:
|
|
8751
|
+
summary: receipts.info
|
|
8752
|
+
operationId: receipts.info
|
|
8753
|
+
description: Get details for a single receipt.
|
|
8754
|
+
tags:
|
|
8755
|
+
- receipts
|
|
8756
|
+
parameters: []
|
|
8757
|
+
requestBody:
|
|
8758
|
+
content:
|
|
8759
|
+
application/json:
|
|
8760
|
+
example:
|
|
8761
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8762
|
+
schema:
|
|
8763
|
+
type: object
|
|
8764
|
+
properties:
|
|
8765
|
+
id:
|
|
8766
|
+
type: string
|
|
8767
|
+
required:
|
|
8768
|
+
- id
|
|
8769
|
+
responses:
|
|
8770
|
+
'200':
|
|
8771
|
+
description: OK
|
|
7105
8772
|
headers: {}
|
|
7106
8773
|
content:
|
|
7107
8774
|
application/json:
|
|
7108
8775
|
schema:
|
|
7109
|
-
|
|
7110
|
-
|
|
7111
|
-
|
|
7112
|
-
|
|
7113
|
-
|
|
7114
|
-
|
|
7115
|
-
|
|
7116
|
-
|
|
7117
|
-
|
|
7118
|
-
|
|
8776
|
+
type: object
|
|
8777
|
+
properties:
|
|
8778
|
+
data:
|
|
8779
|
+
type: object
|
|
8780
|
+
properties:
|
|
8781
|
+
id:
|
|
8782
|
+
type: string
|
|
8783
|
+
title:
|
|
8784
|
+
type: string
|
|
8785
|
+
origin:
|
|
8786
|
+
type: object
|
|
8787
|
+
properties:
|
|
8788
|
+
type:
|
|
8789
|
+
type: string
|
|
8790
|
+
id:
|
|
8791
|
+
type: string
|
|
8792
|
+
supplier:
|
|
8793
|
+
type: object
|
|
8794
|
+
properties:
|
|
8795
|
+
type:
|
|
8796
|
+
type: string
|
|
8797
|
+
enum:
|
|
8798
|
+
- company
|
|
8799
|
+
- contact
|
|
8800
|
+
id:
|
|
8801
|
+
type: string
|
|
8802
|
+
nullable: true
|
|
8803
|
+
document_number:
|
|
8804
|
+
type: string
|
|
8805
|
+
nullable: true
|
|
8806
|
+
receipt_date:
|
|
8807
|
+
type: string
|
|
8808
|
+
nullable: true
|
|
8809
|
+
currency:
|
|
8810
|
+
type: object
|
|
8811
|
+
properties:
|
|
8812
|
+
code:
|
|
8813
|
+
$ref: '#/components/schemas/CurrencyCode'
|
|
8814
|
+
total:
|
|
8815
|
+
type: object
|
|
8816
|
+
properties:
|
|
8817
|
+
tax_inclusive:
|
|
8818
|
+
type: object
|
|
8819
|
+
properties:
|
|
8820
|
+
amount:
|
|
8821
|
+
type: number
|
|
8822
|
+
nullable: true
|
|
8823
|
+
company_entity:
|
|
8824
|
+
type: object
|
|
8825
|
+
properties:
|
|
8826
|
+
type:
|
|
8827
|
+
type: string
|
|
8828
|
+
id:
|
|
8829
|
+
type: string
|
|
8830
|
+
file:
|
|
8831
|
+
type: object
|
|
8832
|
+
properties:
|
|
8833
|
+
type:
|
|
8834
|
+
type: string
|
|
8835
|
+
id:
|
|
8836
|
+
type: string
|
|
8837
|
+
nullable: true
|
|
8838
|
+
review_status:
|
|
8839
|
+
type: string
|
|
8840
|
+
enum:
|
|
8841
|
+
- pending
|
|
8842
|
+
- approved
|
|
8843
|
+
- refused
|
|
7119
8844
|
example:
|
|
7120
8845
|
data:
|
|
7121
|
-
|
|
7122
|
-
|
|
7123
|
-
|
|
7124
|
-
|
|
7125
|
-
|
|
7126
|
-
|
|
7127
|
-
|
|
7128
|
-
|
|
8846
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8847
|
+
title: Receipt note
|
|
8848
|
+
origin:
|
|
8849
|
+
type: user
|
|
8850
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8851
|
+
supplier:
|
|
8852
|
+
type: company
|
|
8853
|
+
id: f29abf48-337d-44b4-aad4-585f5277a456
|
|
8854
|
+
document_number: DOC-2032039
|
|
8855
|
+
receipt_date: '2024-05-11'
|
|
8856
|
+
currency:
|
|
8857
|
+
code: EUR
|
|
8858
|
+
total:
|
|
8859
|
+
tax_inclusive:
|
|
8860
|
+
amount: 100
|
|
8861
|
+
company_entity:
|
|
8862
|
+
type: department
|
|
8863
|
+
id: 018fcef1-4f96-7349-9f57-1c7857023c42
|
|
8864
|
+
file:
|
|
8865
|
+
type: file
|
|
8866
|
+
id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
|
|
8867
|
+
review_status: pending
|
|
8868
|
+
/receipts.markAsPendingReview:
|
|
7129
8869
|
post:
|
|
8870
|
+
summary: receipts.markAsPendingReview
|
|
8871
|
+
operationId: receipts.markAsPendingReview
|
|
8872
|
+
description: Mark a receipts as pending review.
|
|
7130
8873
|
tags:
|
|
7131
|
-
-
|
|
7132
|
-
|
|
7133
|
-
|
|
7134
|
-
|
|
7135
|
-
|
|
7136
|
-
|
|
7137
|
-
|
|
7138
|
-
|
|
7139
|
-
|
|
7140
|
-
|
|
7141
|
-
|
|
7142
|
-
|
|
7143
|
-
|
|
7144
|
-
|
|
7145
|
-
example: application/json
|
|
8874
|
+
- receipts
|
|
8875
|
+
parameters: []
|
|
8876
|
+
requestBody:
|
|
8877
|
+
content:
|
|
8878
|
+
application/json:
|
|
8879
|
+
example:
|
|
8880
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8881
|
+
schema:
|
|
8882
|
+
type: object
|
|
8883
|
+
properties:
|
|
8884
|
+
id:
|
|
8885
|
+
type: string
|
|
8886
|
+
required:
|
|
8887
|
+
- id
|
|
7146
8888
|
responses:
|
|
7147
|
-
'
|
|
7148
|
-
description:
|
|
8889
|
+
'204':
|
|
8890
|
+
description: No Content
|
|
7149
8891
|
headers: {}
|
|
7150
|
-
content:
|
|
7151
|
-
|
|
7152
|
-
schema:
|
|
7153
|
-
allOf:
|
|
7154
|
-
- $ref: '#/components/schemas/paymentTerms.listresponse'
|
|
7155
|
-
- example:
|
|
7156
|
-
data:
|
|
7157
|
-
- id: c93ddb52-0af8-47d9-8551-441435be66a7
|
|
7158
|
-
type: cash
|
|
7159
|
-
meta:
|
|
7160
|
-
default: c93ddb52-0af8-47d9-8551-441435be66a7
|
|
7161
|
-
example:
|
|
7162
|
-
data:
|
|
7163
|
-
- id: c93ddb52-0af8-47d9-8551-441435be66a7
|
|
7164
|
-
type: cash
|
|
7165
|
-
meta:
|
|
7166
|
-
default: c93ddb52-0af8-47d9-8551-441435be66a7
|
|
7167
|
-
deprecated: false
|
|
7168
|
-
/withholdingTaxRates.list:
|
|
8892
|
+
content: {}
|
|
8893
|
+
/receipts.refuse:
|
|
7169
8894
|
post:
|
|
8895
|
+
summary: receipts.refuse
|
|
8896
|
+
operationId: receipts.refuse
|
|
8897
|
+
description: Refuse a receipts.
|
|
7170
8898
|
tags:
|
|
7171
|
-
-
|
|
7172
|
-
summary: withholdingTaxRates.list
|
|
7173
|
-
description: Get a list of available withholding tax rates.
|
|
7174
|
-
operationId: withholdingTaxRates.list
|
|
8899
|
+
- receipts
|
|
7175
8900
|
parameters: []
|
|
7176
8901
|
requestBody:
|
|
7177
|
-
description: ''
|
|
7178
8902
|
content:
|
|
7179
8903
|
application/json:
|
|
7180
|
-
schema:
|
|
7181
|
-
allOf:
|
|
7182
|
-
- $ref: '#/components/schemas/withholdingTaxRates.listrequest'
|
|
7183
|
-
- example:
|
|
7184
|
-
filter:
|
|
7185
|
-
department_id: 080aac72-ff1a-4627-bfe3-146b6eee979c
|
|
7186
8904
|
example:
|
|
7187
|
-
|
|
7188
|
-
|
|
7189
|
-
|
|
8905
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8906
|
+
schema:
|
|
8907
|
+
type: object
|
|
8908
|
+
properties:
|
|
8909
|
+
id:
|
|
8910
|
+
type: string
|
|
8911
|
+
required:
|
|
8912
|
+
- id
|
|
7190
8913
|
responses:
|
|
7191
|
-
'
|
|
7192
|
-
description:
|
|
8914
|
+
'204':
|
|
8915
|
+
description: No Content
|
|
7193
8916
|
headers: {}
|
|
7194
|
-
content:
|
|
7195
|
-
|
|
7196
|
-
schema:
|
|
7197
|
-
allOf:
|
|
7198
|
-
- $ref: '#/components/schemas/withholdingTaxRates.listresponse'
|
|
7199
|
-
- example:
|
|
7200
|
-
data:
|
|
7201
|
-
- id: c93ddb52-0af8-47d9-8551-441435be66a7
|
|
7202
|
-
department:
|
|
7203
|
-
type: department
|
|
7204
|
-
id: 182af0a8-3f68-409b-8941-cf8caf8f28a0
|
|
7205
|
-
description: Ritenuta d'acconto 23% su 20%
|
|
7206
|
-
rate: 0.046
|
|
7207
|
-
example:
|
|
7208
|
-
data:
|
|
7209
|
-
- id: c93ddb52-0af8-47d9-8551-441435be66a7
|
|
7210
|
-
department:
|
|
7211
|
-
type: department
|
|
7212
|
-
id: 182af0a8-3f68-409b-8941-cf8caf8f28a0
|
|
7213
|
-
description: Ritenuta d'acconto 23% su 20%
|
|
7214
|
-
rate: 0.046
|
|
7215
|
-
deprecated: false
|
|
7216
|
-
/commercialDiscounts.list:
|
|
8917
|
+
content: {}
|
|
8918
|
+
/receipts.sendToBookkeeping:
|
|
7217
8919
|
post:
|
|
8920
|
+
summary: receipts.sendToBookkeeping
|
|
8921
|
+
operationId: receipts.sendToBookkeeping
|
|
8922
|
+
description: Send a receipt to bookkeeping for processing.
|
|
7218
8923
|
tags:
|
|
7219
|
-
-
|
|
7220
|
-
summary: commercialDiscounts.list
|
|
7221
|
-
description: Get a list of commercial discounts.
|
|
7222
|
-
operationId: commercialDiscounts.list
|
|
8924
|
+
- receipts
|
|
7223
8925
|
parameters: []
|
|
7224
8926
|
requestBody:
|
|
7225
|
-
description: ''
|
|
7226
8927
|
content:
|
|
7227
8928
|
application/json:
|
|
7228
|
-
schema:
|
|
7229
|
-
allOf:
|
|
7230
|
-
- $ref: '#/components/schemas/commercialDiscounts.listrequest'
|
|
7231
|
-
- example:
|
|
7232
|
-
filter:
|
|
7233
|
-
department_id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
|
|
7234
8929
|
example:
|
|
7235
|
-
|
|
7236
|
-
|
|
7237
|
-
|
|
8930
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8931
|
+
schema:
|
|
8932
|
+
type: object
|
|
8933
|
+
properties:
|
|
8934
|
+
id:
|
|
8935
|
+
type: string
|
|
8936
|
+
required:
|
|
8937
|
+
- id
|
|
7238
8938
|
responses:
|
|
7239
|
-
'
|
|
7240
|
-
description:
|
|
8939
|
+
'204':
|
|
8940
|
+
description: No Content
|
|
7241
8941
|
headers: {}
|
|
7242
|
-
content:
|
|
7243
|
-
|
|
7244
|
-
schema:
|
|
7245
|
-
allOf:
|
|
7246
|
-
- $ref: '#/components/schemas/commercialDiscounts.listresponse'
|
|
7247
|
-
- example:
|
|
7248
|
-
data:
|
|
7249
|
-
- name: My holiday discount
|
|
7250
|
-
department:
|
|
7251
|
-
type: department
|
|
7252
|
-
id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
|
|
7253
|
-
example:
|
|
7254
|
-
data:
|
|
7255
|
-
- name: My holiday discount
|
|
7256
|
-
department:
|
|
7257
|
-
type: department
|
|
7258
|
-
id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
|
|
7259
|
-
deprecated: false
|
|
7260
|
-
/paymentMethods.list:
|
|
8942
|
+
content: {}
|
|
8943
|
+
/receipts.update:
|
|
7261
8944
|
post:
|
|
8945
|
+
summary: receipts.update
|
|
8946
|
+
operationId: receipts.update
|
|
8947
|
+
description: Updates a receipt.
|
|
7262
8948
|
tags:
|
|
7263
|
-
-
|
|
7264
|
-
summary: paymentMethods.list
|
|
7265
|
-
description: Get a list of payment methods.
|
|
7266
|
-
operationId: paymentMethods.list
|
|
8949
|
+
- receipts
|
|
7267
8950
|
parameters: []
|
|
7268
8951
|
requestBody:
|
|
7269
|
-
description: ''
|
|
7270
8952
|
content:
|
|
7271
8953
|
application/json:
|
|
8954
|
+
example:
|
|
8955
|
+
id: 018d5965-19fb-701a-af11-e80451931551
|
|
8956
|
+
title: Receipt note
|
|
8957
|
+
supplier_id: ac4a3bc5-b11f-0eb6-8c20-0f0d697f8c2a
|
|
8958
|
+
document_number: DOC-2032039
|
|
8959
|
+
receipt_date: '2024-05-11'
|
|
8960
|
+
currency:
|
|
8961
|
+
code: EUR
|
|
8962
|
+
total:
|
|
8963
|
+
tax_inclusive:
|
|
8964
|
+
amount: 100
|
|
8965
|
+
company_entity_id: 018fcef1-4f96-7349-9f57-1c7857023c42
|
|
8966
|
+
file_id: 5027619a-5e0a-01ce-a533-f80dfcc3f142
|
|
7272
8967
|
schema:
|
|
7273
|
-
|
|
7274
|
-
|
|
7275
|
-
|
|
8968
|
+
type: object
|
|
8969
|
+
properties:
|
|
8970
|
+
id:
|
|
8971
|
+
type: string
|
|
8972
|
+
title:
|
|
8973
|
+
type: string
|
|
8974
|
+
supplier_id:
|
|
8975
|
+
type: string
|
|
8976
|
+
nullable: true
|
|
8977
|
+
document_number:
|
|
8978
|
+
type: string
|
|
8979
|
+
nullable: true
|
|
8980
|
+
receipt_date:
|
|
8981
|
+
type: string
|
|
8982
|
+
nullable: true
|
|
8983
|
+
currency:
|
|
8984
|
+
type: object
|
|
8985
|
+
properties:
|
|
8986
|
+
code:
|
|
8987
|
+
allOf:
|
|
8988
|
+
- $ref: '#/components/schemas/CurrencyCode'
|
|
8989
|
+
- example: EUR
|
|
8990
|
+
required:
|
|
8991
|
+
- code
|
|
8992
|
+
total:
|
|
8993
|
+
type: object
|
|
8994
|
+
properties:
|
|
8995
|
+
tax_inclusive:
|
|
8996
|
+
type: object
|
|
8997
|
+
properties:
|
|
8998
|
+
amount:
|
|
8999
|
+
type: number
|
|
9000
|
+
required:
|
|
9001
|
+
- amount
|
|
9002
|
+
nullable: true
|
|
9003
|
+
company_entity_id:
|
|
9004
|
+
type: string
|
|
9005
|
+
file_id:
|
|
9006
|
+
type: string
|
|
9007
|
+
nullable: true
|
|
9008
|
+
required:
|
|
9009
|
+
- id
|
|
7276
9010
|
responses:
|
|
7277
|
-
'
|
|
7278
|
-
description:
|
|
9011
|
+
'204':
|
|
9012
|
+
description: No Content
|
|
7279
9013
|
headers: {}
|
|
7280
|
-
content:
|
|
7281
|
-
application/json:
|
|
7282
|
-
schema:
|
|
7283
|
-
allOf:
|
|
7284
|
-
- $ref: '#/components/schemas/paymentMethods.listresponse'
|
|
7285
|
-
- example:
|
|
7286
|
-
data:
|
|
7287
|
-
- id: 49b403be-a32e-0901-9b1c-25214f9027c6
|
|
7288
|
-
name: Coupons
|
|
7289
|
-
status: active
|
|
7290
|
-
example:
|
|
7291
|
-
data:
|
|
7292
|
-
- id: 49b403be-a32e-0901-9b1c-25214f9027c6
|
|
7293
|
-
name: Coupons
|
|
7294
|
-
status: active
|
|
7295
|
-
deprecated: false
|
|
9014
|
+
content: {}
|
|
7296
9015
|
/productCategories.list:
|
|
7297
9016
|
post:
|
|
7298
9017
|
tags:
|
|
@@ -20860,6 +22579,15 @@ components:
|
|
|
20860
22579
|
items:
|
|
20861
22580
|
type: string
|
|
20862
22581
|
description: an array of file ids
|
|
22582
|
+
invoices.sendViaPeppol:
|
|
22583
|
+
title: invoices.sendViaPeppol
|
|
22584
|
+
required:
|
|
22585
|
+
- id
|
|
22586
|
+
type: object
|
|
22587
|
+
properties:
|
|
22588
|
+
id:
|
|
22589
|
+
type: string
|
|
22590
|
+
example: 018d5965-19fb-701a-af11-e80451931551
|
|
20863
22591
|
creditNotes.listrequest:
|
|
20864
22592
|
title: creditNotes.listrequest
|
|
20865
22593
|
type: object
|
|
@@ -28293,6 +30021,13 @@ x-tagGroups:
|
|
|
28293
30021
|
- withholding_tax_rates
|
|
28294
30022
|
- commercial_discounts
|
|
28295
30023
|
- payment_methods
|
|
30024
|
+
- name: Expenses
|
|
30025
|
+
tags:
|
|
30026
|
+
- expenses
|
|
30027
|
+
- bookkeeping_submissions
|
|
30028
|
+
- incoming_invoices
|
|
30029
|
+
- incoming_credit_notes
|
|
30030
|
+
- receipts
|
|
28296
30031
|
- name: Products
|
|
28297
30032
|
tags:
|
|
28298
30033
|
- product_categories
|