diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index ae79167..d98d746 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -118,7 +118,15 @@ paths: type: array items: type: string - example: [created, succeeded, failed, returned to trx-db, returned to src, re-entered] + 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 @@ -296,7 +304,15 @@ paths: type: array items: type: string - example: [created, succeeded, failed, returned to trx-db, returned to src, re-entered] + example: + [ + created, + succeeded, + failed, + returned to trx-db, + returned to src, + re-entered, + ] explode: false description: The status of the transaction item. - in: query @@ -421,6 +437,497 @@ paths: application/json: schema: $ref: "#/components/schemas/ProcessingFailuresPatchResponseBody" + /bookingprocesses: + get: + summary: Find booking processes. + description: Find booking processes. + tags: + - Booking Processes v2 + parameters: + - in: query + name: bookingProcessId + schema: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + description: The id of the booking process. + - in: query + name: name + schema: + type: string + example: Verkooptransacties + description: The name of the booking process. + - in: query + name: transactionType + schema: + type: array + items: + type: string + example: [sales, purchase] + explode: false + description: The transaction type of the booking process. + - in: query + name: identifyingFieldName + schema: + type: string + example: articleNumber + description: The identifying field name of the booking process. + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/BookingProcessesGetResponseBody" + post: + summary: Add a booking process. + description: Add a booking process. + tags: + - Booking Processes v2 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/BookingProcessesPostRequestBody" + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: "#/components/schemas/BookingProcessesPostResponseBody" + /bookingprocesses/{bookingProcessId}: + parameters: + - in: path + name: bookingProcessId + schema: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + required: true + description: The id of the booking process. + patch: + summary: Update a booking process. + description: Update a booking process. + tags: + - Booking Processes v2 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/BookingProcessesPatchRequestBody" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/BookingProcessesPatchResponseBody" + /bookingprocesses/{bookingProcessId}/bookingmetadata: + parameters: + - in: path + name: bookingProcessId + schema: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + required: true + description: The id of the booking process. + post: + summary: Add booking metadata. + description: Add booking metadata. + tags: + - Booking Processes v2 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/BookingMetadataPostRequestBody" + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: "#/components/schemas/BookingMetadataPostResponseBody" + /bookingmetadata: + get: + summary: Find booking metadata. + description: Find booking metadata. + tags: + - Booking Processes v2 + parameters: + - in: query + name: bookingMetadataId + schema: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + description: The id of the booking metadata. + - in: query + name: bookingProcessId + schema: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + description: The id of the parent booking process. + - in: query + name: description + schema: + type: string + example: Dagkaart + description: The description of the booking. + - in: query + name: element1 + schema: + type: string + example: 900 + description: The first element of the booking. + - in: query + name: element2 + schema: + type: string + example: 84956 + description: The second element of the booking. + - in: query + name: documentCode + schema: + type: string + example: FIKO-OPBR + description: The document code of the booking. + - in: query + name: hasSeparateTaxLine + schema: + type: boolean + example: true + description: Whether the booking has a separate tax line. + - in: query + name: hasLinePerIdentifyingField + schema: + type: boolean + example: true + description: Whether the booking has a line per identifying field. + - in: query + name: hasLinePerSource + schema: + type: boolean + example: true + description: Whether the booking has a line per source. + - in: query + name: hasLinePerSource + schema: + type: boolean + example: true + description: Whether the booking has a line per source. + - in: query + name: hasLinePerConcession + schema: + type: boolean + example: true + description: Whether the booking has a line per concession. + - in: query + name: validAt + schema: + type: string + example: 2024-01-01T00:00:00.000 + description: Timestamp that the booking metadata is valid. + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/BookingMetadataGetResponseBody" + /bookingmetadata/{bookingMetadataId}: + parameters: + - in: path + name: bookingMetadataId + schema: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: true + description: The id of the booking metadata. + patch: + summary: Update booking metadata. + description: Update booking metadata. + tags: + - Booking Processes v2 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/BookingMetadataPatchRequestBody" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/BookingMetadataPatchResponseBody" + /bookingmetadata/{bookingMetadataId}/bookinggroupfields: + parameters: + - in: path + name: bookingMetadataId + schema: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: true + description: The id of the booking metadata. + post: + summary: Add booking group fields. + description: Add booking group fields. + tags: + - Booking Processes v2 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/BookingGroupFieldsPostRequestBody" + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: "#/components/schemas/BookingGroupFieldsPostResponseBody" + /bookingmetadata/{bookingMetadataId}/bookinglinemetadata: + parameters: + - in: path + name: bookingMetadataId + schema: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: true + description: The id of the booking metadata. + post: + summary: Add booking line metadata. + description: Add booking line metadata. + tags: + - Booking Processes v2 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/BookingLineMetadataPostRequestBody" + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: "#/components/schemas/BookingLineMetadataPostResponseBody" + /bookinggroupfields: + get: + summary: Find booking group fields. + description: Find booking group fields. + tags: + - Booking Processes v2 + parameters: + - in: query + name: bookingGroupFieldId + schema: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + description: The id of the booking group field. + - in: query + name: bookingMetadataId + schema: + type: string + format: uuid + example: 63d4a7e2-62c3-428b-a4bb-e4ee45516f2a + description: The id of the parent booking metadata. + - in: query + name: identifyingFieldValue + schema: + type: string + example: 1737 + description: The identifying field value. + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/BookingGroupFieldsGetResponseBody" + /bookinggroupfields/{bookingGroupFieldId}: + parameters: + - in: path + name: bookingGroupFieldId + schema: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: true + description: The id of the booking group field. + delete: + summary: Delete booking group field. + description: Delete booking group field. + tags: + - Booking Processes v2 + responses: + "200": + description: OK + /bookinglinemetadata: + get: + summary: Find booking line metadata. + description: Find booking line metadata. + tags: + - Booking Processes v2 + parameters: + - in: query + name: bookingLineMetadataId + schema: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + description: The id of the booking line metadata. + - in: query + name: bookingMetadataId + schema: + type: string + format: uuid + example: 63d4a7e2-62c3-428b-a4bb-e4ee45516f2a + description: The id of the parent booking metadata. + - in: query + name: name + schema: + type: string + example: Dakaart - BUS + description: The name of the booking line metadata. + - in: query + name: incomingName + schema: + type: string + example: Webshop + description: The incoming name of the booking line metadata. + - in: query + name: identifyingFieldValue + schema: + type: string + example: 1737 + description: The identifying field value. + - in: query + name: concessionName + schema: + type: array + items: + type: string + example: [BUS, RAIL] + explode: false + description: The name of the concession. + - in: query + name: lineType + schema: + type: array + items: + type: string + example: [summary, analysis, tax] + explode: false + description: The type of the line. + - in: query + name: lineSense + schema: + type: array + items: + type: string + example: [debit, credit] + explode: false + description: The sense of the line. + - in: query + name: element3 + schema: + type: string + example: 603031 + description: The element 3 of the booking line metadata. + - in: query + name: element4 + schema: + type: string + example: Dagkaart + description: The element 4 of the booking line metadata. + - in: query + name: extRef1 + schema: + type: string + example: extRef1 + - in: query + name: extRef2 + schema: + type: string + example: extRef2 + - in: query + name: extRef3 + schema: + type: string + example: extRef3 + - in: query + name: extRef4 + schema: + type: string + example: extRef4 + - in: query + name: extRef5 + schema: + type: string + example: extRef5 + - in: query + name: extRef6 + schema: + type: string + example: extRef6 + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/BookingLineMetadataGetResponseBody" + /bookinglinemetadata/{bookingLineMetadataId}: + parameters: + - in: path + name: bookingLineMetadataId + schema: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: true + description: The id of the booking line metadata. + patch: + summary: Update booking line metadata. + description: Update booking line metadata. + tags: + - Booking Processes v2 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/BookingLineMetadataPatchRequestBody" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/BookingLineMetadataPatchResponseBody" + delete: + summary: Delete booking line metadata. + description: Delete booking line metadata. + tags: + - Booking Processes v2 + responses: + "200": + description: OK /taxmetadata: get: summary: Find tax metadata. @@ -1127,7 +1634,7 @@ components: detail: type: string example: Transaction is a duplicate of a transaction already in the system. - pointer: + pointer: type: string example: "#/transactionItems/0" transactionId: @@ -1440,6 +1947,560 @@ components: example: null required: - transactionAuditTrails + BookingProcessesGetResponseBody: + type: object + properties: + bookingProcesses: + type: array + items: + type: object + properties: + bookingProcessId: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + name: + type: string + example: Verkooptransacties + transactionType: + type: string + enum: + - sales + example: sales + identifyingFieldName: + type: string + nullable: true + example: articleNumber + required: + - bookingProcessId + - name + - transactionType + href: + type: string + nullable: true + description: URI for pagination. + example: null + required: + - bookingProcesses + BookingProcessesPostRequestBody: + type: object + properties: + name: + type: string + example: Verkooptransacties + transactionType: + type: string + enum: + - sales + example: sales + identifyingFieldName: + type: string + nullable: true + example: articleNumber + required: + - name + - transactionType + BookingProcessesPostResponseBody: + type: object + properties: + bookingProcessId: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + required: + - bookingProcessId + BookingProcessesPatchRequestBody: + type: object + properties: + name: + type: string + nullable: true + example: Verkooptransacties + transactionType: + type: string + nullable: true + enum: + - sales + example: sales + identifyingFieldName: + type: string + nullable: true + example: articleNumber + BookingProcessesPatchResponseBody: + type: object + properties: + bookingProcessId: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + required: + - bookingProcessId + BookingMetadataGetResponseBody: + type: object + properties: + bookingMetadata: + type: array + items: + type: object + properties: + bookingMetadataId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + bookingProcessId: + type: string + format: uuid + example: 37a8095b-19db-498f-9349-5f37d21c5bdf + description: + type: string + example: Dagkaart + element1: + type: string + example: 900 + element2: + type: string + example: 84956 + documentCode: + type: string + example: FIKO-OPBR + hasSeparateTaxLine: + type: boolean + example: true + hasLinePerIdentifyingField: + type: boolean + example: true + hasLinePerSource: + type: boolean + example: true + hasLinePerConcession: + type: boolean + example: true + validFrom: + type: string + format: date-time + example: 2022-01-01 00:00:00 + validTo: + type: string + format: date-time + nullable: true + example: null + required: + - bookingMetadataId + - bookingProcessId + - description + - element1 + - element2 + - documentCode + - hasSeparateTaxLine + - hasLinePerIdentifyingField + - hasLinePerSource + - hasLinePerConcession + - validFrom + href: + type: string + nullable: true + example: null + required: + - bookingMetadata + BookingMetadataPostRequestBody: + type: object + properties: + description: + type: string + example: Dagkaart + element1: + type: string + example: 900 + element2: + type: string + example: 84956 + documentCode: + type: string + example: FIKO-OPBR + hasSeparateTaxLine: + type: boolean + example: true + hasLinePerIdentifyingField: + type: boolean + example: true + hasLinePerSource: + type: boolean + example: true + hasLinePerConcession: + type: boolean + example: true + validFrom: + type: string + format: date-time + example: 2022-01-01 00:00:00 + validTo: + type: string + format: date-time + nullable: true + example: null + required: + - description + - element1 + - element2 + - documentCode + - hasSeparateTaxLine + - hasLinePerIdentifyingField + - hasLinePerSource + - hasLinePerConcession + - validFrom + BookingMetadataPostResponseBody: + type: object + properties: + bookingMetadataId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: + - bookingMetadataId + BookingMetadataPatchRequestBody: + type: object + properties: + description: + type: string + nullable: true + example: Dagkaart + element1: + type: string + nullable: true + example: 900 + element2: + type: string + nullable: true + example: 84956 + documentCode: + type: string + nullable: true + example: FIKO-OPBR + hasSeparateTaxLine: + type: boolean + nullable: true + example: true + hasLinePerIdentifyingField: + type: boolean + nullable: true + example: true + hasLinePerSource: + type: boolean + nullable: true + example: true + hasLinePerConcession: + type: boolean + nullable: true + example: true + validFrom: + type: string + format: date-time + nullable: true + example: 2022-01-01 00:00:00 + validTo: + type: string + format: date-time + nullable: true + example: null + BookingMetadataPatchResponseBody: + type: object + properties: + bookingMetadataId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: + - bookingMetadataId + BookingGroupFieldsPostRequestBody: + type: object + properties: + identifyingFieldValue: + type: string + example: 1737 + required: + - identifyingFieldValue + BookingGroupFieldsPostResponseBody: + type: object + properties: + bookingGroupFieldId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: + - bookingGroupFieldId + BookingGroupFieldsGetResponseBody: + type: object + properties: + bookingGroupFields: + type: array + items: + type: object + properties: + bookingGroupFieldId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + bookingGroupMetadataId: + type: string + format: uuid + example: 12b4d128-0ab8-4a4a-944d-25b83de38b27 + identifyingFieldValue: + type: string + example: 1737 + required: + - bookingGroupFieldId + - bookingGroupMetadataId + - identifyingFieldValue + href: + type: string + nullable: true + example: null + required: + - bookingGroupFields + BookingLineMetadataPostRequestBody: + type: object + properties: + name: + type: string + example: Dagkaart - BUS + incomingName: + type: string + example: null + nullable: true + identifyingFieldValue: + type: string + example: null + nullable: true + concessionName: + type: string + example: RAIL + nullable: true + lineType: + type: string + enum: + - summary + - analysis + - tax + example: summary + lineSense: + type: string + enum: + - debit + - credit + example: credit + element3: + type: string + example: 603031 + nullable: true + element4: + type: string + example: dagkaart + nullable: true + extRef1: + type: string + example: null + nullable: true + extRef2: + type: string + example: null + nullable: true + extRef3: + type: string + example: 2025-02-17 + nullable: true + extRef4: + type: string + example: null + nullable: true + extRef5: + type: string + example: Webshop + nullable: true + extRef6: + type: string + example: null + nullable: true + required: + - name + - lineType + - lineSense + BookingLineMetadataPostResponseBody: + type: object + properties: + bookingLineMetadataId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: + - bookingLineMetadataId + BookingLineMetadataGetResponseBody: + type: object + properties: + bookingLineMetadata: + type: array + items: + type: object + properties: + bookingLineMetadataId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + bookingMetadataId: + type: string + format: uuid + example: 12b4d128-0ab8-4a4a-944d-25b83de38b27 + name: + type: string + example: Dagkaart - BUS + incomingName: + type: string + example: null + nullable: true + identifyingFieldValue: + type: string + example: null + nullable: true + concessionName: + type: string + enum: + - RAIL + - BUS + example: RAIL + lineType: + type: string + enum: + - summary + - analysis + - tax + example: summary + lineSense: + type: string + enum: + - debit + - credit + example: credit + element3: + type: string + example: 603031 + nullable: true + element4: + type: string + example: dagkaart + nullable: true + extRef1: + type: string + example: null + nullable: true + extRef2: + type: string + example: null + nullable: true + extRef3: + type: string + example: 2025-02-17 + nullable: true + extRef4: + type: string + example: null + nullable: true + extRef5: + type: string + example: Webshop + nullable: true + extRef6: + type: string + example: null + nullable: true + required: + - bookingLineMetadataId + - bookingMetadataId + - name + - lineType + - lineSense + href: + type: string + nullable: true + example: null + required: + - bookingLineMetadata + BookingLineMetadataPatchRequestBody: + type: object + properties: + name: + type: string + nullable: true + example: Dagkaart - BUS + incomingName: + type: string + nullable: true + example: null + identifyingFieldValue: + type: string + nullable: true + example: null + concessionName: + type: string + nullable: true + enum: + - RAIL + - BUS + example: RAIL + lineType: + type: string + nullable: true + enum: + - summary + - analysis + - tax + example: summary + lineSense: + type: string + nullable: true + enum: + - debit + - credit + example: credit + element3: + type: string + nullable: true + example: 603031 + element4: + type: string + nullable: true + example: dagkaart + extRef1: + type: string + nullable: true + example: null + extRef2: + type: string + nullable: true + example: null + extRef3: + type: string + nullable: true + example: 2025-02-17 + extRef4: + type: string + nullable: true + example: null + extRef5: + type: string + nullable: true + example: Webshop + extRef6: + type: string + nullable: true + example: null + BookingLineMetadataPatchResponseBody: + type: object + properties: + bookingLineMetadataId: + type: string + format: uuid + example: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617 + required: + - bookingLineMetadataId MetadataAuditTrailsGetResponseBody: type: object properties: @@ -1647,7 +2708,7 @@ components: taxCode: type: string example: V21 - taxPercentageAmount: + taxPercentageAmount: type: integer example: 21 description: @@ -1677,7 +2738,7 @@ components: sourceMetadata: type: array items: - $ref: '#/components/schemas/SourceMetadata' + $ref: "#/components/schemas/SourceMetadata" href: type: string nullable: true