develop #38

Merged
bboterm merged 451 commits from develop into main 2025-11-19 14:28:14 +00:00
Showing only changes of commit 71ab5176b5 - Show all commits

View File

@ -160,108 +160,108 @@ paths:
description: List containing multiple sales transaction items of transaction type 'sales' with different statuses. description: List containing multiple sales transaction items of transaction type 'sales' with different statuses.
value: value:
transactionItems: transactionItems:
- transactionItemId: afce35b2-1dff-4ace-98d0-4b9ac405c87d - transactionItemId: afce35b2-1dff-4ace-98d0-4b9ac405c87d
transactionType: sales transactionType: sales
sourceName: Verkoopengine sourceName: Verkoopengine
transactionId: 1001236 transactionId: 1001236
transactionLineId: 1 transactionLineId: 1
name: HTM Maandkorting 20% name: HTM Maandkorting 20%
quantity: 1 quantity: 1
taxCode: V21 taxCode: V21
amountExclTax: 100 amountExclTax: 100
amountInclTax: 121 amountInclTax: 121
amountTax: 21 amountTax: 21
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: 4031 articleNumber: 4031
status: created status: created
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
- transactionItemId: 1c1fc1c8-57f4-4336-9b43-a974eae5afbf - transactionItemId: 1c1fc1c8-57f4-4336-9b43-a974eae5afbf
transactionType: sales transactionType: sales
sourceName: Verkoopengine sourceName: Verkoopengine
transactionId: 1002001 transactionId: 1002001
transactionLineId: 1 transactionLineId: 1
name: Reisproduct HTM 3 dag Anoniem name: Reisproduct HTM 3 dag Anoniem
quantity: 1 quantity: 1
taxCode: V21 taxCode: V21
amountExclTax: 100 amountExclTax: 100
amountInclTax: 121 amountInclTax: 121
amountTax: 21 amountTax: 21
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: 4051 articleNumber: 4051
status: failed status: failed
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
- transactionItemId: 3f58441e-dc8f-4956-9bc5-c952312476db - transactionItemId: 3f58441e-dc8f-4956-9bc5-c952312476db
transactionType: sales transactionType: sales
sourceName: Verkoopengine sourceName: Verkoopengine
transactionId: 1001871 transactionId: 1001871
transactionLineId: 1 transactionLineId: 1
name: Reisproduct HTM 3 dag Anoniem name: Reisproduct HTM 3 dag Anoniem
quantity: 1 quantity: 1
taxCode: V21 taxCode: V21
amountExclTax: 100 amountExclTax: 100
amountInclTax: 121 amountInclTax: 121
amountTax: 21 amountTax: 21
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: 4051 articleNumber: 4051
status: returned to src status: returned to src
aggregationReference: FIKO-171f40609e aggregationReference: FIKO-171f40609e
accountingSystemReference: null accountingSystemReference: null
- transactionItemId: 4418825f-3f9b-45bc-b662-dc3cd4ce6599 - transactionItemId: 4418825f-3f9b-45bc-b662-dc3cd4ce6599
transactionType: sales transactionType: sales
sourceName: Verkoopengine sourceName: Verkoopengine
transactionId: 1001131 transactionId: 1001131
transactionLineId: 1 transactionLineId: 1
name: Reisproduct HTM 3 dag Anoniem name: Reisproduct HTM 3 dag Anoniem
quantity: 1 quantity: 1
taxCode: V21 taxCode: V21
amountExclTax: 100 amountExclTax: 100
amountInclTax: 121 amountInclTax: 121
amountTax: 21 amountTax: 21
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: 4051 articleNumber: 4051
status: returned to trx-db status: returned to trx-db
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
- transactionItemId: 2ddc1831-cf7b-4a77-8aa1-11aaf8e98d9f - transactionItemId: 2ddc1831-cf7b-4a77-8aa1-11aaf8e98d9f
transactionType: sales transactionType: sales
sourceName: Verkoopengine sourceName: Verkoopengine
transactionId: 1001885 transactionId: 1001885
transactionLineId: 1 transactionLineId: 1
name: Reisproduct HTM 3 dag Anoniem name: Reisproduct HTM 3 dag Anoniem
quantity: 1 quantity: 1
taxCode: V21 taxCode: V21
amountExclTax: 100 amountExclTax: 100
amountInclTax: 121 amountInclTax: 121
amountTax: 21 amountTax: 21
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: 4051 articleNumber: 4051
status: re-entered status: re-entered
aggregationReference: null aggregationReference: null
accountingSystemReference: null accountingSystemReference: null
- transactionItemId: 5ab2513d-f334-4cf8-8895-4e7269374a4b - transactionItemId: 5ab2513d-f334-4cf8-8895-4e7269374a4b
transactionType: sales transactionType: sales
sourceName: Verkoopengine sourceName: Verkoopengine
transactionId: 1001679 transactionId: 1001679
transactionLineId: 1 transactionLineId: 1
name: Reisproduct HTM 1 dag Anoniem name: Reisproduct HTM 1 dag Anoniem
quantity: 1 quantity: 1
taxCode: V21 taxCode: V21
amountExclTax: 100 amountExclTax: 100
amountInclTax: 121 amountInclTax: 121
amountTax: 21 amountTax: 21
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: 1737 articleNumber: 1737
status: succeeded status: succeeded
aggregationReference: FIKO-6a4fca8cd6 aggregationReference: FIKO-6a4fca8cd6
accountingSystemReference: U4F-123456 accountingSystemReference: U4F-123456
href: null href: null
post: post:
summary: Add one ore more finanicial transaction items in bulk. summary: Add one ore more finanicial transaction items in bulk.
@ -280,50 +280,50 @@ paths:
description: Add single transaction item of type sales. description: Add single transaction item of type sales.
value: value:
transactionItems: transactionItems:
- transactionType: sales - transactionType: sales
sourceName: Verkoopengine sourceName: Verkoopengine
transactionId: 1001236 transactionId: 1001236
transactionLineId: 1 transactionLineId: 1
name: HTM Maandkorting 20% name: HTM Maandkorting 20%
quantity: 1 quantity: 1
taxCode: V21 taxCode: V21
amountExclTax: 100 amountExclTax: 100
amountInclTax: 121 amountInclTax: 121
amountTax: 21 amountTax: 21
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: 4031 articleNumber: 4031
Add multiple transaction items: Add multiple transaction items:
summary: Add multiple transaction items summary: Add multiple transaction items
description: Add multiple transaction items of type sales. description: Add multiple transaction items of type sales.
value: value:
transactionItems: transactionItems:
- transactionType: sales - transactionType: sales
sourceName: Verkoopengine sourceName: Verkoopengine
transactionId: 1001236 transactionId: 1001236
transactionLineId: 1 transactionLineId: 1
name: HTM Maandkorting 20% name: HTM Maandkorting 20%
quantity: 1 quantity: 1
taxCode: V21 taxCode: V21
amountExclTax: 100 amountExclTax: 100
amountInclTax: 121 amountInclTax: 121
amountTax: 21 amountTax: 21
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: 4031 articleNumber: 4031
- transactionType: sales - transactionType: sales
sourceName: Verkoopengine sourceName: Verkoopengine
transactionId: 1001237 transactionId: 1001237
transactionLineId: 1 transactionLineId: 1
name: HTM Maandkorting 20% name: HTM Maandkorting 20%
quantity: 1 quantity: 1
taxCode: V21 taxCode: V21
amountExclTax: 100 amountExclTax: 100
amountInclTax: 121 amountInclTax: 121
amountTax: 21 amountTax: 21
occurredOn: 2024-10-04T00:00:00Z occurredOn: 2024-10-04T00:00:00Z
type: debit type: debit
articleNumber: 4031 articleNumber: 4031
responses: responses:
"202": "202":
description: Accepted description: Accepted
@ -903,7 +903,7 @@ paths:
example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
required: true required: true
description: The id of the booking metadata. description: The id of the booking metadata.
post: post:
summary: Add booking line metadata. summary: Add booking line metadata.
description: Add booking line metadata. description: Add booking line metadata.
tags: tags:
@ -1050,7 +1050,7 @@ paths:
schema: schema:
type: string type: string
example: Dagkaart example: Dagkaart
description: The article name of the booking line metadata. description: The article name of the booking line metadata.
- in: query - in: query
name: extRef1 name: extRef1
schema: schema:
@ -1065,7 +1065,7 @@ paths:
name: extRef3 name: extRef3
schema: schema:
type: string type: string
example: extRef3 example: extRef3
- in: query - in: query
name: extRef4 name: extRef4
schema: schema:
@ -1170,6 +1170,49 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/TaxMetadataGetResponseBody" $ref: "#/components/schemas/TaxMetadataGetResponseBody"
examples:
List containing all tax metadata:
summary: List containing all tax metadata
description: Returns a list containing all tax metadata (no filters applied).
value:
taxMetadata:
- taxMetadataId: 2d444740-4131-4169-bb47-2d125641dc87
taxCode: V0
texPercantageAmount: 0
description: BTW VERKOOP NUL
validFrom: 2024-03-22T09:00:00
validUntil: null
- taxMetadataId: b5f879d1-043d-4357-9655-2eeca8ebe9bf
taxCode: V09
taxPercentageAmount: 9
description: BTW VERKOOP LAAG 9%
validFrom: 2024-03-22T09:00:00
validUntil: null
- taxMetadataId: 62e1abe7-d76f-4364-9207-591c0601ba55
taxCode: V21
taxPercentageAmount: 21
description: BTW VERKOOP HOOG 21%
validFrom: 2024-03-22T09:00:00
validUntil: null
- taxMetadataId: 9a253fc3-e562-4c4a-925c-d9caf0dcc549
taxCode: ?0
taxPercentageAmount: 0
description: BTW DEBIT NUL
validFrom: 2024-03-22T09:00:00
validUntil: null
- taxMetadataId: 6243b848-5ca3-44e0-9860-4fb3a817f148
taxCode: ?09
taxPercentageAmount: 9
description: BTW DEBIT laag 9%
validFrom: 2024-03-22T09:00:00
validUntil: null
- taxMetadataId: 0240d6e4-6037-4da0-ac10-1fde0229d439
taxCode: ?21
taxPercentageAmount: 21
description: BTW DEBIT hoog 21%
validFrom: 2024-03-22T09:00:00
validUntil: null
href: null
post: post:
summary: Add tax metadata. summary: Add tax metadata.
description: Add tax metadata. description: Add tax metadata.
@ -1276,6 +1319,34 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/SourceMetadataGetResponseBody" $ref: "#/components/schemas/SourceMetadataGetResponseBody"
examples:
List containing all source metadata:
summary: List containing all source metadata
description: Returns a list containing all source metadata (no filters applied).
value:
sourceMetadata:
- sourceMetadataId: bc4ea24a-27a5-40e8-bbbc-57a105afaaa0
incomingName: HTM-web
incomingEntity: OrderLine
outgoingName: webshop
businessOwner: Corneel Verstoep
rejectionProcessing: system
rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc
- sourceMetadataId: c3a9ef01-06c6-4c05-8fc7-df825f676dfc
incomingName: HTM-app
incomingEntity: OrderLine
outgoingName: ticketapp
businessOwner: Daan Zeven
rejectionProcessing: mail
rejectionInfo: sven@infoplaza.nl
- sourceMetadataId: 0b6e3e07-c4e0-42bf-86f2-9c9522b71209
incomingName: SMP
incomingEntity: OrderLine
outgoingName: balieverkoop
businessOwner: Gijs Sip
rejectionProcessing: mail
rejectionInfo: ao@htm.nl
href: null
post: post:
summary: Add source metadata. summary: Add source metadata.
description: Add source metadata. description: Add source metadata.
@ -1340,7 +1411,7 @@ paths:
name: accountingPeriod name: accountingPeriod
schema: schema:
type: string type: string
example: 2024-01 example: 2024/01
description: The accounting period. description: The accounting period.
- in: query - in: query
name: isOpen name: isOpen
@ -1355,6 +1426,22 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/AccountingPeriodMetadataGetResponseBody" $ref: "#/components/schemas/AccountingPeriodMetadataGetResponseBody"
examples:
List containing all accounting period metadata:
summary: List containing all accounting period metadata
description: Returns a list containing all accounting period metadata (no filters applied).
value:
accountingPeriodMetadata:
- accountingPeriodMetadataId: e0af8c8f-d421-4567-a14e-48e2a1bb86fb
accountingPeriod: 2025/01
isOpen: true
- accountingPeriodMetadataId: 36a34bd8-2b84-4c89-87a4-22e809f6ed4a
accountingPeriod: 2024/12
isOpen: false
- accountingPeriodMetadataId: 33b4889b-0036-4870-87df-be43f9316cdf
accountingPeriod: 2024/11
isOpen: false
href: null
post: post:
summary: Add accounting period metadata. summary: Add accounting period metadata.
description: Add accounting period metadata. description: Add accounting period metadata.
@ -1443,6 +1530,55 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/ConcessionMetadataGetResponseBody" $ref: "#/components/schemas/ConcessionMetadataGetResponseBody"
examples:
List containing all concession metadata:
summary: List containing all concession metadata
description: Returns a list containing all concession metadata (no filters applied).
value:
concessionMetadata:
- concessionMetadataId: e0af8c8f-d421-4567-a14e-48e2a1bb86fb
concession:
concessionId: 1
name: RAIL
percentage: 84.021
validFrom: 2025-01-01T00:00:00.000
validUntil: null
- concessionMetadataId: 39720be0-af88-486a-b5e2-faea7eb5b352
concession:
concessionId: 2
name: BUS
percentage: 15.979
validFrom: 2025-01-01T00:00:00.000
validUntil: null
- concessionMetadataId: 274db383-96dd-410e-a07e-0b9e3040ac91
concession:
concessionId: 1
name: RAIL
percentage: 83.021
validFrom: 2024-12-01T00:00:00.000
validUntil: 2024-12-31T23:59:59.999
- concessionMetadataId: 03959bc5-83f2-4ac7-9bf5-67e0f2a6eace
concession:
concessionId: 2
name: BUS
percentage: 16.979
validFrom: 2024-12-01T00:00:00.000
validUntil: 2024-12-31T23:59:59.999
- concessionMetadataId: d5b7d8f6-5cb8-482e-9d9a-68909dc7b5d3
concession:
concessionId: 1
name: RAIL
percentage: 85.021
validFrom: 2024-11-01T00:00:00.000
validUntil: 2024-11-30T23:59:59.999
- concessionMetadataId: 5ee5f86f-ab00-4630-b130-4714fd060d1a
concession:
concessionId: 2
name: BUS
percentage: 14.979
validFrom: 2024-11-01T00:00:00.000
validUntil: 2024-11-30T23:59:59.999
href: null
post: post:
summary: Add concession metadata. summary: Add concession metadata.
description: Add concession metadata. description: Add concession metadata.
@ -1616,6 +1752,17 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/ConcessionsGetResponseBody" $ref: "#/components/schemas/ConcessionsGetResponseBody"
examples:
List containing all concessions:
summary: List containing all concessions
description: Returns a list containing all concessions (no filters applied).
value:
concessions:
- concessionId: 1
name: RAIL
- concessionId: 2
name: BUS
href: null
components: components:
securitySchemes: securitySchemes:
bearerToken: bearerToken:
@ -2558,14 +2705,14 @@ components:
example: Dagkaart - BUS example: Dagkaart - BUS
sourceMetadata: sourceMetadata:
type: object type: object
$ref: '#/components/schemas/SourceMetadata' $ref: "#/components/schemas/SourceMetadata"
identifyingFieldValue: identifyingFieldValue:
type: string type: string
example: null example: null
nullable: true nullable: true
concession: concession:
type: object type: object
$ref: '#/components/schemas/Concession' $ref: "#/components/schemas/Concession"
lineType: lineType:
type: string type: string
enum: enum:
@ -2672,7 +2819,7 @@ components:
example: null example: null
extRef2: extRef2:
type: string type: string
nullable: true nullable: true
example: null example: null
extRef3: extRef3:
type: string type: string
@ -3024,7 +3171,7 @@ components:
example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb
accountingPeriod: accountingPeriod:
type: string type: string
example: 2024-01 example: 2024/01
isOpen: isOpen:
type: boolean type: boolean
example: true example: true
@ -3042,7 +3189,7 @@ components:
properties: properties:
accountingPeriod: accountingPeriod:
type: string type: string
example: 2024-01 example: 2024/01
isOpen: isOpen:
type: boolean type: boolean
example: true example: true
@ -3063,7 +3210,7 @@ components:
properties: properties:
accountingPeriod: accountingPeriod:
type: string type: string
example: 2024-01 example: 2024/01
isOpen: isOpen:
type: boolean type: boolean
example: true example: true
@ -3177,7 +3324,7 @@ components:
concessions: concessions:
type: array type: array
items: items:
$ref: '#/components/schemas/Concession' $ref: "#/components/schemas/Concession"
href: href:
type: string type: string
nullable: true nullable: true