OVPAY-879 - Added schemas for Transactions v2.
This commit is contained in:
parent
233c7114b9
commit
8111b631f3
@ -130,48 +130,7 @@ paths:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/unavailable"
|
$ref: "#/components/schemas/TransactionItemsGetResponseBody"
|
||||||
example:
|
|
||||||
{
|
|
||||||
"transactionItems":
|
|
||||||
[
|
|
||||||
{
|
|
||||||
"transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
|
|
||||||
"sourceName": "Verkoopengine",
|
|
||||||
"transactionId": "1001236",
|
|
||||||
"transactionLineId": "1",
|
|
||||||
"name": "HTM Maandkorting 20%",
|
|
||||||
"quantity": 1,
|
|
||||||
"taxCode": "V21",
|
|
||||||
"amountExclTax": 100,
|
|
||||||
"amountInclTax": 121,
|
|
||||||
"amountTax": 21,
|
|
||||||
"occurredOn": "2024-10-04T00:00:00Z",
|
|
||||||
"type": "debit",
|
|
||||||
"productCode": "HTM-MND-20",
|
|
||||||
"aggregationReference": "FIKO-123456",
|
|
||||||
"accountingSystemReference": "U4F-123456",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"transactionItemId": "e63cc37b-4d87-4278-8eb5-1477e07edf3d",
|
|
||||||
"sourceName": "Verkoopengine",
|
|
||||||
"transactionId": "1001237",
|
|
||||||
"transactionLineId": "1",
|
|
||||||
"name": "HTM Maandkorting 20%",
|
|
||||||
"quantity": 1,
|
|
||||||
"taxCode": "V21",
|
|
||||||
"amountExclTax": 100,
|
|
||||||
"amountInclTax": 121,
|
|
||||||
"amountTax": 21,
|
|
||||||
"occurredOn": "2024-10-04T00:05:00Z",
|
|
||||||
"type": "debit",
|
|
||||||
"productCode": "HTM-MND-20",
|
|
||||||
"aggregationReference": "FIKO-123456",
|
|
||||||
"accountingSystemReference": "U4F-123456",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
"href": null,
|
|
||||||
}
|
|
||||||
post:
|
post:
|
||||||
summary: Add a finanicial transaction item.
|
summary: Add a finanicial transaction item.
|
||||||
description: Add a finanicial transaction item.
|
description: Add a finanicial transaction item.
|
||||||
@ -182,33 +141,14 @@ paths:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/unavailable"
|
$ref: "#/components/schemas/TransactionItemsPostRequestBody"
|
||||||
example:
|
|
||||||
{
|
|
||||||
"sourceName": "Verkoopengine",
|
|
||||||
"transactionId": "1001236",
|
|
||||||
"transactionLineId": "1",
|
|
||||||
"name": "HTM Maandkorting 20%",
|
|
||||||
"quantity": 1,
|
|
||||||
"taxCode": "V21",
|
|
||||||
"amountExclTax": 100,
|
|
||||||
"amountInclTax": 121,
|
|
||||||
"amountTax": 21,
|
|
||||||
"occurredOn": "2024-10-04T00:00:00Z",
|
|
||||||
"type": "debit",
|
|
||||||
"productCode": "HTM-MND-20",
|
|
||||||
"aggregationReference": null,
|
|
||||||
"accountingSystemReference": null,
|
|
||||||
}
|
|
||||||
responses:
|
responses:
|
||||||
"201":
|
"201":
|
||||||
description: Created
|
description: Created
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/unavailable"
|
$ref: "#/components/schemas/TransactionItemsPostResponseBody"
|
||||||
example:
|
|
||||||
{ "transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d" }
|
|
||||||
/transactionitems/bulk:
|
/transactionitems/bulk:
|
||||||
post:
|
post:
|
||||||
summary: Add one ore more finanicial transaction items in bulk.
|
summary: Add one ore more finanicial transaction items in bulk.
|
||||||
@ -220,58 +160,14 @@ paths:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/unavailable"
|
$ref: "#/components/schemas/TransactionItemsBulkPostRequestBody"
|
||||||
example:
|
|
||||||
[
|
|
||||||
{
|
|
||||||
"sourceName": "Verkoopengine",
|
|
||||||
"transactionId": "1001236",
|
|
||||||
"transactionLineId": "1",
|
|
||||||
"name": "HTM Maandkorting 20%",
|
|
||||||
"quantity": 1,
|
|
||||||
"taxCode": "V21",
|
|
||||||
"amountExclTax": 100,
|
|
||||||
"amountInclTax": 121,
|
|
||||||
"amountTax": 21,
|
|
||||||
"occurredOn": "2024-10-04T00:00:00Z",
|
|
||||||
"type": "debit",
|
|
||||||
"productCode": "HTM-MND-20",
|
|
||||||
"aggregationReference": null,
|
|
||||||
"accountingSystemReference": null,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"sourceName": "Verkoopengine",
|
|
||||||
"transactionId": "1001237",
|
|
||||||
"transactionLineId": "1",
|
|
||||||
"name": "HTM Maandkorting 20%",
|
|
||||||
"quantity": 1,
|
|
||||||
"taxCode": "V21",
|
|
||||||
"amountExclTax": 100,
|
|
||||||
"amountInclTax": 121,
|
|
||||||
"amountTax": 21,
|
|
||||||
"occurredOn": "2024-10-04T00:05:00Z",
|
|
||||||
"type": "debit",
|
|
||||||
"productCode": "HTM-MND-20",
|
|
||||||
"aggregationReference": null,
|
|
||||||
"accountingSystemReference": null,
|
|
||||||
},
|
|
||||||
]
|
|
||||||
responses:
|
responses:
|
||||||
"201":
|
"201":
|
||||||
description: Created
|
description: Created
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/unavailable"
|
$ref: "#/components/schemas/TransactionItemsBulkPostResponseBody"
|
||||||
example:
|
|
||||||
[
|
|
||||||
{
|
|
||||||
"transactionItemId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"transactionItemId": "e63cc37b-4d87-4278-8eb5-1477e07edf3d",
|
|
||||||
},
|
|
||||||
]
|
|
||||||
/transactionitems/{transactionItemId}:
|
/transactionitems/{transactionItemId}:
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
@ -292,21 +188,14 @@ paths:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/unavailable"
|
$ref: "#/components/schemas/TransactionItemsPatchRequestBody"
|
||||||
example:
|
|
||||||
{
|
|
||||||
"aggregationReference": "FIKO-123456",
|
|
||||||
"accountingSystemReference": "U4F-123456",
|
|
||||||
}
|
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: OK
|
description: OK
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/unavailable"
|
$ref: "#/components/schemas/TransactionItemsPatchResponseBody"
|
||||||
example:
|
|
||||||
{ "transactionItemId": "d667d293-aa82-4c9e-9b10-77cffc9058a1" }
|
|
||||||
/transactionitems/{transactionItemId}/processingfailures:
|
/transactionitems/{transactionItemId}/processingfailures:
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
@ -2172,6 +2061,238 @@ components:
|
|||||||
schemas:
|
schemas:
|
||||||
unavailable:
|
unavailable:
|
||||||
type: object
|
type: object
|
||||||
|
TransactionItemsGetResponseBody:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
transactionItems:
|
||||||
|
type: "array"
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
transactionItemId:
|
||||||
|
type: string
|
||||||
|
example: afce35b2-1dff-4ace-98d0-4b9ac405c87d
|
||||||
|
sourceName:
|
||||||
|
type: string
|
||||||
|
example: Verkoopengine
|
||||||
|
transactionId:
|
||||||
|
type: string
|
||||||
|
example: 1001236
|
||||||
|
transactionLineId:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
example: 1
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
example: HTM Maandkorting 20%
|
||||||
|
quantity:
|
||||||
|
type: integer
|
||||||
|
example: 1
|
||||||
|
taxCode:
|
||||||
|
type: string
|
||||||
|
example: V21
|
||||||
|
amountExclTax:
|
||||||
|
type: number
|
||||||
|
example: 100
|
||||||
|
amountInclTax:
|
||||||
|
type: number
|
||||||
|
example: 121
|
||||||
|
amountTax:
|
||||||
|
type: number
|
||||||
|
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
|
||||||
|
aggregationReference:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
example: FIKO-123456
|
||||||
|
accountingSystemReference:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
example: U4F-123456
|
||||||
|
required:
|
||||||
|
- transactionItemId
|
||||||
|
- sourceName
|
||||||
|
- transactionId
|
||||||
|
- name
|
||||||
|
- quantity
|
||||||
|
- taxCode
|
||||||
|
- amountExclTax
|
||||||
|
- amountInclTax
|
||||||
|
- amountTax
|
||||||
|
- occurredOn
|
||||||
|
- type
|
||||||
|
- productCode
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
description: URI for pagination.
|
||||||
|
example: null
|
||||||
|
TransactionItemsPostRequestBody:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
sourceName:
|
||||||
|
type: string
|
||||||
|
example: Verkoopengine
|
||||||
|
transactionId:
|
||||||
|
type: string
|
||||||
|
example: 1001236
|
||||||
|
transactionLineId:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
example: 1
|
||||||
|
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
|
||||||
|
required:
|
||||||
|
- sourceName
|
||||||
|
- transactionId
|
||||||
|
- name
|
||||||
|
- quantity
|
||||||
|
- taxCode
|
||||||
|
- amountExclTax
|
||||||
|
- amountInclTax
|
||||||
|
- amountTax
|
||||||
|
- occurredOn
|
||||||
|
- type
|
||||||
|
- productCode
|
||||||
|
TransactionItemsPostResponseBody:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
transactionItemId:
|
||||||
|
type: string
|
||||||
|
example: afce35b2-1dff-4ace-98d0-4b9ac405c87d
|
||||||
|
required:
|
||||||
|
- transactionItemId
|
||||||
|
TransactionItemsBulkPostRequestBody:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
transactionItems:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
sourceName:
|
||||||
|
type: string
|
||||||
|
example: Verkoopengine
|
||||||
|
transactionId:
|
||||||
|
type: string
|
||||||
|
example: 1001236
|
||||||
|
transactionLineId:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
example: 1
|
||||||
|
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
|
||||||
|
required:
|
||||||
|
- sourceName
|
||||||
|
- transactionId
|
||||||
|
- name
|
||||||
|
- quantity
|
||||||
|
- taxCode
|
||||||
|
- amountExclTax
|
||||||
|
- amountInclTax
|
||||||
|
- amountTax
|
||||||
|
- occurredOn
|
||||||
|
- type
|
||||||
|
- productCode
|
||||||
|
TransactionItemsBulkPostResponseBody:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
transactionItemId:
|
||||||
|
type: string
|
||||||
|
example: afce35b2-1dff-4ace-98d0-4b9ac405c87d
|
||||||
|
required:
|
||||||
|
- transactionItemId
|
||||||
|
TransactionItemsPatchRequestBody:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
aggregationReference:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
example: FIKO-123456
|
||||||
|
accountingSystemReference:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
example: U4F-123456
|
||||||
|
TransactionItemsPatchResponseBody:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
transactionItemId:
|
||||||
|
type: string
|
||||||
|
example: afce35b2-1dff-4ace-98d0-4b9ac405c87d
|
||||||
|
required:
|
||||||
|
- transactionItemId
|
||||||
rfc9457:
|
rfc9457:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user