OVPAY-1518 - Update TransactionItems data mode.

This commit is contained in:
Bas Boterman 2025-02-06 10:49:44 +01:00
parent 158cac33ed
commit 0d61d06198

View File

@ -45,12 +45,6 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/TransactionItemsBulkPostResponseBody" $ref: "#/components/schemas/TransactionItemsBulkPostResponseBody"
"400":
description: Bad request
content:
application/json:
schema:
$ref: "#/components/schemas/TransactionItemsBulkBadRequestResponseBody"
/transactionitems: /transactionitems:
get: get:
summary: Find transaction items. summary: Find transaction items.
@ -65,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:
@ -148,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:
@ -160,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
@ -1403,6 +1406,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
@ -1444,6 +1452,16 @@ components:
productCode: productCode:
type: string type: string
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
@ -1454,6 +1472,7 @@ components:
example: U4F-123456 example: U4F-123456
required: required:
- transactionItemId - transactionItemId
- transactionType
- sourceName - sourceName
- transactionId - transactionId
- name - name
@ -1464,7 +1483,7 @@ components:
- amountTax - amountTax
- occurredOn - occurredOn
- type - type
- productCode - status
href: href:
type: string type: string
nullable: true nullable: true
@ -1473,6 +1492,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
@ -1514,7 +1538,18 @@ components:
productCode: productCode:
type: string type: string
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
@ -1525,7 +1560,7 @@ components:
- amountTax - amountTax
- occurredOn - occurredOn
- type - type
- productCode - status
TransactionItemsPostResponseBody: TransactionItemsPostResponseBody:
type: object type: object
properties: properties:
@ -1543,6 +1578,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
@ -1586,6 +1626,7 @@ components:
example: HTM-MND-20 example: HTM-MND-20
required: required:
- sourceName - sourceName
- transactionType
- transactionId - transactionId
- name - name
- quantity - quantity
@ -1662,6 +1703,47 @@ components:
TransactionItemsPatchRequestBody: TransactionItemsPatchRequestBody:
type: object type: object
properties: properties:
name:
type: string
example: HTM Maandkorting 20%
quantity:
type: integer
example: 1
taxCode:
type: string
example: V21
amountExclTax:
type: integer
example: 100
amountInclTax:
type: integer
example: 121
amountTax:
type: integer
example: 21
occurredOn:
type: string
format: date-time
example: 2024-10-04T00:00:00Z
type:
type: string
enum:
- debit
- credit
example: debit
productCode:
type: string
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
@ -2617,7 +2699,7 @@ components:
sourceMetadata: sourceMetadata:
type: array type: array
items: items:
$ref: "#/components/schemas/SourceMetadata" $ref: '#/components/schemas/SourceMetadata'
href: href:
type: string type: string
nullable: true nullable: true
@ -2789,7 +2871,7 @@ components:
format: uuid format: uuid
example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb
concession: concession:
$ref: "#/components/schemas/Concession" $ref: '#/components/schemas/Concession'
percentage: percentage:
type: number type: number
example: 84.021 example: 84.021
@ -2876,7 +2958,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
@ -2888,7 +2970,7 @@ components:
failureReasons: failureReasons:
type: array type: array
items: items:
$ref: "#/components/schemas/FailureReason" $ref: '#/components/schemas/FailureReason'
href: href:
type: string type: string
nullable: true nullable: true