OVPAY-2378 - Updated spec for /contractpayments.
This commit is contained in:
parent
4bd216bd37
commit
292588b7ba
@ -597,9 +597,13 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/unavailable"
|
$ref: "#/components/schemas/unavailable"
|
||||||
examples:
|
examples:
|
||||||
List all contract payments for a single debtor:
|
Empty list:
|
||||||
summary: List all contract payments for a single debtor
|
summary: Empty list
|
||||||
description: List all contract payments for single debtor with debtor number 'D123456'.
|
description: List all contract payments for a debtor with no payments.
|
||||||
|
value: { "contractPayments": [] }
|
||||||
|
Successful direct debit:
|
||||||
|
summary: Successful direct debit
|
||||||
|
description: One payment for a debtor with a successful direct debit.
|
||||||
value:
|
value:
|
||||||
{
|
{
|
||||||
"contractPayments":
|
"contractPayments":
|
||||||
@ -607,8 +611,133 @@ paths:
|
|||||||
{
|
{
|
||||||
"paymentId": "151845776",
|
"paymentId": "151845776",
|
||||||
"totalAmount": "26.62",
|
"totalAmount": "26.62",
|
||||||
"paymentMethod": "Twikey",
|
"paymentMethod": "direct_debit",
|
||||||
"paymentDate": "2024-09-12",
|
"paymentDate": "2024-09-12",
|
||||||
|
"iban": "NL25INGB******1337",
|
||||||
|
"invoice":
|
||||||
|
{
|
||||||
|
"invoiceId": "147722263",
|
||||||
|
"invoiceNumber": "F2024-0001",
|
||||||
|
"description": "HTM Maandkorting 20%",
|
||||||
|
"publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
|
||||||
|
},
|
||||||
|
"_links":
|
||||||
|
{
|
||||||
|
"get_contractdetails":
|
||||||
|
{
|
||||||
|
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
|
||||||
|
"method": "GET",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
||||||
|
Direct debit reversal:
|
||||||
|
summary: Direct debit reversal
|
||||||
|
description: One payment for a debtor with a reversed direct debit.
|
||||||
|
value:
|
||||||
|
{
|
||||||
|
"contractPayments":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"paymentId": "151845776",
|
||||||
|
"totalAmount": "-26.62",
|
||||||
|
"paymentMethod": "direct_debit_reversal",
|
||||||
|
"paymentDate": "2024-09-12",
|
||||||
|
"iban": "NL25INGB******1337",
|
||||||
|
"invoice":
|
||||||
|
{
|
||||||
|
"invoiceId": "147722263",
|
||||||
|
"invoiceNumber": "F2024-0001",
|
||||||
|
"description": "HTM Maandkorting 20%",
|
||||||
|
"publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
|
||||||
|
},
|
||||||
|
"_links":
|
||||||
|
{
|
||||||
|
"get_contractdetails":
|
||||||
|
{
|
||||||
|
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
|
||||||
|
"method": "GET",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
||||||
|
iDEAL payment:
|
||||||
|
summary: iDEAL payment
|
||||||
|
description: One payment for a debtor with an iDEAL payment.
|
||||||
|
value:
|
||||||
|
{
|
||||||
|
"contractPayments":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"paymentId": "151845776",
|
||||||
|
"totalAmount": "26.62",
|
||||||
|
"paymentMethod": "ideal",
|
||||||
|
"paymentDate": "2024-09-12",
|
||||||
|
"iban": "NL25INGB******1337",
|
||||||
|
"invoice":
|
||||||
|
{
|
||||||
|
"invoiceId": "147722263",
|
||||||
|
"invoiceNumber": "F2024-0001",
|
||||||
|
"description": "HTM Maandkorting 20%",
|
||||||
|
"publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
|
||||||
|
},
|
||||||
|
"_links":
|
||||||
|
{
|
||||||
|
"get_contractdetails":
|
||||||
|
{
|
||||||
|
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
|
||||||
|
"method": "GET",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
||||||
|
Bank transfer:
|
||||||
|
summary: Bank transfer
|
||||||
|
description: One payment for a debtor with a bank transfer.
|
||||||
|
value:
|
||||||
|
{
|
||||||
|
"contractPayments":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"paymentId": "151845776",
|
||||||
|
"totalAmount": "26.62",
|
||||||
|
"paymentMethod": "bank_transfer",
|
||||||
|
"paymentDate": "2024-09-12",
|
||||||
|
"iban": "NL25INGB******1337",
|
||||||
|
"invoice":
|
||||||
|
{
|
||||||
|
"invoiceId": "147722263",
|
||||||
|
"invoiceNumber": "F2024-0001",
|
||||||
|
"description": "HTM Maandkorting 20%",
|
||||||
|
"publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
|
||||||
|
},
|
||||||
|
"_links":
|
||||||
|
{
|
||||||
|
"get_contractdetails":
|
||||||
|
{
|
||||||
|
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
|
||||||
|
"method": "GET",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
||||||
|
List of four payments for one invoice:
|
||||||
|
summary: List of four payments for one invoice
|
||||||
|
description: Four payments for a debtor for one invoice; a direct debit, a direct debit reversal, a bank transfer and an iDEAL payment.
|
||||||
|
value:
|
||||||
|
{
|
||||||
|
"contractPayments":
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"paymentId": "151845776",
|
||||||
|
"totalAmount": "26.62",
|
||||||
|
"paymentMethod": "direct_debit",
|
||||||
|
"paymentDate": "2024-09-12",
|
||||||
|
"iban": "NL25INGB******1337",
|
||||||
"invoice":
|
"invoice":
|
||||||
{
|
{
|
||||||
"invoiceId": "147722263",
|
"invoiceId": "147722263",
|
||||||
@ -626,22 +755,67 @@ paths:
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"paymentId": "151845851",
|
"paymentId": "151845776",
|
||||||
"totalAmount": "45.21",
|
"totalAmount": "-26.62",
|
||||||
"paymentMethod": "Twikey",
|
"paymentMethod": "direct_debit_reversal",
|
||||||
"paymentDate": "2024-09-12",
|
"paymentDate": "2024-09-12",
|
||||||
|
"iban": "NL25INGB******1337",
|
||||||
"invoice":
|
"invoice":
|
||||||
{
|
{
|
||||||
"invoiceId": "147722266",
|
"invoiceId": "147722263",
|
||||||
"invoiceNumber": "F2024-0002",
|
"invoiceNumber": "F2024-0001",
|
||||||
"description": "HTM Maandkorting 20%",
|
"description": "HTM Maandkorting 20%",
|
||||||
"publicLink": "https://factuurinzien.nl/d/ddb245d6df67999eca48c4a71b5661b93038e20a/i/dp5h1i5cuu94nopiolkdst3u17vkmzo",
|
"publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
|
||||||
},
|
},
|
||||||
"_links":
|
"_links":
|
||||||
{
|
{
|
||||||
"get_contractdetails":
|
"get_contractdetails":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/7b2f8c1a-3d9d-4c2d-960e-4471e8e28b6a",
|
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
|
||||||
|
"method": "GET",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"paymentId": "151845777",
|
||||||
|
"totalAmount": "10.00",
|
||||||
|
"paymentMethod": "bank_transfer",
|
||||||
|
"paymentDate": "2024-09-13",
|
||||||
|
"iban": "NL25INGB******1337",
|
||||||
|
"invoice":
|
||||||
|
{
|
||||||
|
"invoiceId": "147722263",
|
||||||
|
"invoiceNumber": "F2024-0001",
|
||||||
|
"description": "HTM Maandkorting 20%",
|
||||||
|
"publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
|
||||||
|
},
|
||||||
|
"_links":
|
||||||
|
{
|
||||||
|
"get_contractdetails":
|
||||||
|
{
|
||||||
|
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
|
||||||
|
"method": "GET",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"paymentId": "151845778",
|
||||||
|
"totalAmount": "16.62",
|
||||||
|
"paymentMethod": "ideal",
|
||||||
|
"paymentDate": "2024-09-14",
|
||||||
|
"iban": "NL25INGB******1337",
|
||||||
|
"invoice":
|
||||||
|
{
|
||||||
|
"invoiceId": "147722263",
|
||||||
|
"invoiceNumber": "F2024-0001",
|
||||||
|
"description": "HTM Maandkorting 20%",
|
||||||
|
"publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a",
|
||||||
|
},
|
||||||
|
"_links":
|
||||||
|
{
|
||||||
|
"get_contractdetails":
|
||||||
|
{
|
||||||
|
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user