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

OVPAY-1518 - Update ProcessingFailures.

Browse Source
This commit is contained in:
Bas Boterman 2025-02-06 12:11:14 +01:00
parent 0d61d06198
commit 7a5a6685b5
1 changed files with 103 additions and 339 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

442
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.
@ -180,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:
@ -370,75 +371,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
@ -473,60 +452,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.
@ -1373,19 +1298,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:
@ -1451,6 +1363,7 @@ components:
example: debit example: debit
productCode: productCode:
type: string type: string
nullable: true
example: HTM-MND-20 example: HTM-MND-20
status: status:
type: string type: string
@ -1537,6 +1450,7 @@ components:
example: debit example: debit
productCode: productCode:
type: string type: string
nullable: true
example: HTM-MND-20 example: HTM-MND-20
status: status:
type: string type: string
@ -1623,6 +1537,7 @@ 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
@ -1705,34 +1620,43 @@ components:
properties: properties:
name: name:
type: string type: string
nullable: true
example: HTM Maandkorting 20% example: HTM Maandkorting 20%
quantity: quantity:
type: integer type: integer
nullable: true
example: 1 example: 1
taxCode: taxCode:
type: string type: string
nullable: true
example: V21 example: V21
amountExclTax: amountExclTax:
type: integer type: integer
nullable: true
example: 100 example: 100
amountInclTax: amountInclTax:
type: integer type: integer
nullable: true
example: 121 example: 121
amountTax: amountTax:
type: integer type: integer
nullable: true
example: 21 example: 21
occurredOn: occurredOn:
type: string type: string
nullable: true
format: date-time format: date-time
example: 2024-10-04T00:00:00Z example: 2024-10-04T00:00:00Z
type: type:
type: string type: string
nullable: true
enum: enum:
- debit - debit
- credit - credit
example: debit example: debit
productCode: productCode:
type: string type: string
nullable: true
example: HTM-MND-20 example: HTM-MND-20
status: status:
type: string type: string
@ -1764,57 +1688,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:
@ -1840,86 +1743,38 @@ components:
type: string type: string
format: uuid format: uuid
example: 2d77d978-7141-499a-84ad-93fad8ee03ce example: 2d77d978-7141-499a-84ad-93fad8ee03ce
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:
type: object
properties:
processingFailureInstanceId:
type: string
format: uuid
example: 9afa9a6b-5b6a-4b0a-9c9e-4b0a5b6a4b0a
timestamp:
type: string
format: date-time
example: 2022-01-01 00:00:00
failureReason:
$ref: "#/components/schemas/FailureReason"
element:
type: string
example: costCenter
occurence:
type: integer
example: 1
change:
type: string
nullable: true
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
@ -1928,18 +1783,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:
@ -1949,65 +1800,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:
@ -2964,18 +2756,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:
@ -3057,22 +2837,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: