From 2350b40e9ba80ec4ed8deddfeeb1fb1789161e79 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Mon, 3 Mar 2025 16:20:40 +0100 Subject: [PATCH] OVPAY-1518 - Added sort, limit, offset query params to GET operations. --- src/openapi/fiko/fiko-crud.yaml | 198 ++++++++++++++++++++++++++++++++ 1 file changed, 198 insertions(+) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index b91da43..8e6d293 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -143,6 +143,24 @@ paths: type: string example: U4F-123456 description: The accounting system reference of the transaction. %00 is searching for NULL-values. + - in: query + name: sort + schema: + type: string + example: occurredOn + description: The field by which the transaction items in the result body are sorted. + - in: query + name: limit + schema: + type: integer + example: 15 + description: The limit of the transaction items in the result body. + - in: query + name: offset + schema: + type: integer + example: 15 + description: The offset of the transaction items in the result body. responses: "200": description: OK @@ -630,6 +648,24 @@ paths: type: string example: a3891560-3084-42cb-867c-f289e7cda47d description: The correlation id of the event. + - in: query + name: sort + schema: + type: string + example: timestamp + description: The field by which the transaction audit trails in the result body are sorted. + - in: query + name: limit + schema: + type: integer + example: 15 + description: The limit of the transaction audit trails in the result body. + - in: query + name: offset + schema: + type: integer + example: 15 + description: The offset of the transaction audit trails in the result body. responses: "200": description: OK @@ -827,6 +863,24 @@ paths: type: string example: Adapt config description: Description of what was changed to resolve the failure. + - in: query + name: sort + schema: + type: string + example: timestamp + description: The field by which the processing failures in the result body are sorted. + - in: query + name: limit + schema: + type: integer + example: 15 + description: The limit of the processing failures in the result body. + - in: query + name: offset + schema: + type: integer + example: 15 + description: The offset of the processing failures in the result body. responses: "200": description: OK @@ -990,6 +1044,24 @@ paths: type: string example: articleNumber description: The identifying field name of the booking process. + - in: query + name: sort + schema: + type: string + example: name + description: The field by which the booking processes in the result body are sorted. + - in: query + name: limit + schema: + type: integer + example: 15 + description: The limit of the booking processes in the result body. + - in: query + name: offset + schema: + type: integer + example: 15 + description: The offset of the booking processes in the result body. responses: "200": description: OK @@ -1211,6 +1283,24 @@ paths: type: string example: 2024-01-01T00:00:00.000 description: Timestamp that the booking metadata is valid. + - in: query + name: sort + schema: + type: string + example: validFrom + description: The field by which the booking metadata in the result body are sorted. + - in: query + name: limit + schema: + type: integer + example: 15 + description: The limit of the booking metadata in the result body. + - in: query + name: offset + schema: + type: integer + example: 15 + description: The offset of the booking metadata in the result body. responses: "200": description: OK @@ -1428,6 +1518,24 @@ paths: type: string example: 1737 description: The identifying field value. + - in: query + name: sort + schema: + type: string + example: bookingMetadataId + description: The field by which the booking group fields in the result body are sorted. + - in: query + name: limit + schema: + type: integer + example: 15 + description: The limit of the booking group fields in the result body. + - in: query + name: offset + schema: + type: integer + example: 15 + description: The offset of the booking group fields in the result body. responses: "200": description: OK @@ -1624,6 +1732,24 @@ paths: type: string example: extRef6 description: External reference 6. + - in: query + name: sort + schema: + type: string + example: lineType + description: The field by which the booking line metadata in the result body are sorted. + - in: query + name: limit + schema: + type: integer + example: 15 + description: The limit of the booking line metadata in the result body. + - in: query + name: offset + schema: + type: integer + example: 15 + description: The offset of the booking line metadata in the result body. responses: "200": description: OK @@ -1901,6 +2027,24 @@ paths: format: date-time example: 2024-03-22T09:00:00 description: Timestamp that the metadata is valid. + - in: query + name: sort + schema: + type: string + example: validFrom + description: The field by which the tax metadata in the result body are sorted. + - in: query + name: limit + schema: + type: integer + example: 15 + description: The limit of the tax metadata in the result body. + - in: query + name: offset + schema: + type: integer + example: 15 + description: The offset of the tax metadata in the result body. responses: "200": description: OK @@ -2078,6 +2222,24 @@ paths: type: string example: api.htm.nl/v2/account/12345/msgs/abc description: The rejection info of the source. + - in: query + name: sort + schema: + type: string + example: incomingName + description: The field by which the source metadata in the result body are sorted. + - in: query + name: limit + schema: + type: integer + example: 15 + description: The limit of the source metadata in the result body. + - in: query + name: offset + schema: + type: integer + example: 15 + description: The offset of the source metadata in the result body. responses: "200": description: OK @@ -2214,6 +2376,24 @@ paths: type: boolean example: true description: Whether the accounting period is open. + - in: query + name: sort + schema: + type: string + example: accountingPeriod + description: The field by which the accounting period metadata in the result body are sorted. + - in: query + name: limit + schema: + type: integer + example: 15 + description: The limit of the accounting period metadata in the result body. + - in: query + name: offset + schema: + type: integer + example: 15 + description: The offset of the accounting period metadata in the result body. responses: "200": description: OK @@ -2343,6 +2523,24 @@ paths: type: string example: 2024-01-01T00:00:00.000 description: Timestamp that the metadata is valid. + - in: query + name: sort + schema: + type: string + example: validFrom + description: The field by which the concession metadata in the result body are sorted. + - in: query + name: limit + schema: + type: integer + example: 15 + description: The limit of the concession metadata in the result body. + - in: query + name: offset + schema: + type: integer + example: 15 + description: The offset of the concession metadata in the result body. responses: "200": description: OK