HTM/ovpay
4
0
Fork 0
Code Issues Pull Requests 3 Actions Packages Projects Releases 1 Wiki Activity

Merge branch 'develop' into feature/OVPAY-1433

Browse Source
This commit is contained in:
Mirjam Herald 2025-02-10 12:49:08 +00:00
commit 2bb61cbe98
2 changed files with 1966 additions and 361 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

627
src/openapi/fiko/fiko-crud.yaml
View File

@ -18,14 +18,14 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/TransactionItemsPostRequestBody" $ref: "#/components/schemas/unavailable"
responses: responses:
"201": "201":
description: Created description: Created
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/TransactionItemsPostResponseBody" $ref: "#/components/schemas/unavailable"
/fiko/transactionitems/bulk: /fiko/transactionitems/bulk:
post: post:
summary: Add one ore more finanicial transaction items in bulk. summary: Add one ore more finanicial transaction items in bulk.
@ -59,6 +59,15 @@ paths:
format: uuid format: uuid
example: 75174a9d-fff4-4682-b66b-ebd93cbe7ea3 example: 75174a9d-fff4-4682-b66b-ebd93cbe7ea3
description: The id of the transaction item. description: The id of the transaction item.
- in: query
name: transactionType
schema:
type: array
items:
type: string
example: [sales]
explode: false
description: Possible types of the transaction ('sales').
- in: query - in: query
name: sourceName name: sourceName
schema: schema:
@ -142,6 +151,15 @@ paths:
type: string type: string
example: HTM-MND-20 example: HTM-MND-20
description: The product code of the transaction. description: The product code of the transaction.
- in: query
name: status
schema:
type: array
items:
type: string
example: [created, succeeded, failed, returned to trx-db, returned to src, re-entered]
explode: false
description: Possible statuses of the transaction ('created', 'succeeded', 'failed', 'returned to trx-db', 'returned to src', 're-entered').
- in: query - in: query
name: aggregationReference name: aggregationReference
schema: schema:
@ -154,15 +172,6 @@ paths:
type: string type: string
example: U4F-123456 example: U4F-123456
description: The accounting system reference of the transaction. %00 is searching for NULL-values. description: The accounting system reference of the transaction. %00 is searching for NULL-values.
- in: query
name: highestProcessingFailureStatus
schema:
type: array
items:
type: string
example: [open]
explode: false
description: Find the highest processing failure status of the transaction. %00 is searching for NULL-values.
responses: responses:
"200": "200":
description: OK description: OK
@ -171,8 +180,9 @@ paths:
schema: schema:
$ref: "#/components/schemas/TransactionItemsGetResponseBody" $ref: "#/components/schemas/TransactionItemsGetResponseBody"
post: post:
summary: Add a finanicial transaction item. summary: DEPRECATED. Add a finanicial transaction item.
description: Add a finanicial transaction item. description: DEPRECATED. This API is deprecated. Use bulk-insert instead.
deprecated: true
tags: tags:
- Transactions v2 - Transactions v2
requestBody: requestBody:
@ -317,9 +327,18 @@ paths:
type: array type: array
items: items:
type: string type: string
example: [created, succeeded, failed] example: [create, update]
explode: false explode: false
description: The action of the event. description: The action of the event.
- in: query
name: status
schema:
type: array
items:
type: string
example: [created, succeeded, failed, returned to trx-db, returned to src, re-entered]
explode: false
description: The status of the transaction item.
- in: query - in: query
name: description name: description
schema: schema:
@ -361,75 +380,53 @@ paths:
example: 9834b346-d68c-438d-9bd5-6716422c2657 example: 9834b346-d68c-438d-9bd5-6716422c2657
description: The id of the transaction item. description: The id of the transaction item.
- in: query - in: query
name: department name: timestampBefore
schema: schema:
type: string type: string
example: 900 example: 2022-01-01 00:00:00
description: The department (element 1) of the processing failure. description: The timestamp before the event occured.
- in: query - in: query
name: costCenter name: timestampAfter
schema:
type: string
example: 2022-01-01 00:00:00
description: The timestamp after the event occured.
- in: query
name: element
schema:
type: string
example: contraAccount
description: The element on which the validation failed.
- in: query
name: value
schema: schema:
type: string type: string
example: 84955 example: 84955
description: The cost center (element 3) of the processing failure. description: The value of th element on which the validation failed.
- in: query - in: query
name: costType name: reasonCode
schema: schema:
type: string type: string
example: 619031 example: "002"
description: The cost type (element 2) of the processing failure. description: The code of the validation failure reason.
- in: query - in: query
name: documentDate name: reasonDescription
schema: schema:
type: string type: string
format: date example: Contra account does not exist.
example: 2024-10-04 description: The description of the validation failure reason.
description: The document date of the processing failure.
- in: query - in: query
name: documentCode name: resolved
schema:
type: boolean
example: true
description: Whether the failure is resolved.
- in: query
name: change
schema: schema:
type: string type: string
example: VERK_FACTUUR example: Adapt config
description: The document code of the processing failure. description: Description of what was changed to resolve the failure.
- in: query
name: accountingPeriod
schema:
type: string
example: 2024/10
description: The accounting period of the processing failure.
- in: query
name: transactionDescription
schema:
type: string
example: Dagkaart
description: The transaction description of the processing failure.
- in: query
name: contraAccount
schema:
type: string
example: 220.10419
description: The contra account of the processing failure.
- in: query
name: status
schema:
type: array
items:
type: string
example: [open, rejected]
explode: false
description: The status of the processing failure.
- in: query
name: minOccurences
schema:
type: integer
example: 1
description: Minimum number of occurences.
- in: query
name: maxOccurences
schema:
type: integer
example: 3
description: Maximum number of occurences.
responses: responses:
"200": "200":
description: OK description: OK
@ -464,60 +461,6 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/ProcessingFailuresPatchResponseBody" $ref: "#/components/schemas/ProcessingFailuresPatchResponseBody"
/processingfailures/{processingFailureId}/processingfailureinstances:
parameters:
- in: path
name: processingFailureId
schema:
type: string
format: uuid
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
required: true
description: The id of the processing failure.
post:
summary: Add a processing failure instance to a processing failure.
description: Add a processing failure instance to a processing failure.
tags:
- Failures v2
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ProcessingFailureInstancesPostRequestBody"
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "#/components/schemas/ProcessingFailureInstancesPostResponseBody"
/processingfailureinstances/{processingFailureInstanceId}:
parameters:
- in: path
name: processingFailureInstanceId
schema:
type: string
format: uuid
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
required: true
description: The id of the processing failure instance.
patch:
summary: Update processing failure instance.
description: Update processing failure instance.
tags:
- Failures v2
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ProcessingFailureInstancesPatchRequestBody"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/ProcessingFailureInstancesPatchResponseBody"
/productmetadata: /productmetadata:
get: get:
summary: Find product metadata. summary: Find product metadata.
@ -1364,19 +1307,6 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/ConcessionsGetResponseBody" $ref: "#/components/schemas/ConcessionsGetResponseBody"
/failurereasons:
get:
summary: Get all failure reasons.
description: Get all failure reasons.
tags:
- References v2
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/FailureReasonsGetResponseBody"
components: components:
securitySchemes: securitySchemes:
bearerToken: bearerToken:
@ -1397,6 +1327,11 @@ components:
transactionItemId: transactionItemId:
type: string type: string
example: afce35b2-1dff-4ace-98d0-4b9ac405c87d example: afce35b2-1dff-4ace-98d0-4b9ac405c87d
transactionType:
type: string
enum:
- sales
example: sales
sourceName: sourceName:
type: string type: string
example: Verkoopengine example: Verkoopengine
@ -1437,7 +1372,18 @@ components:
example: debit example: debit
productCode: productCode:
type: string type: string
nullable: true
example: HTM-MND-20 example: HTM-MND-20
status:
type: string
enum:
- created
- succeeded
- failed
- returned to trx-db
- returned to src
- re-entered
example: created
aggregationReference: aggregationReference:
type: string type: string
nullable: true nullable: true
@ -1448,6 +1394,7 @@ components:
example: U4F-123456 example: U4F-123456
required: required:
- transactionItemId - transactionItemId
- transactionType
- sourceName - sourceName
- transactionId - transactionId
- name - name
@ -1458,7 +1405,7 @@ components:
- amountTax - amountTax
- occurredOn - occurredOn
- type - type
- productCode - status
href: href:
type: string type: string
nullable: true nullable: true
@ -1467,6 +1414,11 @@ components:
TransactionItemsPostRequestBody: TransactionItemsPostRequestBody:
type: object type: object
properties: properties:
transactionType:
type: string
enum:
- sales
example: sales
sourceName: sourceName:
type: string type: string
example: Verkoopengine example: Verkoopengine
@ -1507,8 +1459,20 @@ components:
example: debit example: debit
productCode: productCode:
type: string type: string
nullable: true
example: HTM-MND-20 example: HTM-MND-20
status:
type: string
enum:
- created
- succeeded
- failed
- returned to trx-db
- returned to src
- re-entered
example: created
required: required:
- transactionType
- sourceName - sourceName
- transactionId - transactionId
- name - name
@ -1519,7 +1483,7 @@ components:
- amountTax - amountTax
- occurredOn - occurredOn
- type - type
- productCode - status
TransactionItemsPostResponseBody: TransactionItemsPostResponseBody:
type: object type: object
properties: properties:
@ -1537,6 +1501,11 @@ components:
items: items:
type: object type: object
properties: properties:
transactionType:
type: string
enum:
- sales
example: sales
sourceName: sourceName:
type: string type: string
example: Verkoopengine example: Verkoopengine
@ -1577,9 +1546,11 @@ components:
example: debit example: debit
productCode: productCode:
type: string type: string
nullable: true
example: HTM-MND-20 example: HTM-MND-20
required: required:
- sourceName - sourceName
- transactionType
- transactionId - transactionId
- name - name
- quantity - quantity
@ -1591,19 +1562,121 @@ components:
- type - type
- productCode - productCode
TransactionItemsBulkPostResponseBody: TransactionItemsBulkPostResponseBody:
type: object
properties:
summary:
type: object
properties:
created:
type: integer
example: 15
updated:
type: integer
example: 2
total:
type: integer
example: 17
required:
- created
- updated
- total
required:
- summary
TransactionItemsBulkBadRequestResponseBody:
type: object
properties:
type:
type: string
format: url
example: https://htm.nl/api/v1/probs/fiko/validationerror
title:
type: string
example: Transaction validation failed.
detail:
type: string
example: One ore more transactions in the request are invalid.
instance:
type: string
example: urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b
errors:
type: array type: array
items: items:
type: object type: object
properties: properties:
transactionItemId: detail:
type: string type: string
format: uuid example: Transaction is a duplicate of a transaction already in the system.
example: afce35b2-1dff-4ace-98d0-4b9ac405c87d pointer:
type: string
example: "#/transactionItems/0"
transactionId:
type: string
example: 1ad109d3-fd7d-4b6f-872b-220d492f385f
transactionLineId:
type: string
example: fee907dd-e59d-44f5-a63b-bbdec38f79b7
required: required:
- transactionItemId - detail
- pointer
- transactionId
required:
- type
- title
- detail
- instance
TransactionItemsPatchRequestBody: TransactionItemsPatchRequestBody:
type: object type: object
properties: properties:
name:
type: string
nullable: true
example: HTM Maandkorting 20%
quantity:
type: integer
nullable: true
example: 1
taxCode:
type: string
nullable: true
example: V21
amountExclTax:
type: integer
nullable: true
example: 100
amountInclTax:
type: integer
nullable: true
example: 121
amountTax:
type: integer
nullable: true
example: 21
occurredOn:
type: string
nullable: true
format: date-time
example: 2024-10-04T00:00:00Z
type:
type: string
nullable: true
enum:
- debit
- credit
example: debit
productCode:
type: string
nullable: true
example: HTM-MND-20
status:
type: string
enum:
- created
- succeeded
- failed
- returned to trx-db
- returned to src
- re-entered
example: created
aggregationReference: aggregationReference:
type: string type: string
nullable: true nullable: true
@ -1624,57 +1697,36 @@ components:
ProcessingFailuresPostRequestBody: ProcessingFailuresPostRequestBody:
type: object type: object
properties: properties:
department: timestamp:
type: string type: string
nullable: true format: date-time
example: 900 example: 2022-01-01 00:00:00
costCenter: element:
type: string
example: costCenter
value:
type: string type: string
nullable: true
example: 84955 example: 84955
costType: reasonCode:
type: string
example: "002"
reasonDescription:
type: string
example: Contra account does not exist.
resolved:
type: boolean
example: false
change:
type: string type: string
nullable: true nullable: true
example: 619031 example: Adapt config
documentDate:
type: string
format: date
nullable: true
example: 2022-01-01
documentCode:
type: string
nullable: true
example: VERK_FACTUUR
accountingPeriod:
type: string
nullable: true
example: 2024/10
transactionDescription:
type: string
nullable: true
example: Dagkaart
contraAccountNumber:
type: string
nullable: true
example: 220.10419
status:
type: string
enum:
- open
- returned to trx-db
- returned to src
example: open
occurence:
type: integer
example: 1
processingFailureInstances:
type: array
items:
$ref: "#/components/schemas/ProcessingFailureInstancesPostRequestBody"
required: required:
- status - timestamp
- occurence - element
- processingFailureInstances - value
- reasonCode
- reasonDescription
- resolved
ProcessingFailuresPostResponseBody: ProcessingFailuresPostResponseBody:
type: object type: object
properties: properties:
@ -1700,86 +1752,38 @@ components:
type: string type: string
format: uuid format: uuid
example: 2d77d978-7141-499a-84ad-93fad8ee03ce example: 2d77d978-7141-499a-84ad-93fad8ee03ce
department:
type: string
nullable: true
example: 900
costCenter:
type: string
nullable: true
example: 84955
costType:
type: string
nullable: true
example: 619031
documentDate:
type: string
format: date
nullable: true
example: 2022-01-01
documentCode:
type: string
nullable: true
example: VERK_FACTUUR
accountingPeriod:
type: string
nullable: true
example: 2024/10
transactionDescription:
type: string
nullable: true
example: Dagkaart
contraAccountNumber:
type: string
nullable: true
example: 220.10419
status:
type: string
enum:
- open
- returned to trx-db
- returned to src
example: open
occurence:
type: integer
example: 1
processingFailureInstances:
type: array
items:
type: object
properties:
processingFailureInstanceId:
type: string
format: uuid
example: 9afa9a6b-5b6a-4b0a-9c9e-4b0a5b6a4b0a
timestamp: timestamp:
type: string type: string
format: date-time format: date-time
example: 2022-01-01 00:00:00 example: 2022-01-01 00:00:00
failureReason:
$ref: "#/components/schemas/FailureReason"
element: element:
type: string type: string
example: costCenter example: costCenter
occurence: value:
type: integer type: string
example: 1 example: 84955
reasonCode:
type: string
example: "002"
reasonDescription:
type: string
example: Contra account does not exist.
resolved:
type: boolean
example: false
change: change:
type: string type: string
nullable: true nullable: true
example: Adapt config example: Adapt config
required:
- processingFailureInstanceId
- timestamp
- failureReason
- element
- occurence
required: required:
- processingFailureId - processingFailureId
- transactionItemId - transactionItemId
- status - timestamp
- occurence - element
- processingFailureInstances - value
- reasonCode
- reasonDescription
- resolved
href: href:
type: string type: string
nullable: true nullable: true
@ -1788,18 +1792,14 @@ components:
ProcessingFailuresPatchRequestBody: ProcessingFailuresPatchRequestBody:
type: object type: object
properties: properties:
status: resolved:
type: boolean
nullable: true
example: true
change:
type: string type: string
enum:
- open
- returned to trx-db
- returned to src
nullable: true nullable: true
example: returned to trx-db example: Adapt config
occurence:
type: integer
nullable: true
example: 2
ProcessingFailuresPatchResponseBody: ProcessingFailuresPatchResponseBody:
type: object type: object
properties: properties:
@ -1809,65 +1809,6 @@ components:
example: 37a8095b-19db-498f-9349-5f37d21c5bdf example: 37a8095b-19db-498f-9349-5f37d21c5bdf
required: required:
- processingFailureId - processingFailureId
ProcessingFailureInstancesPostRequestBody:
type: object
properties:
timestamp:
type: string
format: date-time
example: 2022-01-01 00:00:00
failureReasonId:
type: integer
example: 1
element:
type: string
example: costCenter
occurence:
type: integer
example: 1
change:
type: string
nullable: true
example: Adapt config
required:
- timestamp
- failureReason
- element
- occurence
ProcessingFailureInstancesPostResponseBody:
type: object
properties:
processingFailureInstanceId:
type: string
format: uuid
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
required:
- processingFailureInstanceId
ProcessingFailureInstancesPatchRequestBody:
type: object
properties:
timestamp:
type: string
format: date-time
nullable: true
example: 2022-01-01 00:00:00
occurence:
type: integer
nullable: true
example: 1
change:
type: string
nullable: true
example: Adapt config
ProcessingFailureInstancesPatchResponseBody:
type: object
properties:
processingFailureInstanceId:
type: string
format: uuid
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
required:
- processingFailureInstanceId
TransactionAuditTrailsPostRequestBody: TransactionAuditTrailsPostRequestBody:
type: object type: object
properties: properties:
@ -1879,6 +1820,12 @@ components:
format: date-time format: date-time
example: 2022-01-01 00:00:00 example: 2022-01-01 00:00:00
action: action:
type: string
enum:
- create
- update
example: create
status:
type: string type: string
enum: enum:
- created - created
@ -1886,6 +1833,7 @@ components:
- failed - failed
- returned to trx-db - returned to trx-db
- returned to src - returned to src
- re-entered
example: created example: created
description: description:
type: string type: string
@ -1900,6 +1848,7 @@ components:
- user - user
- timestamp - timestamp
- action - action
- status
TransactionAuditTrailsPostResponseBody: TransactionAuditTrailsPostResponseBody:
type: object type: object
properties: properties:
@ -1933,6 +1882,12 @@ components:
format: date-time format: date-time
example: 2022-01-01 00:00:00 example: 2022-01-01 00:00:00
action: action:
type: string
enum:
- create
- update
example: create
status:
type: string type: string
enum: enum:
- created - created
@ -1940,6 +1895,7 @@ components:
- failed - failed
- returned to trx-db - returned to trx-db
- returned to src - returned to src
- re-entered
example: created example: created
description: description:
type: string type: string
@ -1956,6 +1912,7 @@ components:
- user - user
- timestamp - timestamp
- action - action
- status
href: href:
type: string type: string
nullable: true nullable: true
@ -2824,18 +2781,6 @@ components:
nullable: true nullable: true
description: URI for pagination. description: URI for pagination.
example: null example: null
FailureReasonsGetResponseBody:
type: object
properties:
failureReasons:
type: array
items:
$ref: '#/components/schemas/FailureReason'
href:
type: string
nullable: true
description: URI for pagination.
example: null
ContraAccountMetadata: ContraAccountMetadata:
type: object type: object
properties: properties:
@ -2917,22 +2862,6 @@ components:
- rejectionProcessing - rejectionProcessing
- rejectionInfo - rejectionInfo
- validFrom - validFrom
FailureReason:
type: object
properties:
failureReasonId:
type: integer
example: 2
reasonCode:
type: string
example: "002"
reasonDesc:
type: string
example: Contra account does not exist
required:
- failureReasonId
- reasonCode
- reasonDesc
rfc9457: rfc9457:
type: object type: object
properties: properties:

1676
src/openapi/products/SE-products.yaml Normal file
View File

File diff suppressed because it is too large Load Diff