From 03c335bece08d672a9750f8271f5fbcc9b930ee1 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Thu, 26 Sep 2024 12:56:59 +0200 Subject: [PATCH] DHIL-3364 - Added CustomerToken and PersonalAccountData. --- src/openapi/orders/orders-crud.yaml | 349 +++++++++++++++++++++++++++- 1 file changed, 348 insertions(+), 1 deletion(-) diff --git a/src/openapi/orders/orders-crud.yaml b/src/openapi/orders/orders-crud.yaml index 8a055b5..b3a7e3f 100644 --- a/src/openapi/orders/orders-crud.yaml +++ b/src/openapi/orders/orders-crud.yaml @@ -653,7 +653,6 @@ paths: { "order_orderStatusId": "b9cf0096-4211-4be6-ac21-7bc34bc8e066", } - /orders/{orderId}/orderlines: parameters: - in: path @@ -933,6 +932,15 @@ paths: example: 2024-03-22T09:00:00 required: false description: Timestamp after which the order line should have been updated. + - in: query + name: accountingStatusId + schema: + type: array + items: + type: integer + explode: false + required: false + description: Filter on current account statuses. 1 = open, 2 = sent, 3 = received, 4 = rejected. responses: "200": description: OK @@ -1040,6 +1048,344 @@ paths: schema: $ref: "#/components/schemas/unavailable" example: { "orderLineId": "ee82686a-a9f6-4888-b336-8e2aab6f4e13" } + /orderlines/{orderLineId}/accountingstatuses: + parameters: + - in: path + name: orderLineId + schema: + type: string + format: uuid + example: 9ff2e034-ed4f-44d5-8f6c-d703bd4df332 + required: true + description: The id of the order line to process. + post: + summary: Add an accounting status to an order line. + description: Add an accounting status to an order line. + tags: + - Order Line + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "accountingStatusId": 1, + "createdOn": "2024-03-22T09:00:00", + "description": "Financiele transactie voor de FIKO.", + } + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "orderAccountingStatusId": "60dbd8a7-0a22-40b5-9c53-1bc9aaf1a1ae", + } + /orderlines/{orderLineId}/customertokens: + parameters: + - in: path + name: orderLineId + schema: + type: string + format: uuid + example: 9ff2e034-ed4f-44d5-8f6c-d703bd4df332 + required: true + description: The id of the order line to process. + post: + summary: Add a customer token to an order line. + description: Add acustomer token to an order line. + tags: + - Order Line + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "tokenTypeId": 1, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "xTAT": "3b5f2354-d8a1-4317-bb6e-2c32458bc061", + "xBOT": "0fbdb14c-9306-462e-aca7-765a4980a2f7", + "personalAccountData": + { + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + } + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { "customerTokenId": "eeec597c-36c4-41b2-aeeb-ab5c32f2365d" } + /customertokens: + get: + summary: Find customer tokens. + description: Find customer tokens. + tags: + - Order Line + parameters: + - in: query + name: customerTokenId + schema: + type: string + format: uuid + example: 74c07b9e-5979-4fcc-b98c-4f0be456838c + required: false + description: The id of the customer token. + - in: query + name: orderLineId + schema: + type: string + format: uuid + example: 4ea492ff-8ffc-4a4e-901e-59f05e854285 + required: false + description: The id of the order line. + - in: query + name: tokenTypeId + schema: + type: array + items: + type: integer + explode: false + required: false + description: Filter on possible token types. 1 = EMV, 2 = OV-pas physical, 3 = OV-pas digital. + - in: query + name: ovPayTokenId + schema: + type: integer + example: 42 + required: false + description: The id of the OVpay token. + - in: query + name: serviceReferenceId + schema: + type: string + example: NLOV1234567ABCDEFG + required: false + description: Service reference id of the token. + - in: query + name: amount + schema: + type: integer + example: 131 + required: false + description: The ammount corresponding to the SRID. + - in: query + name: ovpasNumber + schema: + type: string + example: 63AW974 + required: false + description: Number of the OVpas. + - in: query + name: verificationCode + schema: + type: string + example: 8ZY2 + required: false + description: Verification code corresponding to the OVpas. + - in: query + name: xtat + schema: + type: string + example: 0fbdb14c-9306-462e-aca7-765a4980a2f7 + required: false + description: XTAT of the transit account. + - in: query + name: xbot + schema: + type: string + example: 3b5f2354-d8a1-4317-bb6e-2c32458bc061 + required: false + description: XBOT of the token. + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + [ + { + "customerTokeId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e", + "orderId": "95454803-68fb-4735-a9b5-1251cdece3cd", + "orderLineId": "9b0d28a2-46ce-4e74-9cf5-497a5b91e86b", + "tokenType": { "tokenTypeId": 1, "name": "EMV" }, + "ovPayTokenId": 1, + "serviceReferenceId": "NLOV1234567ABCDEFG", + "amount": 34, + "ovpasNumber": "OV34567", + "verificationCode": "A7H6", + "xTAT": "3b5f2354-d8a1-4317-bb6e-2c32458bc061", + "xBOT": "0fbdb14c-9306-462e-aca7-765a4980a2f7", + "personalAccountData": + { + "personalAccountDataId": "47db8a40-3238-4bf5-9284-759e3888bd47", + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeType": + { "challengeTypeId": 1, "name": "email" }, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + }, + ] + /personalaccountdata: + get: + summary: Find personal account data. + description: Find customer tokens. + tags: + - Order Line + parameters: + - in: query + name: personalAccountDataId + schema: + type: string + format: uuid + example: 0743969c-4e4c-4123-bd45-0366f7add029 + required: false + description: The id of the personal account data. + - in: query + name: customerTokenId + schema: + type: string + format: uuid + example: 9935456d-45e5-419a-91c0-5deb85119f2b + required: false + description: The id of the customer token. + - in: query + name: name + schema: + type: string + example: J. de Vries + required: false + description: The name of the customer. + - in: query + name: dateOfBirth + schema: + type: string + format: date + example: 1970-01-01 + required: false + description: The date of birth of the customer. + - in: query + name: photoReference + schema: + type: string + example: DSC_0502.JPG + required: false + description: A reference to the customer photo. + - in: query + name: fileType + schema: + type: string + example: image/jpg + required: false + description: File type of the customer photo. + - in: query + name: challengeTypeId + schema: + type: array + items: + type: integer + explode: false + required: false + description: Filter on possible challenge types. 1 = email, 2 = sms. + - in: query + name: oneTimePassword + schema: + type: string + example: "H5Iiz3JTaQeIV8p" + explode: false + required: false + description: Filter on possible challenge types. 1 = email, 2 = sms. + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + [ + { + "personalAccountDataId": "47db8a40-3238-4bf5-9284-759e3888bd47", + "customerTokeId": "7252ad91-3a4b-4ab4-b529-ec78a39a49b2", + "orderLineId": "858e31b9-67f0-46ca-bf88-91a382b9c079", + "orderId": "858e31b9-67f0-46ca-bf88-91a382b9c079", + "name": "Jan de Vries", + "dateOfBirth": "01-01-1970", + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeType": { "challengeTypeId": 1, "name": "email" }, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + }, + ] + /personalaccountdata/{personalAccountDataId}: + parameters: + - in: path + name: personalAccountDataId + schema: + type: string + format: uuid + example: e4e0d37d-d01e-4633-b849-87113ed207bd + required: true + description: The id of the personal account data. + patch: + summary: Update personal account data. + description: Update personal account data. + tags: + - Order Line + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "photoReference": "DSC_0502.JPG", + "fileType": "image/jpg", + "challengeTypeId": 1, + "oneTimePassword": "H5Iiz3JTaQeIV8p", + } + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "personalAccountDataId": "47041fde-7044-42e6-9ab5-091c05ce32f5", + } + delete: + summary: Delete personal account data. + description: Delete personal account data. + tags: + - Order Line + responses: + "200": + description: Ok /payments: get: summary: Find payments. @@ -1335,6 +1681,7 @@ paths: { "mandateInputId": "0a875e67-dc9f-4825-a030-d732a2adbfbc", "paymentId": "4a7ee6ec-d218-49b7-a5bf-0107945767ee", + "orderId": "afa89108-3e40-44ac-8bea-7c7f0f2d4006", "mandateType": { "mandateTypeId": 1, "name": "import" }, "createdOn": "2024-03-22T09:00:00", "bic": "RABONL2U",