develop #4

Merged
bboterm merged 11 commits from develop into main 2024-11-05 09:45:01 +00:00
3 changed files with 1338 additions and 125 deletions

View File

@ -216,6 +216,7 @@ paths:
"created": "2024-06-02 15:01:00.000", "created": "2024-06-02 15:01:00.000",
"updated": "2024-06-02 15:01:00.000", "updated": "2024-06-02 15:01:00.000",
"state": "invoice_created", "state": "invoice_created",
"isCredit": false,
}, },
{ {
"contractInvoiceId": "1c345237-4d84-47f0-93c2-7b94338e3355", "contractInvoiceId": "1c345237-4d84-47f0-93c2-7b94338e3355",
@ -224,6 +225,7 @@ paths:
"created": "2024-07-02 15:01:00.000", "created": "2024-07-02 15:01:00.000",
"updated": "2024-07-02 15:01:00.000", "updated": "2024-07-02 15:01:00.000",
"state": "invoice_created", "state": "invoice_created",
"isCredit": false,
}, },
], ],
"contractVersions": "contractVersions":
@ -273,6 +275,7 @@ paths:
"created": "2024-06-02 15:01:00.000", "created": "2024-06-02 15:01:00.000",
"updated": "2024-06-02 15:01:00.000", "updated": "2024-06-02 15:01:00.000",
"state": "invoice_created", "state": "invoice_created",
"isCredit": false,
}, },
{ {
"contractInvoiceId": "1c345237-4d84-47f0-93c2-7b94338e3355", "contractInvoiceId": "1c345237-4d84-47f0-93c2-7b94338e3355",
@ -281,6 +284,7 @@ paths:
"created": "2024-07-02 15:01:00.000", "created": "2024-07-02 15:01:00.000",
"updated": "2024-07-02 15:01:00.000", "updated": "2024-07-02 15:01:00.000",
"state": "invoice_created", "state": "invoice_created",
"isCredit": false,
}, },
], ],
"contractVersions": "contractVersions":
@ -401,6 +405,7 @@ paths:
"updated": "2024-07-02 15:01:00.000", "updated": "2024-07-02 15:01:00.000",
"state": "invoice_created", "state": "invoice_created",
"data": "{json}", "data": "{json}",
"isCredit": false,
}, },
], ],
}, },
@ -568,6 +573,7 @@ paths:
"updated": "2024-07-02 15:01:00.000", "updated": "2024-07-02 15:01:00.000",
"state": "invoice_sent", "state": "invoice_sent",
"data": "{json}", "data": "{json}",
"isCredit": false,
}, },
{ {
"contractInvoiceId": "dadff658-4ff5-4eb8-b516-492f1f6c6245", "contractInvoiceId": "dadff658-4ff5-4eb8-b516-492f1f6c6245",
@ -577,6 +583,7 @@ paths:
"updated": "2024-08-02 15:01:00.000", "updated": "2024-08-02 15:01:00.000",
"state": "invoice_created", "state": "invoice_created",
"data": "{json}", "data": "{json}",
"isCredit": false,
}, },
], ],
} }
@ -600,6 +607,7 @@ paths:
"updated": "2024-07-02 15:01:00.000", "updated": "2024-07-02 15:01:00.000",
"state": "invoice_created", "state": "invoice_created",
"data": "{json}", "data": "{json}",
"isCredit": false,
}, },
} }
responses: responses:
@ -684,6 +692,13 @@ paths:
example: created example: created
required: false required: false
description: Invoice state. description: Invoice state.
- in: query
name: isCredit
schema:
type: boolean
example: false
required: false
description: Whether the invoice is a credit invoice.
responses: responses:
"200": "200":
description: OK description: OK
@ -704,6 +719,7 @@ paths:
"updated": "2024-06-02 15:01:00.000", "updated": "2024-06-02 15:01:00.000",
"state": "invoice_created", "state": "invoice_created",
"data": "{json}", "data": "{json}",
"isCredit": false,
}, },
{ {
"contractId": "a7452e22-3894-40cc-87d6-869370a92277", "contractId": "a7452e22-3894-40cc-87d6-869370a92277",
@ -714,6 +730,7 @@ paths:
"updated": "2024-08-02 15:01:00.000", "updated": "2024-08-02 15:01:00.000",
"state": "invoice_created", "state": "invoice_created",
"data": "{json}", "data": "{json}",
"isCredit": false,
}, },
], ],
} }
@ -1049,6 +1066,9 @@ components:
type: string type: string
format: json format: json
example: { json } example: { json }
isCredit:
type: boolean
example: false
ContractStatus: ContractStatus:
type: object type: object
properties: properties:

File diff suppressed because it is too large Load Diff

View File

@ -17,8 +17,7 @@ paths:
name: externalOrderId name: externalOrderId
schema: schema:
type: string type: string
format: uuid example: EXT001
example: 26ce08bc-0443-465f-9cd2-a7143f33eed0
required: false required: false
description: The order id in the external system. description: The order id in the external system.
- in: query - in: query
@ -110,7 +109,7 @@ paths:
type: integer type: integer
explode: false explode: false
required: false required: false
description: Filter on possible order statuses. 1 = concept, 2 = awaitingPayment, 3 = pendingPayment, 4 = paid, 5 = delivered, 6 = cancelled. description: Filter on most recent order status. 1 = concept, 2 = awaitingPayment, 3 = pendingPayment, 4 = paid, 5 = delivered, 6 = cancelled.
responses: responses:
"200": "200":
description: OK description: OK
@ -141,13 +140,25 @@ paths:
"createdOn": "2024-03-22T09:00:00", "createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus": "order_OrderStatus":
{ [
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", {
"orderStatus": "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
{ "orderStatusId": 4, "name": "paid" }, "orderStatus":
"createdOn": "2024-03-22T09:00:00", { "orderStatusId": 4, "name": "paid" },
"description": "Order succesvol betaald", "createdOn": "2024-03-22T09:00:00",
}, "description": "Order succesvol betaald",
},
{
"order_orderStatusId": "2b9b7943-3a74-4f2e-ad65-012b62c80821",
"orderStatus":
{
"orderStatusId": 3,
"name": "pendingPayment",
},
"createdOn": "2024-03-22T08:55:00",
"description": "Betaling in behandeling",
},
],
"orderLines": "orderLines":
[ [
{ {
@ -315,11 +326,18 @@ paths:
"shippingAddressId": 1, "shippingAddressId": 1,
"createdOn": "2024-03-22T09:00:00", "createdOn": "2024-03-22T09:00:00",
"order_OrderStatus": "order_OrderStatus":
{ [
"orderStatusId": 4, {
"createdOn": "2024-03-22T09:00:00", "orderStatusId": 4,
"description": "Order succesvol betaald", "createdOn": "2024-03-22T09:00:00",
}, "description": "Order succesvol betaald",
},
{
"orderStatusId": 3,
"createdOn": "2024-03-22T08:55:00",
"description": "Betaling in behandeling",
},
],
"orderLines": "orderLines":
[ [
{ {
@ -475,12 +493,21 @@ paths:
"createdOn": "2024-03-22T09:00:00", "createdOn": "2024-03-22T09:00:00",
"lastUpdatedOn": "2024-03-22T09:00:00", "lastUpdatedOn": "2024-03-22T09:00:00",
"order_OrderStatus": "order_OrderStatus":
{ [
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f", {
"orderStatus": { "orderStatusId": 4, "name": "paid" }, "order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
"createdOn": "2024-03-22T09:00:00", "orderStatus": { "orderStatusId": 4, "name": "paid" },
"description": "Order succesvol betaald", "createdOn": "2024-03-22T09:00:00",
}, "description": "Order succesvol betaald",
},
{
"order_orderStatusId": "2b9b7943-3a74-4f2e-ad65-012b62c80821",
"orderStatus":
{ "orderStatusId": 3, "name": "pendingPayment" },
"createdOn": "2024-03-22T08:55:00",
"description": "Betaling in behandeling",
},
],
"orderLines": "orderLines":
[ [
{ {
@ -767,8 +794,8 @@ paths:
required: true required: true
description: The id of the order to process. description: The id of the order to process.
post: post:
summary: P2. Add one or more payments to an order. summary: P2. Add a payment to an order.
description: Add one or more payments to an order. description: Add a payment to an order.
tags: tags:
- Payment - Payment
requestBody: requestBody:
@ -777,36 +804,34 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
[ {
{ "createdOn": "2024-03-22T09:00:00",
"createdOn": "2024-03-22T09:00:00", "amountDebit": 121,
"amountDebit": 121, "paymentMethodId": 1,
"paymentMethodId": 1, "touchPointId": 1,
"touchPointId": 1, "isRefund": false,
"isRefund": false, "htmPaymentReference": "HTM-1234",
"htmPaymentReference": "HTM-1234", "pspPaymentReference": "Buckaroo-1234",
"pspPaymentReference": "Buckaroo-1234", "paymentStatuses":
"paymentStatuses": [
[
{
"createdOn": "2024-03-22T09:00:00",
"statusCode": "190",
"statusDescription": "Success",
"statusSubCode": "S001",
"statusSubDescription": "PaymentSuccessFul",
},
],
"mandateInput":
{ {
"directDebitMandateTypeId": 1,
"createdOn": "2024-03-22T09:00:00", "createdOn": "2024-03-22T09:00:00",
"bic": "RABONL2U", "statusCode": "190",
"iban": "NL44RABO0123456789", "statusDescription": "Success",
"ascription": "J. de Vries", "statusSubCode": "S001",
"place": "Den Haag", "statusSubDescription": "PaymentSuccessFul",
}, },
}, ],
] "mandateInput":
{
"directDebitMandateTypeId": 1,
"createdOn": "2024-03-22T09:00:00",
"bic": "RABONL2U",
"iban": "NL44RABO0123456789",
"ascription": "J. de Vries",
"place": "Den Haag",
},
}
responses: responses:
"201": "201":
description: Created description: Created