diff --git a/src/openapi/contracts/contracts-crud.yaml b/src/openapi/contracts/contracts-crud.yaml index 0c3e90e..963bf1e 100644 --- a/src/openapi/contracts/contracts-crud.yaml +++ b/src/openapi/contracts/contracts-crud.yaml @@ -624,6 +624,14 @@ paths: tags: - ContractInvoice parameters: + - in: query + name: contractInvoiceId + schema: + type: string + format: uuid + example: 8699d72a-cf4d-4e6b-9e9c-549d837ca51f + required: false + description: Id of the contract invoice to fetch. - in: query name: contractId schema: diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 8bf9703..9e956d0 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -10,7 +10,7 @@ servers: paths: /transactionitems: get: - summary: Find transaction items. + summary: P1. Find transaction items. description: Find transaction items. tags: - Transactions v2.2 @@ -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 @@ -266,7 +284,7 @@ paths: accountingSystemReference: U4F-123456 href: null post: - summary: Add one ore more finanicial transaction items in bulk. + summary: P1. Add one ore more finanicial transaction items in bulk. description: Add one ore more finanicial transaction items in bulk. tags: - Transactions v2.2 @@ -357,7 +375,7 @@ paths: required: true description: The id of the transaction item. patch: - summary: Update a transaction item. + summary: P1. Update a transaction item. description: Update a transaction item. tags: - Transactions v2.2 @@ -401,12 +419,19 @@ paths: description: The transaction item was successfully updated in the database. value: transactionItemId: 7c3a5b0f-b89e-4f02-8b09-d11c5a050a07 - /transactionitems/responsestatus/*: + /transactionitems/responsestatus/{clientTrackingId}: get: tags: - Transactions v2.2 - summary: Get the status of the transaction items POST. + summary: P1. Get the status of the transaction items POST. description: Get the status of the asynchronous transaction items POST processing. + parameters: + - in: path + name: clientTrackingId + schema: + type: string + required: true + description: The clientTrackingId of the transaction items POST. responses: "200": description: OK @@ -459,7 +484,7 @@ paths: required: true description: The id of the transaction item to process. post: - summary: Add a processing failure. + summary: P1. Add a processing failure. description: Add a processing failure. tags: - Failures v2.2 @@ -507,7 +532,7 @@ paths: required: true description: The id of the transaction item to process. post: - summary: Add an audit trail entry. + summary: P1. Add an audit trail entry. description: Add an audit trail entry. tags: - Audit Trail v2.2 @@ -532,7 +557,7 @@ paths: summary: Add new transaction audit trail for updated transaction item description: Add a new audit trail record for an updated transaction item. value: - user: r.meeuws + user: ad.vogelaar timestamp: 2022-01-02 12:34:00 action: update status: return to src @@ -555,7 +580,7 @@ paths: transactionAuditTrailId: 37a8095b-19db-498f-9349-5f37d21c5bdf /transactionaudittrails: get: - summary: Find audit trail entries. + summary: P3. Find audit trail entries. description: Find audit trail entries. tags: - Audit Trail v2.2 @@ -630,6 +655,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 @@ -667,7 +710,7 @@ paths: correlationId: null - transactionAuditTrailId: f4798a84-489d-4533-9dfe-42423c70f6b6 transactionItemId: e8891be1-1b8a-4a0f-91e2-6b523b6497dd - user: r.meeuws + user: ad.vogelaar timestamp: 2025-01-01 12:34:48 action: update status: return to src @@ -697,7 +740,7 @@ paths: correlationId: null - transactionAuditTrailId: b2192e6c-ab79-4000-a04d-d8f4d574a82f transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 - user: r.meeuws + user: ad.vogelaar timestamp: 2025-01-04 12:34:54 action: update status: return to src @@ -760,7 +803,7 @@ paths: href: null /processingfailures: get: - summary: Find processing failures. + summary: P1.Find processing failures. description: Find processing failures. tags: - Failures v2.2 @@ -827,6 +870,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 @@ -924,7 +985,7 @@ paths: required: true description: The id of the processing failure. patch: - summary: Update processing failure. + summary: P1. Update processing failure. description: Update processing failure. tags: - Failures v2.2 @@ -957,7 +1018,7 @@ paths: processingFailureId: 37a8095b-19db-498f-9349-5f37d21c5bdf /bookingprocesses: get: - summary: Find booking processes. + summary: P1. Find booking processes. description: Find booking processes. tags: - Booking Processes v2.2 @@ -990,6 +1051,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 @@ -1013,7 +1092,7 @@ paths: identifyingFieldName: null href: null post: - summary: Add a booking process. + summary: P2. Add a booking process. description: Add a booking process. tags: - Booking Processes v2.2 @@ -1056,7 +1135,7 @@ paths: required: true description: The id of the booking process. patch: - summary: Update a booking process. + summary: P2. Update a booking process. description: Update a booking process. tags: - Booking Processes v2.2 @@ -1097,7 +1176,7 @@ paths: required: true description: The id of the booking process. post: - summary: Add booking metadata. + summary: P2. Add booking metadata. description: Add booking metadata. tags: - Booking Processes v2.2 @@ -1138,7 +1217,7 @@ paths: bookingMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 /bookingmetadata: get: - summary: Find booking metadata. + summary: P1. Find booking metadata. description: Find booking metadata. tags: - Booking Processes v2.2 @@ -1211,6 +1290,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 @@ -1260,7 +1357,7 @@ paths: required: true description: The id of the booking metadata. patch: - summary: Update booking metadata. + summary: P2. Update booking metadata. description: Update booking metadata. tags: - Booking Processes v2.2 @@ -1301,7 +1398,7 @@ paths: required: true description: The id of the booking metadata. post: - summary: Add booking group fields. + summary: P2. Add booking group fields. description: Add booking group fields. tags: - Booking Processes v2.2 @@ -1341,7 +1438,7 @@ paths: required: true description: The id of the booking metadata. post: - summary: Add booking line metadata. + summary: P2. Add booking line metadata. description: Add booking line metadata. tags: - Booking Processes v2.2 @@ -1403,7 +1500,7 @@ paths: bookingLineMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 /bookinggroupfields: get: - summary: Find booking group fields. + summary: P1. Find booking group fields. description: Find booking group fields. tags: - Booking Processes v2.2 @@ -1428,6 +1525,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 @@ -1503,7 +1618,7 @@ paths: required: true description: The id of the booking group field. delete: - summary: Delete booking group field. + summary: P2. Delete booking group field. description: Delete booking group field. tags: - Booking Processes v2.2 @@ -1512,7 +1627,7 @@ paths: description: OK /bookinglinemetadata: get: - summary: Find booking line metadata. + summary: P1. Find booking line metadata. description: Find booking line metadata. tags: - Booking Processes v2.2 @@ -1624,6 +1739,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 @@ -1645,7 +1778,7 @@ paths: incomingName: HTM-website incomingEntity: OrderLine outgoingName: Webshop - businessOwner: Corneel Verstoep + businessOwner: Koos Verweg rejectionProcessing: system rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc identifyingFieldValue: null @@ -1670,7 +1803,7 @@ paths: incomingName: Translink incomingEntity: Trip outgoingName: TLS - businessOwner: Corneel Verstoep + businessOwner: Koos Verweg rejectionProcessing: mail rejectionInfo: helpdesk@translink.nl identifyingFieldValue: null @@ -1704,7 +1837,7 @@ paths: incomingName: HTM-website incomingEntity: OrderLine outgoingName: Webshop - businessOwner: Corneel Verstoep + businessOwner: Koos Verweg rejectionProcessing: system rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc identifyingFieldValue: null @@ -1729,7 +1862,7 @@ paths: incomingName: HTM-website incomingEntity: OrderLine outgoingName: Webshop - businessOwner: Corneel Verstoep + businessOwner: Koos Verweg rejectionProcessing: system rejectionInfo: api.htm.nl/v2/account/12345/msgs/abc identifyingFieldValue: null @@ -1754,9 +1887,9 @@ paths: incomingName: HTM-app incomingEntity: OrderLine outgoingName: ticketapp - businessOwner: Daan Zeven + businessOwner: Danny Negen rejectionProcessing: mail - rejectionInfo: sven@infoplaza.nl + rejectionInfo: d.negen@htm.nl identifyingFieldValue: null concession: concessionId: 2 @@ -1779,9 +1912,9 @@ paths: incomingName: HTM-app incomingEntity: OrderLine outgoingName: ticketapp - businessOwner: Daan Zeven + businessOwner: Danny Negen rejectionProcessing: mail - rejectionInfo: sven@infoplaza.nl + rejectionInfo: d.negen@htm.nl identifyingFieldValue: null concession: concessionId: 1 @@ -1824,7 +1957,7 @@ paths: required: true description: The id of the booking line metadata. patch: - summary: Update booking line metadata. + summary: P2. Update booking line metadata. description: Update booking line metadata. tags: - Booking Processes v2.2 @@ -1855,7 +1988,7 @@ paths: value: bookingLineMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 delete: - summary: Delete booking line metadata. + summary: P2. Delete booking line metadata. description: Delete booking line metadata. tags: - Booking Processes v2.2 @@ -1864,7 +1997,7 @@ paths: description: OK /taxmetadata: get: - summary: Find tax metadata. + summary: P1. Find tax metadata. description: Find tax metadata. tags: - Metadata v2.2 @@ -1885,7 +2018,7 @@ paths: - in: query name: taxPercentageAmount schema: - type: string + type: number example: 21 description: The tax percentage amount. - in: query @@ -1901,6 +2034,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 @@ -1952,7 +2103,7 @@ paths: validUntil: null href: null post: - summary: Add tax metadata. + summary: P3. Add tax metadata. description: Add tax metadata. tags: - Metadata v2.2 @@ -1996,7 +2147,7 @@ paths: required: true description: The id of the tax metadata. patch: - summary: Update tax metadata. + summary: P3. Update tax metadata. description: Update tax metadata. tags: - Metadata v2.2 @@ -2027,7 +2178,7 @@ paths: taxMetadataId: 7c3a5b0f-b89e-4f02-8b09-d11c5a050a07 /sourcemetadata: get: - summary: Find source metadata. + summary: P1. Find source metadata. description: Find source metadata. tags: - Metadata v2.2 @@ -2061,7 +2212,7 @@ paths: name: businessOwner schema: type: string - example: Corneel Verstoep + example: Koos Verweg description: The business owner of the source. - in: query name: rejectionProcessing @@ -2078,6 +2229,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 @@ -2095,26 +2264,26 @@ paths: incomingName: HTM-web incomingEntity: OrderLine outgoingName: webshop - businessOwner: Corneel Verstoep + businessOwner: Koos Verweg 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 + businessOwner: Danny Negen rejectionProcessing: mail - rejectionInfo: sven@infoplaza.nl + rejectionInfo: d.negen@htm.nl - sourceMetadataId: 0b6e3e07-c4e0-42bf-86f2-9c9522b71209 incomingName: SMP incomingEntity: OrderLine outgoingName: balieverkoop - businessOwner: Gijs Sip + businessOwner: Guus Geluk rejectionProcessing: mail rejectionInfo: ao@htm.nl href: null post: - summary: Add source metadata. + summary: P3. Add source metadata. description: Add source metadata. tags: - Metadata v2.2 @@ -2132,9 +2301,9 @@ paths: incomingName: HTM-app incomingEntity: OrderLine outgoingName: ticketapp - businessOwner: Daan Zeven + businessOwner: Danny Negen rejectionProcessing: mail - rejectionInfo: sven@infoplaza.nl + rejectionInfo: d.negen@htm.nl responses: "201": description: Created @@ -2159,7 +2328,7 @@ paths: required: true description: The id of the source metadata. patch: - summary: Update source metadata. + summary: P3. Update source metadata. description: Update source metadata. tags: - Metadata v2.2 @@ -2174,7 +2343,7 @@ paths: summary: Update a source in the metadata description: In this example we update the business owner of a single source meta data value: - businessOwner: Eric Kok + businessOwner: Chef Erwin responses: "200": description: OK @@ -2190,7 +2359,7 @@ paths: sourceMetadataId: 37a8095b-19db-498f-9349-5f37d21c5bdf /accountingperiodmetadata: get: - summary: Find accounting period metadata. + summary: P1. Find accounting period metadata. description: Find accounting period metadata. tags: - Metadata v2.2 @@ -2214,6 +2383,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 @@ -2238,7 +2425,7 @@ paths: isOpen: false href: null post: - summary: Add accounting period metadata. + summary: P2. Add accounting period metadata. description: Add accounting period metadata. tags: - Metadata v2.2 @@ -2279,7 +2466,7 @@ paths: required: true description: The id of the accounting period metadata. patch: - summary: Update accounting period metadata. + summary: P2. Update accounting period metadata. description: Update accounting period metadata. tags: - Metadata v2.2 @@ -2310,7 +2497,7 @@ paths: accountingPeriodMetadataId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 /concessionmetadata: get: - summary: Find concession metadata. + summary: P1. Find concession metadata. description: Find concession metadata. tags: - Metadata v2.2 @@ -2343,6 +2530,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 @@ -2400,7 +2605,7 @@ paths: validUntil: 2024-11-30T23:59:59.999 href: null post: - summary: Add concession metadata. + summary: P2. Add concession metadata. description: Add concession metadata. tags: - Metadata v2.2 @@ -2445,7 +2650,7 @@ paths: required: true description: The id of the concession metadata. patch: - summary: Update concession metadata. + summary: P2. Update concession metadata. description: Update concession metadata. tags: - Metadata v2.2 @@ -2542,7 +2747,7 @@ paths: name: user schema: type: string - example: r.meeuws + example: ad.vogelaar description: The id of the user who performed the metadata change. - in: query name: timestampBefore @@ -2592,7 +2797,7 @@ paths: $ref: "#/components/schemas/MetadataAuditTrailsPostResponseBody" /concessions: get: - summary: Get all concessions. + summary: P1. Get all concessions. description: Get all concessions. tags: - References v2.2 @@ -3737,7 +3942,7 @@ components: example: { "json": "data" } user: type: string - example: r.meeuws + example: ad.vogelaar timestamp: type: string format: date-time @@ -3794,7 +3999,7 @@ components: example: { "json": "data" } user: type: string - example: r.meeuws + example: ad.vogelaar timestamp: type: string format: date-time @@ -3838,7 +4043,7 @@ components: type: string example: V21 taxPercentageAmount: - type: integer + type: number example: 21 description: type: string @@ -3954,7 +4159,7 @@ components: example: Website Verkopen businessOwner: type: string - example: Corneel Verstoep + example: Koos Verweg rejectionProcessing: type: string example: system @@ -3962,7 +4167,6 @@ components: type: string example: api.htm.nl/v2/account/12345/msgs/abc required: - - sourceMetadataId - incomingName - incomingEntity - outgoingName @@ -3992,7 +4196,7 @@ components: example: Website Verkopen businessOwner: type: string - example: Corneel Verstoep + example: Koos Verweg rejectionProcessing: type: string example: system @@ -4211,7 +4415,7 @@ components: example: Website Verkopen businessOwner: type: string - example: Corneel Verstoep + example: Koos Verweg rejectionProcessing: type: string example: system diff --git a/src/openapi/products/purchased_products-crud.yaml b/src/openapi/products/purchased_products-crud.yaml index 1a77eda..2305f96 100644 --- a/src/openapi/products/purchased_products-crud.yaml +++ b/src/openapi/products/purchased_products-crud.yaml @@ -52,6 +52,13 @@ paths: example: 2024-10-04T12:34:56.000 required: false description: The purchased product should be last updated after this timestamp. + - in: query + name: resourceNameId + schema: + type: integer + example: 2 + required: false + description: The id of the resource. - in: query name: resourceName schema: