diff --git a/src/openapi/customers/customers-crud-v2.yaml b/src/openapi/customers/customers-crud-v2.yaml index db38de9..83c7a68 100644 --- a/src/openapi/customers/customers-crud-v2.yaml +++ b/src/openapi/customers/customers-crud-v2.yaml @@ -15,7 +15,7 @@ paths: Search for all customer profile list in the ABT database matching given query parameters parameters: - name: customerProfileId - in: query + in: query schema: type: integer example: 1 @@ -43,6 +43,23 @@ paths: items: type: integer description: Filter on possible debtor statuses. 1 = Active, 2 = Inactive + - name: vasCustomerNumber + in: query + schema: + type: string + example: VAS100001 + - name: lastLoginBefore + in: query + schema: + type: string + format: date-time + example: "2022-08-04 15:01:00.000" + - name: lastLoginAfter + in: query + schema: + type: string + format: date-time + example: "2022-08-04 15:01:00.000" - name: birthname in: query schema: @@ -57,7 +74,7 @@ paths: in: query schema: type: string - example: De + example: de - name: suffix in: query schema: @@ -79,67 +96,67 @@ paths: in: query schema: type: string - example: Sesamestreet + example: Sesamestreet - name: addressHouseNumber in: query schema: type: integer - example: 1 + example: 1 - name: addressHouseNumberSuffix in: query schema: type: string - example: A + example: A - name: addressPostalCode in: query schema: type: string - example: 1234AB + example: 1234AB - name: addressCity in: query schema: type: string - example: The Hague + example: The Hague - name: addressCountry in: query schema: type: string - example: NL + example: NL - name: phoneNumber in: query schema: type: string - example: "0123456789" + example: "0123456789" - name: phoneCountryCode in: query schema: type: string - example: "+31" + example: "+31" - name: ovChipcardNumber in: query schema: type: integer - example: 0123456789 + example: 0123456789 - name: ovChipcardAlias in: query schema: type: string - example: My ovchipcard + example: My ovchipcard - name: ovPasNumber in: query schema: type: string - example: 0123456789 + example: 0123456789 - name: ovPayTokenAlias in: query schema: type: string - example: My Ov Pay Token + example: My Ov Pay Token - name: ovPayTokenXTat in: query schema: type: string - example: 180d04e0-a721-447e-a1d9-b416937b43bc + example: 180d04e0-a721-447e-a1d9-b416937b43bc - name: ovPayTokenXBot in: query schema: @@ -154,33 +171,33 @@ paths: in: query schema: type: string - example: NL20INGB0001234567 + example: NL20INGB0001234567 - name: bic in: query schema: type: string - example: NL20INGB + example: NL20INGB - name: ascription in: query schema: type: string - example: j.jansen + example: j.jansen - name: billingAlias in: query schema: type: string - example: Mijn ING bankrekening + example: Mijn ING bankrekening - name: sort in: query - schema: + schema: type: string - name: offset in: query - schema: - type: integer + schema: + type: integer - name: limit in: query - schema: + schema: type: integer example: 20 responses: @@ -203,7 +220,7 @@ paths: debtorStatus: debtorStatusId: 1 name: Inactive - vascustomerNumber: CST005 + vasCustomerNumber: CST005 customerPreference: language: languageId: 1 @@ -218,8 +235,8 @@ paths: toInclusive: "2022-08-05 15:01:00.000" person: birthname: Pieter - surname: De valen - prefix: De + surname: Valen + prefix: de suffix: PhD dateOfBirth: "2002-10-29" emailAddresses: TEST@HTM.NL @@ -262,66 +279,67 @@ paths: name: Work isPreferred: false ovChipcards: - - ovChipCardId: 1 - chipCardNumber: 1234123412341234 - validUntil: "2023-01-01" - alias: alias - - ovChipCardId: 2 - chipCardNumber: 1234123412341235 - validUntil: "2025-01-01" - alias: alias + - ovChipCardId: 1 + chipCardNumber: 1234123412341234 + validUntil: "2023-01-01" + alias: alias + - ovChipCardId: 2 + chipCardNumber: 1234123412341235 + validUntil: "2025-01-01" + alias: alias ovPayTokens: - - ovPayTokenId: 126 - tokenType: - tokenTypeId: 1 - name: EMV - xTat: 0115b0df-db38-4702-8811-6f7de00db3ac - xBot: 71a88843-32b8-4d52-ac25-de2458c47775 - alias: alias - lastDigits: "5678" - ovpasNumber: null - tokenStatus: - tokenStatusId: 2 - name: Active - expirationDate: "2025-04-20T17:05:52.000+02:00" - replacedByTokenId: 1 - - ovPayTokenId: 127 - tokenType: - tokenTypeId: 2 - name: OV-pas physical - xTat: 0115b0df-db38-4702-8811-6f7de00db3ac - xBot: 71a88843-32b8-4d52-ac25-de2458c47775 - alias: alias - lastDigits: "5674" - ovpasNumber: OV34568 - tokenStatus: - tokenStatusId: 2 - name: Active - expirationDate: "2024-04-20T17:05:52.000+02:00" - replacedByTokenId: 2 + - ovPayTokenId: 126 + tokenType: + tokenTypeId: 1 + name: EMV + xTat: 0115b0df-db38-4702-8811-6f7de00db3ac + xBot: 71a88843-32b8-4d52-ac25-de2458c47775 + alias: alias + lastDigits: "5678" + ovpasNumber: null + tokenStatus: + tokenStatusId: 2 + name: Active + expirationDate: "2025-04-20T17:05:52.000+02:00" + replacedByTokenId: 1 + - ovPayTokenId: 127 + tokenType: + tokenTypeId: 2 + name: OV-pas physical + xTat: 0115b0df-db38-4702-8811-6f7de00db3ac + xBot: 71a88843-32b8-4d52-ac25-de2458c47775 + alias: alias + lastDigits: "5674" + ovpasNumber: OV34568 + tokenStatus: + tokenStatusId: 2 + name: Active + expirationDate: "2024-04-20T17:05:52.000+02:00" + replacedByTokenId: 2 auditTrails: - - auditTrailId: 1 - customerProfileId: 1 - action: insert - user: user - timestamp: "2023-10-20T17:05:52.000+02:00" - correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 + - auditTrailId: 1 + customerProfileId: 1 + action: insert + user: user + timestamp: "2023-10-20T17:05:52.000+02:00" + correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 _links: { - "self":{ - "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1", - "method": "GET" - } - } + "self": + { + "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1", + "method": "GET", + }, + } - customerProfileId: 12 customerNumber: 1000002 debtorNumber: DB100121 debtorStatus: debtorStatusId: 1 name: Inactive - vascustomerNumber: CST005 + vasCustomerNumber: CST005 customerPreference: - language: + language: languageId: 1 name: Dutch ietfCode: nl-NL @@ -344,8 +362,8 @@ paths: toInclusive: null person: birthname: Pieter - surname: De valen - prefix: De + surname: Valen + prefix: de suffix: PhD dateOfBirth: "2002-10-29" emailAddresses: TEST@HTM.NL @@ -388,71 +406,75 @@ paths: name: Work isPreferred: false ovChipcards: - - ovChipCardId: 1 - chipCardNumber: 1234123412341234 - validUntil: "2023-01-01" - alias: alias - - ovChipCardId: 2 - chipCardNumber: 1234123412341235 - validUntil: "2025-01-01" - alias: alias + - ovChipCardId: 1 + chipCardNumber: 1234123412341234 + validUntil: "2023-01-01" + alias: alias + - ovChipCardId: 2 + chipCardNumber: 1234123412341235 + validUntil: "2025-01-01" + alias: alias ovPayTokens: - - ovPayTokenId: 126 - tokenType: - tokenTypeId: 2 - name: OV-pas physical - xTat: 0115b0df-db38-4702-8811-6f7de00db3ac - xBot: 71a88843-32b8-4d52-ac25-de2458c47775 - alias: alias - lastDigits: "5678" - ovpasNumber: OV34567 - tokenStatus: - tokenStatusId: 2 - name: active - expirationDate: "2025-04-20T17:05:52.000+02:00" - replacedByTokenId: 1 - - ovPayTokenId: 127 - tokenType: - tokenTypeId: 2 - name: OV-pas physical - xTat: 0115b0df-db38-4702-8811-6f7de00db3ac - xBot: 71a88843-32b8-4d52-ac25-de2458c47775 - alias: alias - lastDigits: "5674" - ovpasNumber: OV34568 - tokenStatus: - tokenStatusId: 2 - name: active - expirationDate: "2024-04-20T17:05:52.000+02:00" - replacedByTokenId: 2 + - ovPayTokenId: 126 + tokenType: + tokenTypeId: 2 + name: OV-pas physical + xTat: 0115b0df-db38-4702-8811-6f7de00db3ac + xBot: 71a88843-32b8-4d52-ac25-de2458c47775 + alias: alias + lastDigits: "5678" + ovpasNumber: OV34567 + tokenStatus: + tokenStatusId: 2 + name: active + expirationDate: "2025-04-20T17:05:52.000+02:00" + replacedByTokenId: 1 + - ovPayTokenId: 127 + tokenType: + tokenTypeId: 2 + name: OV-pas physical + xTat: 0115b0df-db38-4702-8811-6f7de00db3ac + xBot: 71a88843-32b8-4d52-ac25-de2458c47775 + alias: alias + lastDigits: "5674" + ovpasNumber: OV34568 + tokenStatus: + tokenStatusId: 2 + name: active + expirationDate: "2024-04-20T17:05:52.000+02:00" + replacedByTokenId: 2 auditTrails: - - auditTrailId: 1 - customerProfileId: 1 - action: insert - user: user - timestamp: "2023-10-20T17:05:52.000+02:00" - correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 + - auditTrailId: 1 + customerProfileId: 1 + action: insert + user: user + timestamp: "2023-10-20T17:05:52.000+02:00" + correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 _links: { - "self":{ - "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=12", - "method": "GET" - } - } - _links: - { - "self":{ - "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=20", - "method": "GET" - }, - "prev":{ - "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers", - "method": "GET" - }, - "next":{ - "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=40", - "method": "GET" - } + "self": + { + "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=12", + "method": "GET", + }, + } + _links: + { + "self": + { + "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=20", + "method": "GET", + }, + "prev": + { + "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers", + "method": "GET", + }, + "next": + { + "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?offset=40", + "method": "GET", + }, } getCustomerActive: summary: getCustomerActive @@ -466,7 +488,7 @@ paths: debtorStatus: debtorStatusId: 1 name: Inactive - vascustomerNumber: CST005 + vasCustomerNumber: CST005 customerPreference: language: languageId: 1 @@ -481,8 +503,8 @@ paths: toInclusive: null person: birthname: Pieter - surname: De valen - prefix: De + surname: Valen + prefix: de suffix: PhD dateOfBirth: "2002-10-29" emailAddresses: TEST@HTM.NL @@ -525,64 +547,66 @@ paths: name: Work isPreferred: false ovChipcards: - - ovChipCardId: 1 - chipCardNumber: 1234123412341234 - validUntil: "2023-01-01" - alias: alias - - ovChipCardId: 2 - chipCardNumber: 1234123412341235 - validUntil: "2025-01-01" - alias: alias + - ovChipCardId: 1 + chipCardNumber: 1234123412341234 + validUntil: "2023-01-01" + alias: alias + - ovChipCardId: 2 + chipCardNumber: 1234123412341235 + validUntil: "2025-01-01" + alias: alias ovPayTokens: - - ovPayTokenId: 126 - tokenType: - tokenTypeId: 1 - name: EMV - xTat: 0115b0df-db38-4702-8811-6f7de00db3ac - xBot: 71a88843-32b8-4d52-ac25-de2458c47775 - alias: alias - lastDigits: "5678" - ovpasNumber: null - tokenStatus: - tokenStatusId: 2 - name: Active - expirationDate: "2025-04-20T17:05:52.000+02:00" - replacedByTokenId: 1 - - ovPayTokenId: 127 - tokenType: - tokenTypeId: 2 - name: OV-pas physical - xTat: 0115b0df-db38-4702-8811-6f7de00db3ac - xBot: 71a88843-32b8-4d52-ac25-de2458c47775 - alias: alias - lastDigits: "5674" - ovpasNumber: OV34568 - tokenStatus: - tokenStatusId: 2 - name: Active - expirationDate: "2024-04-20T17:05:52.000+02:00" - replacedByTokenId: 2 + - ovPayTokenId: 126 + tokenType: + tokenTypeId: 1 + name: EMV + xTat: 0115b0df-db38-4702-8811-6f7de00db3ac + xBot: 71a88843-32b8-4d52-ac25-de2458c47775 + alias: alias + lastDigits: "5678" + ovpasNumber: null + tokenStatus: + tokenStatusId: 2 + name: Active + expirationDate: "2025-04-20T17:05:52.000+02:00" + replacedByTokenId: 1 + - ovPayTokenId: 127 + tokenType: + tokenTypeId: 2 + name: OV-pas physical + xTat: 0115b0df-db38-4702-8811-6f7de00db3ac + xBot: 71a88843-32b8-4d52-ac25-de2458c47775 + alias: alias + lastDigits: "5674" + ovpasNumber: OV34568 + tokenStatus: + tokenStatusId: 2 + name: Active + expirationDate: "2024-04-20T17:05:52.000+02:00" + replacedByTokenId: 2 auditTrails: - - auditTrailId: 1 - customerProfileId: 1 - action: insert - user: user - timestamp: "2023-10-20T17:05:52.000+02:00" - correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 + - auditTrailId: 1 + customerProfileId: 1 + action: insert + user: user + timestamp: "2023-10-20T17:05:52.000+02:00" + correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 _links: { - "self":{ - "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1", - "method": "GET" - } + "self": + { + "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1", + "method": "GET", + }, } _links: - { - "self":{ + { + "self": + { "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers", - "method": "GET" - } - } + "method": "GET", + }, + } getCustomerBlocked: summary: getCustomerBlocked description: >- @@ -595,7 +619,7 @@ paths: debtorStatus: debtorStatusId: 2 name: Active - vascustomerNumber: CST005 + vasCustomerNumber: CST005 customerPreference: language: languageId: 1 @@ -615,8 +639,8 @@ paths: toInclusive: null person: birthname: Pieter - surname: De valen - prefix: De + surname: Valen + prefix: de suffix: PhD dateOfBirth: "2002-10-29" emailAddresses: TEST@HTM.NL @@ -659,64 +683,66 @@ paths: name: Work isPreferred: false ovChipcards: - - ovChipCardId: 1 - chipCardNumber: 1234123412341234 - validUntil: "2023-01-01" - alias: alias - - ovChipCardId: 2 - chipCardNumber: 1234123412341235 - validUntil: "2025-01-01" - alias: alias + - ovChipCardId: 1 + chipCardNumber: 1234123412341234 + validUntil: "2023-01-01" + alias: alias + - ovChipCardId: 2 + chipCardNumber: 1234123412341235 + validUntil: "2025-01-01" + alias: alias ovPayTokens: - - ovPayTokenId: 126 - tokenType: - tokenTypeId: 1 - name: EMV - xTat: 0115b0df-db38-4702-8811-6f7de00db3ac - xBot: 71a88843-32b8-4d52-ac25-de2458c47775 - alias: alias - lastDigits: "5678" - ovpasNumber: null - tokenStatus: - tokenStatusId: 2 - name: Active - expirationDate: "2025-04-20T17:05:52.000+02:00" - replacedByTokenId: 1 - - ovPayTokenId: 127 - tokenType: - tokenTypeId: 2 - name: OV-pas physical - xTat: 0115b0df-db38-4702-8811-6f7de00db3ac - xBot: 71a88843-32b8-4d52-ac25-de2458c47775 - alias: alias - lastDigits: "5674" - ovpasNumber: OV34568 - tokenStatus: - tokenStatusId: 2 - name: Active - expirationDate: "2024-04-20T17:05:52.000+02:00" - replacedByTokenId: 2 + - ovPayTokenId: 126 + tokenType: + tokenTypeId: 1 + name: EMV + xTat: 0115b0df-db38-4702-8811-6f7de00db3ac + xBot: 71a88843-32b8-4d52-ac25-de2458c47775 + alias: alias + lastDigits: "5678" + ovpasNumber: null + tokenStatus: + tokenStatusId: 2 + name: Active + expirationDate: "2025-04-20T17:05:52.000+02:00" + replacedByTokenId: 1 + - ovPayTokenId: 127 + tokenType: + tokenTypeId: 2 + name: OV-pas physical + xTat: 0115b0df-db38-4702-8811-6f7de00db3ac + xBot: 71a88843-32b8-4d52-ac25-de2458c47775 + alias: alias + lastDigits: "5674" + ovpasNumber: OV34568 + tokenStatus: + tokenStatusId: 2 + name: Active + expirationDate: "2024-04-20T17:05:52.000+02:00" + replacedByTokenId: 2 auditTrails: - - auditTrailId: 1 - customerProfileId: 1 - action: insert - user: user - timestamp: "2023-10-20T17:05:52.000+02:00" - correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 + - auditTrailId: 1 + customerProfileId: 1 + action: insert + user: user + timestamp: "2023-10-20T17:05:52.000+02:00" + correlationId: 01c6d8b4-1cd3-4f9b-85ea-c9adca53ce95 _links: { - "self":{ - "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1", - "method": "GET" - } + "self": + { + "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers?customerProfileId=1", + "method": "GET", + }, } _links: - { - "self":{ + { + "self": + { "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/customers", - "method": "GET" - } - } + "method": "GET", + }, + } 400: description: Bad Request content: @@ -731,12 +757,12 @@ paths: value: type: https://htm.nl/api/v1/probs/bad-request title: Your request contains an invalid datatype - detail: '''2023-02-01 00:00:00'' is not a valid Datetime' + detail: "'2023-02-01 00:00:00' is not a valid Datetime" instance: urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b security: - default: [] x-auth-type: Application & Application User - x-throttling-tier: Unlimited + x-throttling-tier: Unlimited post: tags: - Customer @@ -748,7 +774,9 @@ paths: - Requested format for postal code: - 0000AA - parameters: [] + - Requested format for country: + - NL + parameters: [] requestBody: content: application/json: @@ -772,7 +800,7 @@ paths: person: birthname: Jan surname: Jansen - prefix: dhr + prefix: de suffix: jr dateOfBirth: "1970-01-01" emailAddress: j.jansen@hatseflats.nl @@ -814,10 +842,11 @@ paths: customerProfileCreated: summary: customerProfileCreated description: >- - Successfully created a customer profile + Successfully created a customer profile value: customerProfileId: 1 customerNumber: 1000001 + debtorNumber: DB100001 400: description: Bad Request content: @@ -832,12 +861,12 @@ paths: value: type: https://htm.nl/api/v1/probs/bad-request title: Your request contains an invalid datatype - detail: '''2023-02-01 00:00:00'' is not a valid Datetime' - instance: urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b + detail: "'2023-02-01 00:00:00' is not a valid Datetime" + instance: urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b security: - default: [] x-auth-type: Application & Application User - x-throttling-tier: Unlimited + x-throttling-tier: Unlimited /customers/{customerProfileId}: patch: tags: @@ -848,7 +877,7 @@ paths: parameters: - name: customerProfileId in: path - required: true + required: true schema: type: integer example: 1 @@ -864,7 +893,7 @@ paths: required: true responses: 201: - description: Successfully modified a customer + description: Successfully modified a customer content: application/json: schema: @@ -879,11 +908,11 @@ paths: - Customer summary: Create a new customer status element description: >- - + parameters: - name: customerProfileId in: path - required: true + required: true schema: type: integer example: 1 @@ -904,22 +933,22 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/postCustomerPreferencesResponse" + $ref: "#/components/schemas/postCustomerStatusResponse" security: - default: [] x-auth-type: Application & Application User - x-throttling-tier: Unlimited + x-throttling-tier: Unlimited /customers/{customerProfileId}/customerPreferences: post: tags: - Customer summary: Create a customer preference element description: >- - + parameters: - name: customerProfileId in: path - required: true + required: true schema: type: integer example: 1 @@ -944,97 +973,97 @@ paths: security: - default: [] x-auth-type: Application & Application User - x-throttling-tier: Unlimited + x-throttling-tier: Unlimited /customerPreferences/{customerPreferenceId}: - patch: - tags: - - Customer - summary: Modify a customer preference element - description: >- - - parameters: - - name: customerPreferenceId - in: path - required: true + patch: + tags: + - Customer + summary: Modify a customer preference element + description: >- + + parameters: + - name: customerPreferenceId + in: path + required: true + schema: + type: integer + example: 1 + requestBody: + content: + application/json: schema: - type: integer - example: 1 - requestBody: + $ref: "#/components/schemas/customerPreferencesEntity" + examples: + customerPreference: + value: + customerPreference: + languageId: 1 + required: true + responses: + 200: + description: Successfully modified a customer preference content: application/json: schema: - $ref: "#/components/schemas/customerPreferencesEntity" - examples: - customerPreference: - value: - customerPreference: - languageId: 1 - required: true - responses: - 200: - description: Successfully modified a customer preference - content: - application/json: - schema: - $ref: "#/components/schemas/patchCustomerPreferencesResponse" - security: - - default: [] - x-auth-type: Application & Application User - x-throttling-tier: Unlimited + $ref: "#/components/schemas/patchCustomerPreferencesResponse" + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /customers/{customerProfileId}/addresses: - post: - tags: - - Customer address - summary: Add a customer address - description: >- - - parameters: - - name: customerProfileId - in: path - required: true + post: + tags: + - Customer address + summary: Add a customer address + description: >- + + parameters: + - name: customerProfileId + in: path + required: true + schema: + type: integer + example: 1 + requestBody: + content: + application/json: schema: - type: integer - example: 1 - requestBody: + $ref: "#/components/schemas/postCustomerAddress" + examples: + customerAddress: + value: + customerAddress: + addressTypeId: 1 + street: Sesamstraat + houseNumber: 1 + houseNumberSuffix: A + postalCode: 1234 AB + city: Den Haag + country: NL + isPreferred: true + required: true + responses: + 201: + description: Successfully created a customer address content: application/json: schema: - $ref: "#/components/schemas/postCustomerAddress" - examples: - customerAddress: - value: - customerAddress: - addressTypeId: 1 - street: Sesamstraat - houseNumber: 1 - houseNumberSuffix: A - postalCode: 1234 AB - city: Den Haag - country: NL - isPreferred: true - required: true - responses: - 201: - description: Successfully created a customer address - content: - application/json: - schema: - $ref: "#/components/schemas/postCustomerProfileAddressResponse" - security: - - default: [] - x-auth-type: Application & Application User - x-throttling-tier: Unlimited + $ref: "#/components/schemas/postCustomerProfileAddressResponse" + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /addresses/{addressId}: patch: tags: - Customer address summary: Edit a customer address description: >- - + parameters: - name: addressId in: path - required: true + required: true schema: type: integer example: 2 @@ -1065,11 +1094,11 @@ paths: - Customer address summary: Delete a customer address description: >- - + parameters: - name: addressId in: path - required: true + required: true schema: type: integer example: 2 @@ -1077,62 +1106,61 @@ paths: 200: description: Successfully deleted a customer Address content: - application/json: - {} + application/json: {} security: - default: [] x-auth-type: Application & Application User x-throttling-tier: Unlimited /customers/{customerProfileId}/phones: - post: - tags: - - Customer phoneNumber - summary: Add a customer phonenumber - description: >- - - parameters: - - name: customerProfileId - in: path - required: true + post: + tags: + - Customer phoneNumber + summary: Add a customer phonenumber + description: >- + + parameters: + - name: customerProfileId + in: path + required: true + schema: + type: integer + example: 1 + requestBody: + content: + application/json: schema: - type: integer - example: 1 - requestBody: + $ref: "#/components/schemas/phoneEntity" + examples: + customerPhone: + value: + phone: + number: 0701112233 + countryCode: 0031 + phoneTypeId: 1 + isPreferred: true + required: true + responses: + 201: + description: Successfully created a customer phonenumber content: application/json: schema: - $ref: "#/components/schemas/phoneEntity" - examples: - customerPhone: - value: - phone: - number: 0701112233 - countryCode: 0031 - phoneTypeId: 1 - isPreferred: true - required: true - responses: - 201: - description: Successfully created a customer phonenumber - content: - application/json: - schema: - $ref: "#/components/schemas/postPhoneResponse" - security: - - default: [] - x-auth-type: Application & Application User - x-throttling-tier: Unlimited + $ref: "#/components/schemas/postPhoneResponse" + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /phones/{phoneId}: patch: tags: - Customer phoneNumber summary: Edit a customer phonenumber description: >- - + parameters: - name: phoneId in: path - required: true + required: true schema: type: integer example: 2 @@ -1163,11 +1191,11 @@ paths: - Customer phoneNumber summary: Delete a customer phone description: >- - + parameters: - name: phoneId in: path - required: true + required: true schema: type: integer example: 2 @@ -1175,8 +1203,7 @@ paths: 200: description: Successfully deleted a customer phonenumber content: - application/json: - {} + application/json: {} security: - default: [] x-auth-type: Application & Application User @@ -1278,15 +1305,15 @@ paths: description: The id of the token that replaced this token. - name: sort in: query - schema: + schema: type: string - name: offset in: query - schema: - type: integer + schema: + type: integer - name: limit in: query - schema: + schema: type: integer example: 20 responses: @@ -1314,26 +1341,29 @@ paths: "expirationDate": "2029-03-22T09:00:00", "replacedByTokenId": 12, }, - ], - "_links": + ], + "_links": + { + "self": { - "self":{ "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/ovPayTokens?offset=20", - "method": "GET" + "method": "GET", }, - "prev":{ + "prev": + { "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/ovPayTokens", - "method": "GET" + "method": "GET", }, - "next":{ + "next": + { "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/ovPayTokens?offset=40", - "method": "GET" - } - } + "method": "GET", + }, + }, } /customers/{customerProfileId}/ovpaytokens: post: - tags: + tags: - Ovpay Token summary: Create a new ovpay token description: >- @@ -1341,7 +1371,7 @@ paths: parameters: - name: customerProfileId in: path - required: true + required: true schema: type: integer example: 1 @@ -1384,7 +1414,7 @@ paths: x-throttling-tier: Unlimited /ovpaytokens/{ovpaytokenId}: patch: - tags: + tags: - Ovpay Token summary: Update an ovpay token description: >- @@ -1392,7 +1422,7 @@ paths: parameters: - name: ovpaytokenId in: path - required: true + required: true schema: type: integer example: 1 @@ -1432,11 +1462,11 @@ paths: - Ovpay Token summary: Delete an ovpay token description: >- - + parameters: - name: ovpaytokenId in: path - required: true + required: true schema: type: integer example: 2 @@ -1444,15 +1474,14 @@ paths: 200: description: Successfully deleted a customer ovpaytoken content: - application/json: - {} + application/json: {} security: - default: [] x-auth-type: Application & Application User - x-throttling-tier: Unlimited + x-throttling-tier: Unlimited /customers/{customerProfileId}/ovchipcards: post: - tags: + tags: - Ovchipcard summary: Create a new ovchipcard description: >- @@ -1460,7 +1489,7 @@ paths: parameters: - name: customerProfileId in: path - required: true + required: true schema: type: integer example: 1 @@ -1472,7 +1501,7 @@ paths: examples: ovChipcards: value: - ovChipcard: + ovChipcard: chipCardNumber: 1234123412341234 validUntil: "2027-01-01" alias: Mijn chipkaart @@ -1490,15 +1519,15 @@ paths: x-throttling-tier: Unlimited /ovchipcards/{ovchipcardId}: patch: - tags: - - Ovchipcard + tags: + - Ovchipcard summary: Update an ovchipcard description: >- parameters: - name: ovchipcardId in: path - required: true + required: true schema: type: integer example: 1 @@ -1529,11 +1558,11 @@ paths: - Ovchipcard summary: Delete an ovchipcard description: >- - + parameters: - name: ovchipcardId in: path - required: true + required: true schema: type: integer example: 2 @@ -1541,14 +1570,13 @@ paths: 200: description: Successfully deleted a customer ovchipcard content: - application/json: - {} + application/json: {} security: - default: [] x-auth-type: Application & Application User - x-throttling-tier: Unlimited + x-throttling-tier: Unlimited /billingInformations: - get: + get: tags: - Billing Information summary: Find billing information @@ -1556,33 +1584,33 @@ paths: parameters: - name: customerProfileId - in: query + in: query schema: type: integer example: 1 - name: issuerCountry in: query - schema: + schema: type: string example: "NL" - name: iban in: query - schema: + schema: type: string example: "NL73RABO2677424363" - name: bic in: query - schema: + schema: type: string - example: "GHJZIEJSKVM" + example: "GHJZIEJSKVM" - name: ascription in: query - schema: + schema: type: string example: "J. Doe" - name: alias in: query - schema: + schema: type: string example: "John's billing details" - name: billingAddressID @@ -1592,15 +1620,15 @@ paths: example: 1 - name: sort in: query - schema: + schema: type: string - name: offset in: query - schema: - type: integer + schema: + type: integer - name: limit in: query - schema: + schema: type: integer example: 20 responses: @@ -1615,178 +1643,190 @@ paths: summary: Get multiple billing information entities for a specific customers description: >- Found multiple billing informations matching the search parameters - value: + value: { - "billingInformations":[ - { - "billingInformationId": 1, - "customerProfileId": 1, - "issuerCountry": "NL", - "iban": "NL06RABO8902022560", - "ascription": "J. Doe", - "alias": null, - "billingAddressId": 3 - }, - { - "billingInformationId": 2, - "customerProfileId": 1, - "issuerCountry": "NL", - "iban": "NL27ABNA4458972219", - "bic": "GHJZIEJSKVM", - "ascription": "J. Doe", - "alias": "John's billing details", - "billingAddressId": 4 - } - ] - } + "billingInformations": + [ + { + "billingInformationId": 1, + "customerProfileId": 1, + "issuerCountry": "NL", + "iban": "NL06RABO8902022560", + "ascription": "J. Doe", + "alias": null, + "billingAddressId": 3, + }, + { + "billingInformationId": 2, + "customerProfileId": 1, + "issuerCountry": "NL", + "iban": "NL27ABNA4458972219", + "bic": "GHJZIEJSKVM", + "ascription": "J. Doe", + "alias": "John's billing details", + "billingAddressId": 4, + }, + ], + } getBillingInformationSingleSpecificCustomer: summary: Get singel billing information entity for a specific customers description: >- Found one billing information matching the search parameters - value: + value: { - "billingInformations":[ - { - "billingInformationId": 1, - "customerProfileId": 1, - "issuerCountry": "NL", - "iban": "NL06RABO8902022560", - "ascription": "J. Doe", - "alias": null, - "billingAddressId": 3 - } - ] - } + "billingInformations": + [ + { + "billingInformationId": 1, + "customerProfileId": 1, + "issuerCountry": "NL", + "iban": "NL06RABO8902022560", + "ascription": "J. Doe", + "alias": null, + "billingAddressId": 3, + }, + ], + } getBillingInformationIssuerCountry: summary: Get multiple billing information entities for a specific issuer country description: >- Found multiple billing informations matching the search parameters - value: + value: { - "billingInformations":[ - { - "billingInformationId": 1, - "customerProfileId": 1, - "issuerCountry": "NL", - "iban": "NL06RABO8902022560", - "ascription": "J. Doe", - "alias": null, - "billingAddressId": 3 - }, - { - "billingInformationId": 2, - "customerProfileId": 5, - "issuerCountry": "NL", - "iban": "NL27ABNA4458972219", - "bic": "GHJZIEJSKVM", - "ascription": "J. Doe", - "alias": null, - "billingAddressId": 42 - }, - { - "billingInformationId": 11, - "customerProfileId": 9, - "issuerCountry": "NL", - "iban": "NL27ABNA4458972219", - "bic": "GHJZIEJSKVM", - "ascription": "J. Doe", - "alias": null, - "billingAddressId": 84 - } - ] - } + "billingInformations": + [ + { + "billingInformationId": 1, + "customerProfileId": 1, + "issuerCountry": "NL", + "iban": "NL06RABO8902022560", + "ascription": "J. Doe", + "alias": null, + "billingAddressId": 3, + }, + { + "billingInformationId": 2, + "customerProfileId": 5, + "issuerCountry": "NL", + "iban": "NL27ABNA4458972219", + "bic": "GHJZIEJSKVM", + "ascription": "J. Doe", + "alias": null, + "billingAddressId": 42, + }, + { + "billingInformationId": 11, + "customerProfileId": 9, + "issuerCountry": "NL", + "iban": "NL27ABNA4458972219", + "bic": "GHJZIEJSKVM", + "ascription": "J. Doe", + "alias": null, + "billingAddressId": 84, + }, + ], + } /customers/{customerProfileId}/billingInformations: - post: - tags: - - Billing Information - summary: Add billing information for a customer - description: >- + post: + tags: + - Billing Information + summary: Add billing information for a customer + description: >- - parameters: - - name: customerProfileId - in: path - required: true + parameters: + - name: customerProfileId + in: path + required: true + schema: + type: integer + example: 1 + requestBody: + content: + application/json: schema: - type: integer - example: 1 - requestBody: + $ref: "#/components/schemas/billingInformationEntity" + examples: + customerBillinginformationMandatoryFields: + value: + billingInformation: + issuerCountry: "NL" + iban: "NL73RABO2677424363" + ascription: "J. Doe" + billingAddressId: 1 + customerBillinginformationMandatoryFull: + value: + billingInformation: + issuerCountry: "NL" + iban: "NL73RABO2677424363" + bic: "GHJZIEJSKVM" + ascription: "J. Doe" + alias: "John's billing details" + billingAddressId: 1 + required: true + responses: + 201: + description: Successfully created a customer billingInformation content: application/json: schema: - $ref: "#/components/schemas/billingInformationEntity" - examples: - customerBillinginformationMandatoryFields: - value: - billingInformation: - issuerCountry: "NL" - iban: "NL73RABO2677424363" - ascription: "J. Doe" - billingAddressId: 1 - customerBillinginformationMandatoryFull: - value: - billingInformation: - issuerCountry: "NL" - iban: "NL73RABO2677424363" - bic: "GHJZIEJSKVM" - ascription: "J. Doe" - alias: "John's billing details" - billingAddressId: 1 - required: true - responses: - 201: - description: Successfully created a customer billingInformation - content: - application/json: - schema: - $ref: "#/components/schemas/postBillingInformationResponse" - security: - - default: [] - x-auth-type: Application & Application User - x-throttling-tier: Unlimited + $ref: "#/components/schemas/postBillingInformationResponse" + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /billingInformations/{billingInformationId}: patch: - tags: - - Billing Information - summary: Update a billing information - description: >- - - parameters: - - name: billingInformationId - in: path - required: true + tags: + - Billing Information + summary: Update a billing information + description: >- + + parameters: + - name: billingInformationId + in: path + required: true + schema: + type: integer + example: 1 + requestBody: + content: + application/json: schema: - type: integer - example: 1 - requestBody: + $ref: "#/components/schemas/billingInformationEntity" + examples: + updateBillingInformationAlias: + value: + billingInformation: + alias: "Mijn rekening details" + updateBillingInformationAdressId: + value: + billingInformation: + billingAddressId: 4 + updateBillingInformation: + value: + billingInformation: + alias: "Mijn rekening details" + billingAddressId: 4 + required: true + responses: + 200: + description: Successfully updated a customer billing information content: application/json: - schema: - $ref: "#/components/schemas/billingInformationEntity" - examples: - updateBillingInformationAlias: - value: - billingInformation: - alias: "Mijn rekening details" - updateBillingInformationAdressId: - value: - billingInformation: - billingAddressId: 4 - updateBillingInformation: - value: - billingInformation: - alias: "Mijn rekening details" - billingAddressId: 4 - required: true - responses: - 200: - description: Successfully updated a customer billing information - content: - application/json: - {} - security: - - default: [] - x-auth-type: Application & Application User - x-throttling-tier: Unlimited + example: + { + "billingInformationId": 1, + "customerProfileId": 1, + "issuerCountry": "NL", + "iban": "NL06RABO8902022560", + "ascription": "J. Doe", + "alias": "Mijn rekening details", + "billingAddressId": 4, + } + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /directdebitmandates: get: tags: @@ -1883,15 +1923,15 @@ paths: description: Filter on updated after. - name: sort in: query - schema: + schema: type: string - name: offset in: query - schema: - type: integer + schema: + type: integer - name: limit in: query - schema: + schema: type: integer example: 20 responses: @@ -1905,146 +1945,170 @@ paths: getDirectDebitMandateWithNextPage: value: { - "directDebitMandates": [ + "directDebitMandates": + [ + { + "directDebitMandateId": 71, + "customerProfileId": 12, + "billingInformationId": 51, + "directDebitMandateType": + { + "directDebitMandateTypeId": 1, + "name": "import", + "description": "import", + }, + "mandateAddressId": 21, + "created": "2024-03-22T08:55:00", + "mandateReference": "CORE01", + "mandateState": "SINGED", + "updateTimestamp": "2024-03-22T08:55:00", + }, + ], + "_links": { - "directDebitMandateId": 71, - "customerProfileId": 12, - "billingInformationId": 51, - "directDebitMandateType": + "self": { - "directDebitMandateTypeId": 1, - "name": "import", - "description": "import", + "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates", + "method": "GET", + }, + "next": + { + "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=20", + "method": "GET", }, - "mandateAddressId": 21, - "created": "2024-03-22T08:55:00", - "mandateReference": "CORE01", - "mandateState": "SINGED", - "updateTimestamp": "2024-03-22T08:55:00", - } - ], - "_links": { - "self":{ - "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates", - "method": "GET" }, - "next":{ - "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=20", - "method": "GET" - } - } } getDirectDebitMandateWithNextPageandPreviousPage: value: { - "directDebitMandates": [ + "directDebitMandates": + [ + { + "directDebitMandateId": 71, + "customerProfileId": 12, + "billingInformationId": 51, + "directDebitMandateType": + { + "directDebitMandateTypeId": 1, + "name": "import", + "description": "import", + }, + "mandateAddressId": 21, + "created": "2024-03-22T08:55:00", + "mandateReference": "CORE01", + "mandateState": "SINGED", + "updateTimestamp": "2024-03-22T08:55:00", + }, + ], + "_links": { - "directDebitMandateId": 71, - "customerProfileId": 12, - "billingInformationId": 51, - "directDebitMandateType": + "self": { - "directDebitMandateTypeId": 1, - "name": "import", - "description": "import", + "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=20", + "method": "GET", + }, + "prev": + { + "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates", + "method": "GET", + }, + "next": + { + "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=40", + "method": "GET", }, - "mandateAddressId": 21, - "created": "2024-03-22T08:55:00", - "mandateReference": "CORE01", - "mandateState": "SINGED", - "updateTimestamp": "2024-03-22T08:55:00", - } - ], - "_links": { - "self":{ - "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=20", - "method": "GET" }, - "prev":{ - "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates", - "method": "GET" - }, - "next":{ - "href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/directdebitmandates?offset=40", - "method": "GET" - } - } } /billingInformation/{billingInformationId}/directdebitmandates: - post: - tags: - - Mandates - summary: Add a customer direct debit mandate - description: >- - - parameters: - - name: billingInformationId - in: path - required: true + post: + tags: + - Mandates + summary: Add a customer direct debit mandate + description: >- + + parameters: + - name: billingInformationId + in: path + required: true + schema: + type: integer + example: 1 + requestBody: + content: + application/json: schema: - type: integer - example: 1 - requestBody: + $ref: "#/components/schemas/mandateEntity" + examples: + customerDirectDebitMandatePrepared: + value: + directDebitMandate: + directDebitMandateTypeId: 1 + mandateAddressId: 1 + mandateReference: HTM-mandate-001 + mandateState: PREPARED + required: true + responses: + 201: + description: Successfully created a customer mandate content: application/json: schema: - $ref: "#/components/schemas/mandateEntity" - examples: - customerDirectDebitMandatePrepared: - value: - directDebitMandate: - directDebitMandateTypeId: 1 - mandateAddressId: 1 - mandateReference: HTM-mandate-001 - mandateState: PREPARED - required: true - responses: - 201: - description: Successfully created a customer mandate - content: - application/json: - schema: - $ref: "#/components/schemas/postDirectDebitMandateResponse" - security: - - default: [] - x-auth-type: Application & Application User - x-throttling-tier: Unlimited + $ref: "#/components/schemas/postDirectDebitMandateResponse" + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited /directdebitmandates/{directdebitmandateId}: patch: - tags: - - Mandates - summary: Update a customer direct debit mandate - description: >- - - parameters: - - name: directdebitmandateId - in: path - required: true + tags: + - Mandates + summary: Update a customer direct debit mandate + description: >- + + parameters: + - name: directdebitmandateId + in: path + required: true + schema: + type: integer + example: 1 + requestBody: + content: + application/json: schema: - type: integer - example: 1 - requestBody: + $ref: "#/components/schemas/mandateEntity" + examples: + customerDirectDebitMandateCancelled: + value: + directDebitMandate: + mandateState: CANCELLED + required: true + responses: + 200: + description: Successfully updated a customer mandate content: application/json: - schema: - $ref: "#/components/schemas/mandateEntity" - examples: - customerDirectDebitMandatePrepared: - value: - directDebitMandate: - mandateState: CANCELLED - required: true - responses: - 200: - description: Successfully updated a customer mandate - content: - application/json: - {} - security: - - default: [] - x-auth-type: Application & Application User - x-throttling-tier: Unlimited - + example: + { + "directDebitMandateId": 1, + "customerProfileId": 12, + "billingInformationId": 51, + "directDebitMandateType": + { + "directDebitMandateTypeId": 1, + "name": "import", + "description": "import", + }, + "mandateAddressId": 21, + "created": "2024-03-22T08:55:00", + "mandateReference": "CORE01", + "mandateState": "CANCELLED", + "updateTimestamp": "2025-03-22T08:55:00", + } + security: + - default: [] + x-auth-type: Application & Application User + x-throttling-tier: Unlimited components: securitySchemes: default: @@ -2134,16 +2198,16 @@ components: alias: type: string getCustomerStatusInstance: - type: object - properties: - customerStatus: - $ref: "#/components/schemas/getCustomerStatus" - fromInclusive: - type: string - format: date - toInclusive: - type: string - format: date + type: object + properties: + customerStatus: + $ref: "#/components/schemas/getCustomerStatus" + fromInclusive: + type: string + format: date + toInclusive: + type: string + format: date getCustomerStatus: type: object properties: @@ -2163,12 +2227,16 @@ components: properties: birthname: type: string + description: voornaam surname: type: string + description: achternaam prefix: type: string + description: tussenvoegsel suffix: type: string + description: achtervoegsel dateOfBirth: type: string format: date @@ -2235,7 +2303,7 @@ components: type: object properties: language: - $ref: "#/components/schemas/getCustomerLanguage" + $ref: "#/components/schemas/getCustomerLanguage" getCustomerLanguage: type: object properties: @@ -2263,7 +2331,7 @@ components: type: integer debtorStatus: $ref: "#/components/schemas/getDebtorStatus" - vascustomerNumber: + vasCustomerNumber: type: integer customerPreference: $ref: "#/components/schemas/getCustomerPreference" @@ -2326,7 +2394,7 @@ components: type: integer isPreferred: type: boolean - phoneEntity: + phoneEntity: type: object properties: number: @@ -2349,17 +2417,17 @@ components: debtorStatusId: type: integer customerPreference: - $ref: '#/components/schemas/customerPreferencesEntity' + $ref: "#/components/schemas/customerPreferencesEntity" person: - $ref: '#/components/schemas/personEntity' + $ref: "#/components/schemas/personEntity" addresses: type: array items: - $ref: '#/components/schemas/addressPostEntity' + $ref: "#/components/schemas/addressPostEntity" phones: type: array items: - $ref: '#/components/schemas/postPhoneEntity' + $ref: "#/components/schemas/postPhoneEntity" postCustomerAddress: type: object properties: @@ -2403,7 +2471,7 @@ components: properties: customerNumber: type: integer - example: 10000001 + example: 10000001 customerProfileId: type: integer example: 1 @@ -2480,44 +2548,44 @@ components: customerPreferenceId: type: integer languageId: - type: integer + type: integer customerStatusEntity: type: object properties: customerStatusId: - type: integer + type: integer customersEntity: type: object properties: debtorStatusId: - type: integer + type: integer billingInformationEntity: type: object properties: - billingInformationId: + billingInformationId: type: integer issuerCountry: type: string iban: type: string - bic: + bic: type: string ascription: type: string - alias: + alias: type: string billingAddressId: type: integer mandateEntity: type: object properties: - directDebitMandateId: + directDebitMandateId: type: integer - directDebitMandateTypeId: - type: integer - mandateAddressId: - type: integer - mandateReference: + directDebitMandateTypeId: + type: integer + mandateAddressId: + type: integer + mandateReference: type: string mandateState: type: string @@ -2525,8 +2593,8 @@ components: type: object properties: ovPayTokenId: - type: integer - tokenType: + type: integer + tokenType: type: object properties: tokenTypeId: @@ -2565,7 +2633,7 @@ components: type: string format: date alias: - type: string + type: string personEntity: type: object properties: @@ -2573,17 +2641,21 @@ components: type: integer birthname: type: string + description: voornaam surname: type: string + description: achternaam prefix: type: string + description: tussenvoegsel suffix: type: string + description: achtervoegsel dateOfBirth: type: string format: date emailAddress: - type: string + type: string postOvPayTokenResponse: type: object properties: @@ -2600,4 +2672,4 @@ components: detail: type: string instance: - type: string \ No newline at end of file + type: string