OVPAY-1518 - Added examples for GET Metadata v2.
This commit is contained in:
parent
8e77c34615
commit
71ab5176b5
@ -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:
|
||||||
@ -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
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user