From 820f15c218fe38bdcec8659107f1ea751ba50357 Mon Sep 17 00:00:00 2001 From: pagopa-github-bot Date: Fri, 7 Feb 2025 11:10:30 +0000 Subject: [PATCH] Bump to version 0.13.1 --- helm/Chart.yaml | 4 +- helm/values-dev.yaml | 2 +- helm/values-prod.yaml | 2 +- helm/values-uat.yaml | 2 +- openapi/openapi_external.json | 2 +- openapi/openapi_external_massive.json | 2 +- openapi/openapi_external_v3.json | 2393 +++++++++++++------------ openapi/openapi_internal.json | 2 +- openapi/openapi_internal_massive.json | 2 +- openapi/openapi_send.json | 1157 ++++++------ pom.xml | 2 +- 11 files changed, 1901 insertions(+), 1669 deletions(-) diff --git a/helm/Chart.yaml b/helm/Chart.yaml index 048a9042..d1f0c757 100644 --- a/helm/Chart.yaml +++ b/helm/Chart.yaml @@ -2,8 +2,8 @@ apiVersion: v2 name: pagopa-gpd-core description: micro-service to manage Creditor Institution debtor positions type: application -version: 0.198.0 -appVersion: 0.13.0-1-PIDM-35-optimize-transfer-iban-update +version: 0.199.0 +appVersion: 0.13.1 dependencies: - name: microservice-chart version: 5.11.0 diff --git a/helm/values-dev.yaml b/helm/values-dev.yaml index 6e946b97..8ef2f43a 100644 --- a/helm/values-dev.yaml +++ b/helm/values-dev.yaml @@ -4,7 +4,7 @@ microservice-chart: fullnameOverride: "" image: repository: ghcr.io/pagopa/pagopa-debt-position - tag: "0.13.0-1-PIDM-35-optimize-transfer-iban-update" + tag: "0.13.1" pullPolicy: Always livenessProbe: httpGet: diff --git a/helm/values-prod.yaml b/helm/values-prod.yaml index 7796002c..1e836ab9 100644 --- a/helm/values-prod.yaml +++ b/helm/values-prod.yaml @@ -4,7 +4,7 @@ microservice-chart: fullnameOverride: "" image: repository: ghcr.io/pagopa/pagopa-debt-position - tag: "0.13.0-1-PIDM-35-optimize-transfer-iban-update" + tag: "0.13.1" pullPolicy: Always livenessProbe: httpGet: diff --git a/helm/values-uat.yaml b/helm/values-uat.yaml index 8f833579..01fcb75f 100644 --- a/helm/values-uat.yaml +++ b/helm/values-uat.yaml @@ -4,7 +4,7 @@ microservice-chart: fullnameOverride: "" image: repository: ghcr.io/pagopa/pagopa-debt-position - tag: "0.13.0-1-PIDM-35-optimize-transfer-iban-update" + tag: "0.13.1" pullPolicy: Always livenessProbe: httpGet: diff --git a/openapi/openapi_external.json b/openapi/openapi_external.json index 6fd01c28..3bf7b6a1 100644 --- a/openapi/openapi_external.json +++ b/openapi/openapi_external.json @@ -4,7 +4,7 @@ "title": "PagoPA API Debt Position", "description": "Progetto Gestione Posizioni Debitorie", "termsOfService": "https://www.pagopa.gov.it/", - "version": "0.13.0-1-PIDM-35-optimize-transfer-iban-update" + "version": "0.13.1" }, "servers": [ { diff --git a/openapi/openapi_external_massive.json b/openapi/openapi_external_massive.json index cbaff3e1..ba4e26ed 100644 --- a/openapi/openapi_external_massive.json +++ b/openapi/openapi_external_massive.json @@ -4,7 +4,7 @@ "title": "PagoPA API Debt Position", "description": "Progetto Gestione Posizioni Debitorie", "termsOfService": "https://www.pagopa.gov.it/", - "version": "0.13.0-1-PIDM-35-optimize-transfer-iban-update" + "version": "0.13.1" }, "servers": [ { diff --git a/openapi/openapi_external_v3.json b/openapi/openapi_external_v3.json index 614e4cdf..a4640512 100644 --- a/openapi/openapi_external_v3.json +++ b/openapi/openapi_external_v3.json @@ -1,1413 +1,1578 @@ { - "openapi" : "3.0.1", - "info" : { - "title" : "PagoPA API Debt Position", - "description" : "Progetto Gestione Posizioni Debitorie", - "termsOfService" : "https://www.pagopa.gov.it/", - "version" : "0.13.0-1-PIDM-35-optimize-transfer-iban-update" + "openapi": "3.0.1", + "info": { + "title": "PagoPA API Debt Position", + "description": "Progetto Gestione Posizioni Debitorie", + "termsOfService": "https://www.pagopa.gov.it/", + "version": "0.13.1" }, - "servers" : [ { - "url" : "https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v1/", - "description" : "GPD Test environment" - }, { - "url" : "https://api.platform.pagopa.it/gpd/debt-positions-service/v1/", - "description" : "GPD Production Environment" - }, { - "url" : "https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v3/", - "description" : "GPD Test environment" - }, { - "url" : "https://api.platform.pagopa.it/gpd/debt-positions-service/v3/", - "description" : "GPD Production Environment" - }, { - "url" : "https://api.uat.platform.pagopa.it/aca/debt-positions-service/v1/", - "description" : "ACA Test environment" - }, { - "url" : "https://api.platform.pagopa.it/aca/debt-positions-service/v1/", - "description" : "ACA Production environment" - } ], - "tags" : [ { - "name" : "Debt Positions API: Installments and Payment Options Manager" - }, { - "name" : "Debt Position Actions API" - } ], - "paths" : { - "/v3/organizations/{organizationfiscalcode}/debtpositions/{iupd}" : { - "get" : { - "tags" : [ "Debt Positions API: Installments and Payment Options Manager" ], - "summary" : "Return the details of a specific debt position.", - "operationId" : "getOrganizationDebtPositionByIUPD", - "parameters" : [ { - "name" : "organizationfiscalcode", - "in" : "path", - "description" : "Organization fiscal code, the fiscal code of the Organization.", - "required" : true, - "schema" : { - "pattern" : "[\\w*\\h-]+", - "type" : "string" - } - }, { - "name" : "iupd", - "in" : "path", - "description" : "IUPD (Unique identifier of the debt position). Format could be `` this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is `true` and if not, notify the EC.", - "required" : true, - "schema" : { - "pattern" : "[\\w*\\h-]+", - "type" : "string" + "servers": [ + { + "url": "https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v1/", + "description": "GPD Test environment" + }, + { + "url": "https://api.platform.pagopa.it/gpd/debt-positions-service/v1/", + "description": "GPD Production Environment" + }, + { + "url": "https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v3/", + "description": "GPD Test environment" + }, + { + "url": "https://api.platform.pagopa.it/gpd/debt-positions-service/v3/", + "description": "GPD Production Environment" + }, + { + "url": "https://api.uat.platform.pagopa.it/aca/debt-positions-service/v1/", + "description": "ACA Test environment" + }, + { + "url": "https://api.platform.pagopa.it/aca/debt-positions-service/v1/", + "description": "ACA Production environment" + } + ], + "tags": [ + { + "name": "Debt Positions API: Installments and Payment Options Manager" + }, + { + "name": "Debt Position Actions API" + } + ], + "paths": { + "/v3/organizations/{organizationfiscalcode}/debtpositions/{iupd}": { + "get": { + "tags": [ + "Debt Positions API: Installments and Payment Options Manager" + ], + "summary": "Return the details of a specific debt position.", + "operationId": "getOrganizationDebtPositionByIUPD", + "parameters": [ + { + "name": "organizationfiscalcode", + "in": "path", + "description": "Organization fiscal code, the fiscal code of the Organization.", + "required": true, + "schema": { + "pattern": "[\\w*\\h-]+", + "type": "string" + } + }, + { + "name": "iupd", + "in": "path", + "description": "IUPD (Unique identifier of the debt position). Format could be `` this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is `true` and if not, notify the EC.", + "required": true, + "schema": { + "pattern": "[\\w*\\h-]+", + "type": "string" + } } - } ], - "responses" : { - "404" : { - "description" : "No debt position found.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + ], + "responses": { + "404": { + "description": "No debt position found.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "500" : { - "description" : "Service unavailable.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "500": { + "description": "Service unavailable.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "401" : { - "description" : "Wrong or missing function key.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Wrong or missing function key.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "200" : { - "description" : "Obtained debt position details.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "200": { + "description": "Obtained debt position details.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentPositionModelResponseV3" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentPositionModelResponseV3" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ] - }, - "put" : { - "tags" : [ "Debt Positions API: Installments and Payment Options Manager" ], - "summary" : "The Organization updates a debt position ", - "operationId" : "updatePosition", - "parameters" : [ { - "name" : "organizationfiscalcode", - "in" : "path", - "description" : "Organization fiscal code, the fiscal code of the Organization.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "iupd", - "in" : "path", - "description" : "IUPD (Unique identifier of the debt position). Format could be `` this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is `true` and if not, notify the EC.", - "required" : true, - "schema" : { - "type" : "string" + "security": [ + { + "ApiKey": [] } - }, { - "name" : "toPublish", - "in" : "query", - "required" : false, - "schema" : { - "type" : "boolean", - "default" : false + ] + }, + "put": { + "tags": [ + "Debt Positions API: Installments and Payment Options Manager" + ], + "summary": "The Organization updates a debt position ", + "operationId": "updatePosition", + "parameters": [ + { + "name": "organizationfiscalcode", + "in": "path", + "description": "Organization fiscal code, the fiscal code of the Organization.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "iupd", + "in": "path", + "description": "IUPD (Unique identifier of the debt position). Format could be `` this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is `true` and if not, notify the EC.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "toPublish", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + } } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentPositionModelV3" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentPositionModelV3" } } }, - "required" : true + "required": true }, - "responses" : { - "404" : { - "description" : "No debt position found.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "responses": { + "404": { + "description": "No debt position found.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "400" : { - "description" : "Malformed request.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "400": { + "description": "Malformed request.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "200" : { - "description" : "Debt Position updated.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "200": { + "description": "Debt Position updated.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentPositionModelV3" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentPositionModelV3" } } } }, - "409" : { - "description" : "Conflict: existing related payment found.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "409": { + "description": "Conflict: existing related payment found.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "500" : { - "description" : "Service unavailable.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "500": { + "description": "Service unavailable.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "401" : { - "description" : "Wrong or missing function key.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Wrong or missing function key.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ] - }, - "delete" : { - "tags" : [ "Debt Positions API: Installments and Payment Options Manager" ], - "summary" : "The Organization deletes a debt position", - "operationId" : "deletePosition", - "parameters" : [ { - "name" : "organizationfiscalcode", - "in" : "path", - "description" : "Organization fiscal code, the fiscal code of the Organization.", - "required" : true, - "schema" : { - "pattern" : "[\\w*\\h-]+", - "type" : "string" + "security": [ + { + "ApiKey": [] } - }, { - "name" : "iupd", - "in" : "path", - "description" : "IUPD (Unique identifier of the debt position). Format could be `` this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is `true` and if not, notify the EC.", - "required" : true, - "schema" : { - "pattern" : "[\\w*\\h-]+", - "type" : "string" + ] + }, + "delete": { + "tags": [ + "Debt Positions API: Installments and Payment Options Manager" + ], + "summary": "The Organization deletes a debt position", + "operationId": "deletePosition", + "parameters": [ + { + "name": "organizationfiscalcode", + "in": "path", + "description": "Organization fiscal code, the fiscal code of the Organization.", + "required": true, + "schema": { + "pattern": "[\\w*\\h-]+", + "type": "string" + } + }, + { + "name": "iupd", + "in": "path", + "description": "IUPD (Unique identifier of the debt position). Format could be `` this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is `true` and if not, notify the EC.", + "required": true, + "schema": { + "pattern": "[\\w*\\h-]+", + "type": "string" + } } - } ], - "responses" : { - "200" : { - "description" : "Operation completed successfully.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "type" : "string" + "content": { + "application/json": { + "schema": { + "type": "string" } } } }, - "404" : { - "description" : "No debt position position found.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "404": { + "description": "No debt position position found.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "409" : { - "description" : "Conflict: existing related payment found.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "409": { + "description": "Conflict: existing related payment found.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "500" : { - "description" : "Service unavailable.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "500": { + "description": "Service unavailable.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "401" : { - "description" : "Wrong or missing function key.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Wrong or missing function key.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ] + "security": [ + { + "ApiKey": [] + } + ] }, - "parameters" : [ { - "name" : "X-Request-Id", - "in" : "header", - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "schema" : { - "type" : "string" + "parameters": [ + { + "name": "X-Request-Id", + "in": "header", + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "schema": { + "type": "string" + } } - } ] + ] }, - "/v3/organizations/{organizationfiscalcode}/debtpositions" : { - "get" : { - "tags" : [ "Debt Positions API: Installments and Payment Options Manager" ], - "summary" : "Return the list of the organization debt positions. The due dates interval is mutually exclusive with the payment dates interval.", - "operationId" : "getOrganizationDebtPositions", - "parameters" : [ { - "name" : "organizationfiscalcode", - "in" : "path", - "description" : "Organization fiscal code, the fiscal code of the Organization.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "limit", - "in" : "query", - "description" : "Number of elements on one page. Default = 50", - "required" : false, - "schema" : { - "maximum" : 50, - "type" : "integer", - "format" : "int32", - "default" : 10 - } - }, { - "name" : "page", - "in" : "query", - "description" : "Page number. Page value starts from 0", - "required" : false, - "schema" : { - "minimum" : 0, - "type" : "integer", - "format" : "int32", - "default" : 0 - } - }, { - "name" : "due_date_from", - "in" : "query", - "description" : "Filter from due_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days before the due_date_to.", - "required" : false, - "schema" : { - "type" : "string", - "format" : "date" - } - }, { - "name" : "due_date_to", - "in" : "query", - "description" : "Filter to due_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days after the due_date_from.", - "required" : false, - "schema" : { - "type" : "string", - "format" : "date" - } - }, { - "name" : "payment_date_from", - "in" : "query", - "description" : "Filter from payment_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days before the payment_date_to.", - "required" : false, - "schema" : { - "type" : "string", - "format" : "date" - } - }, { - "name" : "payment_date_to", - "in" : "query", - "description" : "Filter to payment_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days after the payment_date_from", - "required" : false, - "schema" : { - "type" : "string", - "format" : "date" - } - }, { - "name" : "status", - "in" : "query", - "description" : "Filter by debt position status", - "required" : false, - "schema" : { - "type" : "string", - "enum" : [ "DRAFT", "PUBLISHED", "VALID", "UNPAYABLE", "PARTIALLY_PAID", "PAID" ] - } - }, { - "name" : "orderby", - "in" : "query", - "description" : "Order by INSERTED_DATE, COMPANY_NAME, IUPD or STATUS", - "required" : false, - "schema" : { - "type" : "string", - "default" : "INSERTED_DATE", - "enum" : [ "INSERTED_DATE", "IUPD", "STATUS", "COMPANY_NAME" ] - } - }, { - "name" : "ordering", - "in" : "query", - "description" : "Direction of ordering", - "required" : false, - "schema" : { - "type" : "string", - "default" : "DESC", - "enum" : [ "ASC", "DESC" ] + "/v3/organizations/{organizationfiscalcode}/debtpositions": { + "get": { + "tags": [ + "Debt Positions API: Installments and Payment Options Manager" + ], + "summary": "Return the list of the organization debt positions. The due dates interval is mutually exclusive with the payment dates interval.", + "operationId": "getOrganizationDebtPositions", + "parameters": [ + { + "name": "organizationfiscalcode", + "in": "path", + "description": "Organization fiscal code, the fiscal code of the Organization.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Number of elements on one page. Default = 50", + "required": false, + "schema": { + "maximum": 50, + "type": "integer", + "format": "int32", + "default": 10 + } + }, + { + "name": "page", + "in": "query", + "description": "Page number. Page value starts from 0", + "required": false, + "schema": { + "minimum": 0, + "type": "integer", + "format": "int32", + "default": 0 + } + }, + { + "name": "due_date_from", + "in": "query", + "description": "Filter from due_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days before the due_date_to.", + "required": false, + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "due_date_to", + "in": "query", + "description": "Filter to due_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days after the due_date_from.", + "required": false, + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "payment_date_from", + "in": "query", + "description": "Filter from payment_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days before the payment_date_to.", + "required": false, + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "payment_date_to", + "in": "query", + "description": "Filter to payment_date (if provided use the format yyyy-MM-dd). If not provided will be set to 30 days after the payment_date_from", + "required": false, + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "status", + "in": "query", + "description": "Filter by debt position status", + "required": false, + "schema": { + "type": "string", + "enum": [ + "DRAFT", + "PUBLISHED", + "VALID", + "UNPAYABLE", + "PARTIALLY_PAID", + "PAID" + ] + } + }, + { + "name": "orderby", + "in": "query", + "description": "Order by INSERTED_DATE, COMPANY_NAME, IUPD or STATUS", + "required": false, + "schema": { + "type": "string", + "default": "INSERTED_DATE", + "enum": [ + "INSERTED_DATE", + "IUPD", + "STATUS", + "COMPANY_NAME" + ] + } + }, + { + "name": "ordering", + "in": "query", + "description": "Direction of ordering", + "required": false, + "schema": { + "type": "string", + "default": "DESC", + "enum": [ + "ASC", + "DESC" + ] + } } - } ], - "responses" : { - "429" : { - "description" : "Too many requests.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + ], + "responses": { + "429": { + "description": "Too many requests.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "400" : { - "description" : "Malformed request.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "400": { + "description": "Malformed request.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "500" : { - "description" : "Service unavailable.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "500": { + "description": "Service unavailable.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "200" : { - "description" : "Obtained all organization payment positions.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "200": { + "description": "Obtained all organization payment positions.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentPositionsInfoV3" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentPositionsInfoV3" } } } }, - "401" : { - "description" : "Wrong or missing function key.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Wrong or missing function key.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ] - }, - "post" : { - "tags" : [ "Debt Positions API: Installments and Payment Options Manager" ], - "summary" : "The Organization creates a debt Position.", - "operationId" : "createPosition", - "parameters" : [ { - "name" : "organizationfiscalcode", - "in" : "path", - "description" : "Organization fiscal code, the fiscal code of the Organization.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "toPublish", - "in" : "query", - "required" : false, - "schema" : { - "type" : "boolean", - "default" : false + "security": [ + { + "ApiKey": [] } - }, { - "name" : "serviceType", - "in" : "query", - "description" : "The field must not be considered as its value is set via the API Management (APIM) policy", - "required" : false, - "schema" : { - "type" : "string", - "default" : "GPD", - "enum" : [ "ACA", "WISP", "GPD" ] + ] + }, + "post": { + "tags": [ + "Debt Positions API: Installments and Payment Options Manager" + ], + "summary": "The Organization creates a debt Position.", + "operationId": "createPosition", + "parameters": [ + { + "name": "organizationfiscalcode", + "in": "path", + "description": "Organization fiscal code, the fiscal code of the Organization.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "toPublish", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + { + "name": "serviceType", + "in": "query", + "description": "The field must not be considered as its value is set via the API Management (APIM) policy", + "required": false, + "schema": { + "type": "string", + "default": "GPD", + "enum": [ + "ACA", + "WISP", + "GPD" + ] + } } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentPositionModelV3" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentPositionModelV3" } } }, - "required" : true + "required": true }, - "responses" : { - "400" : { - "description" : "Malformed request.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "responses": { + "400": { + "description": "Malformed request.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "500" : { - "description" : "Service unavailable.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "500": { + "description": "Service unavailable.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "201" : { - "description" : "Request created.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "201": { + "description": "Request created.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentPositionModelV3" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentPositionModelV3" } } } }, - "401" : { - "description" : "Wrong or missing function key.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Wrong or missing function key.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "409" : { - "description" : "Conflict: duplicate debt position found.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "409": { + "description": "Conflict: duplicate debt position found.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ] + "security": [ + { + "ApiKey": [] + } + ] }, - "parameters" : [ { - "name" : "X-Request-Id", - "in" : "header", - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "schema" : { - "type" : "string" + "parameters": [ + { + "name": "X-Request-Id", + "in": "header", + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "schema": { + "type": "string" + } } - } ] + ] }, - "/v3/organizations/{organizationfiscalcode}/debtpositions/{iupd}/publish" : { - "post" : { - "tags" : [ "Debt Position Actions API" ], - "summary" : "The Organization publish a debt Position.", - "operationId" : "publishPosition", - "parameters" : [ { - "name" : "organizationfiscalcode", - "in" : "path", - "description" : "Organization fiscal code, the fiscal code of the Organization.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "iupd", - "in" : "path", - "description" : "IUPD (Unique identifier of the debt position). Format could be `` this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is `true` and if not, notify the EC.", - "required" : true, - "schema" : { - "type" : "string" + "/v3/organizations/{organizationfiscalcode}/debtpositions/{iupd}/publish": { + "post": { + "tags": [ + "Debt Position Actions API" + ], + "summary": "The Organization publish a debt Position.", + "operationId": "publishPosition", + "parameters": [ + { + "name": "organizationfiscalcode", + "in": "path", + "description": "Organization fiscal code, the fiscal code of the Organization.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "iupd", + "in": "path", + "description": "IUPD (Unique identifier of the debt position). Format could be `` this would make it unique within the new PD management system. It's the responsibility of the EC to guarantee uniqueness. The pagoPa system shall verify that this is `true` and if not, notify the EC.", + "required": true, + "schema": { + "type": "string" + } } - } ], - "responses" : { - "404" : { - "description" : "No debt position found.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + ], + "responses": { + "404": { + "description": "No debt position found.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "409" : { - "description" : "Conflict: debt position is not in publishable state.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "409": { + "description": "Conflict: debt position is not in publishable state.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "500" : { - "description" : "Service unavailable.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "500": { + "description": "Service unavailable.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "200" : { - "description" : "Request published.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "200": { + "description": "Request published.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentPositionModelV3" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentPositionModelV3" } } } }, - "401" : { - "description" : "Wrong or missing function key.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Wrong or missing function key.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - } ] + "security": [ + { + "ApiKey": [] + } + ] }, - "parameters" : [ { - "name" : "X-Request-Id", - "in" : "header", - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "schema" : { - "type" : "string" + "parameters": [ + { + "name": "X-Request-Id", + "in": "header", + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "schema": { + "type": "string" + } } - } ] + ] } }, - "components" : { - "schemas" : { - "DebtorModel" : { - "required" : [ "fiscalCode", "fullName", "type" ], - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "enum" : [ "F", "G" ] - }, - "fiscalCode" : { - "type" : "string" - }, - "fullName" : { - "type" : "string" - }, - "streetName" : { - "type" : "string" - }, - "civicNumber" : { - "type" : "string" - }, - "postalCode" : { - "type" : "string" - }, - "city" : { - "type" : "string" - }, - "province" : { - "type" : "string" - }, - "region" : { - "type" : "string" - }, - "country" : { - "pattern" : "[A-Z]{2}", - "type" : "string", - "example" : "IT" - }, - "email" : { - "type" : "string", - "example" : "email@domain.com" - }, - "phone" : { - "type" : "string" + "components": { + "schemas": { + "DebtorModel": { + "required": [ + "fiscalCode", + "fullName", + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "F", + "G" + ] + }, + "fiscalCode": { + "type": "string" + }, + "fullName": { + "type": "string" + }, + "streetName": { + "type": "string" + }, + "civicNumber": { + "type": "string" + }, + "postalCode": { + "type": "string" + }, + "city": { + "type": "string" + }, + "province": { + "type": "string" + }, + "region": { + "type": "string" + }, + "country": { + "pattern": "[A-Z]{2}", + "type": "string", + "example": "IT" + }, + "email": { + "type": "string", + "example": "email@domain.com" + }, + "phone": { + "type": "string" } } }, - "InstallmentMetadataModel" : { - "required" : [ "key" ], - "type" : "object", - "properties" : { - "key" : { - "type" : "string" - }, - "value" : { - "type" : "string" + "InstallmentMetadataModel": { + "required": [ + "key" + ], + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" } } }, - "InstallmentModel" : { - "required" : [ "amount", "description", "dueDate", "iuv" ], - "type" : "object", - "properties" : { - "nav" : { - "type" : "string" - }, - "iuv" : { - "type" : "string" - }, - "amount" : { - "type" : "integer", - "format" : "int64" - }, - "description" : { - "maxLength" : 140, - "minLength" : 0, - "type" : "string" - }, - "dueDate" : { - "type" : "string", - "format" : "date-time" - }, - "fee" : { - "type" : "integer", - "format" : "int64", - "readOnly" : true - }, - "notificationFee" : { - "type" : "integer", - "format" : "int64", - "readOnly" : true - }, - "status" : { - "type" : "string", - "readOnly" : true, - "enum" : [ "UNPAID", "PAID", "PARTIALLY_REPORTED", "REPORTED", "UNPAYABLE", "EXPIRED" ] - }, - "transfer" : { - "maxItems" : 2147483647, - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/TransferModel" - } - }, - "installmentMetadata" : { - "maxItems" : 10, - "minItems" : 0, - "type" : "array", - "description" : "it can added a maximum of 10 key-value pairs for metadata", - "items" : { - "$ref" : "#/components/schemas/InstallmentMetadataModel" + "InstallmentModel": { + "required": [ + "amount", + "description", + "dueDate", + "iuv" + ], + "type": "object", + "properties": { + "nav": { + "type": "string" + }, + "iuv": { + "type": "string" + }, + "amount": { + "type": "integer", + "format": "int64" + }, + "description": { + "maxLength": 140, + "minLength": 0, + "type": "string" + }, + "dueDate": { + "type": "string", + "format": "date-time" + }, + "fee": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "notificationFee": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "status": { + "type": "string", + "readOnly": true, + "enum": [ + "UNPAID", + "PAID", + "PARTIALLY_REPORTED", + "REPORTED", + "UNPAYABLE", + "EXPIRED" + ] + }, + "transfer": { + "maxItems": 2147483647, + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/TransferModel" + } + }, + "installmentMetadata": { + "maxItems": 10, + "minItems": 0, + "type": "array", + "description": "it can added a maximum of 10 key-value pairs for metadata", + "items": { + "$ref": "#/components/schemas/InstallmentMetadataModel" } } } }, - "PaymentOptionModelV3" : { - "required" : [ "debtor", "installments", "switchToExpired" ], - "type" : "object", - "properties" : { - "description" : { - "maxLength" : 140, - "minLength" : 0, - "type" : "string", - "writeOnly" : true - }, - "validityDate" : { - "type" : "string", - "format" : "date-time" - }, - "retentionDate" : { - "type" : "string", - "format" : "date-time" - }, - "switchToExpired" : { - "type" : "boolean", - "description" : "feature flag to enable the payment option to expire after the due date", - "example" : false, - "default" : false - }, - "debtor" : { - "$ref" : "#/components/schemas/DebtorModel" - }, - "installments" : { - "maxItems" : 100, - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/InstallmentModel" + "PaymentOptionModelV3": { + "required": [ + "debtor", + "installments", + "switchToExpired" + ], + "type": "object", + "properties": { + "description": { + "maxLength": 140, + "minLength": 0, + "type": "string", + "writeOnly": true + }, + "validityDate": { + "type": "string", + "format": "date-time" + }, + "retentionDate": { + "type": "string", + "format": "date-time" + }, + "switchToExpired": { + "type": "boolean", + "description": "feature flag to enable the payment option to expire after the due date", + "example": false, + "default": false + }, + "debtor": { + "$ref": "#/components/schemas/DebtorModel" + }, + "installments": { + "maxItems": 100, + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/InstallmentModel" } } } }, - "PaymentPositionModelV3" : { - "required" : [ "companyName", "iupd", "paymentOption" ], - "type" : "object", - "properties" : { - "iupd" : { - "type" : "string" - }, - "payStandIn" : { - "type" : "boolean", - "description" : "feature flag to enable a debt position in stand-in mode", - "example" : true, - "default" : true - }, - "companyName" : { - "maxLength" : 140, - "minLength" : 0, - "type" : "string" - }, - "officeName" : { - "maxLength" : 140, - "minLength" : 0, - "type" : "string" - }, - "paymentDate" : { - "type" : "string", - "format" : "date-time", - "readOnly" : true - }, - "status" : { - "type" : "string", - "readOnly" : true, - "enum" : [ "DRAFT", "PUBLISHED", "VALID", "UNPAYABLE", "PARTIALLY_PAID", "PAID" ] - }, - "paymentOption" : { - "maxItems" : 100, - "minItems" : 1, - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PaymentOptionModelV3" + "PaymentPositionModelV3": { + "required": [ + "companyName", + "iupd", + "paymentOption" + ], + "type": "object", + "properties": { + "iupd": { + "type": "string" + }, + "payStandIn": { + "type": "boolean", + "description": "feature flag to enable a debt position in stand-in mode", + "example": true, + "default": true + }, + "companyName": { + "maxLength": 140, + "minLength": 0, + "type": "string" + }, + "officeName": { + "maxLength": 140, + "minLength": 0, + "type": "string" + }, + "paymentDate": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "status": { + "type": "string", + "readOnly": true, + "enum": [ + "DRAFT", + "PUBLISHED", + "VALID", + "UNPAYABLE", + "PARTIALLY_PAID", + "PAID" + ] + }, + "paymentOption": { + "maxItems": 100, + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentOptionModelV3" } } } }, - "Stamp" : { - "required" : [ "hashDocument", "provincialResidence", "stampType" ], - "type" : "object", - "properties" : { - "hashDocument" : { - "maxLength" : 72, - "minLength" : 0, - "type" : "string", - "description" : "Document hash type is stBase64Binary72 as described in https://github.com/pagopa/pagopa-api." - }, - "stampType" : { - "maxLength" : 2, - "minLength" : 2, - "type" : "string", - "description" : "The type of the stamp" - }, - "provincialResidence" : { - "pattern" : "[A-Z]{2}", - "type" : "string", - "description" : "The provincial of the residence", - "example" : "RM" + "Stamp": { + "required": [ + "hashDocument", + "provincialResidence", + "stampType" + ], + "type": "object", + "properties": { + "hashDocument": { + "maxLength": 72, + "minLength": 0, + "type": "string", + "description": "Document hash type is stBase64Binary72 as described in https://github.com/pagopa/pagopa-api." + }, + "stampType": { + "maxLength": 2, + "minLength": 2, + "type": "string", + "description": "The type of the stamp" + }, + "provincialResidence": { + "pattern": "[A-Z]{2}", + "type": "string", + "description": "The provincial of the residence", + "example": "RM" } } }, - "TransferMetadataModel" : { - "required" : [ "key" ], - "type" : "object", - "properties" : { - "key" : { - "type" : "string" - }, - "value" : { - "type" : "string" + "TransferMetadataModel": { + "required": [ + "key" + ], + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" } }, - "description" : "it can added a maximum of 10 key-value pairs for metadata" + "description": "it can added a maximum of 10 key-value pairs for metadata" }, - "TransferModel" : { - "required" : [ "amount", "category", "idTransfer", "remittanceInformation" ], - "type" : "object", - "properties" : { - "idTransfer" : { - "type" : "string", - "enum" : [ "1", "2", "3", "4", "5" ] - }, - "amount" : { - "type" : "integer", - "format" : "int64" - }, - "organizationFiscalCode" : { - "type" : "string", - "description" : "Fiscal code related to the organization targeted by this transfer.", - "example" : "00000000000" - }, - "remittanceInformation" : { - "maxLength" : 140, - "minLength" : 0, - "type" : "string" - }, - "category" : { - "type" : "string" - }, - "iban" : { - "type" : "string", - "description" : "mutual exclusive with stamp", - "example" : "IT0000000000000000000000000" - }, - "postalIban" : { - "type" : "string", - "description" : "optional - can be combined with iban but not with stamp", - "example" : "IT0000000000000000000000000" - }, - "stamp" : { - "$ref" : "#/components/schemas/Stamp" - }, - "companyName" : { - "maxLength" : 140, - "minLength" : 0, - "type" : "string" - }, - "transferMetadata" : { - "maxItems" : 10, - "minItems" : 0, - "type" : "array", - "description" : "it can added a maximum of 10 key-value pairs for metadata", - "items" : { - "$ref" : "#/components/schemas/TransferMetadataModel" + "TransferModel": { + "required": [ + "amount", + "category", + "idTransfer", + "remittanceInformation" + ], + "type": "object", + "properties": { + "idTransfer": { + "type": "string", + "enum": [ + "1", + "2", + "3", + "4", + "5" + ] + }, + "amount": { + "type": "integer", + "format": "int64" + }, + "organizationFiscalCode": { + "type": "string", + "description": "Fiscal code related to the organization targeted by this transfer.", + "example": "00000000000" + }, + "remittanceInformation": { + "maxLength": 140, + "minLength": 0, + "type": "string" + }, + "category": { + "type": "string" + }, + "iban": { + "type": "string", + "description": "mutual exclusive with stamp", + "example": "IT0000000000000000000000000" + }, + "postalIban": { + "type": "string", + "description": "optional - can be combined with iban but not with stamp", + "example": "IT0000000000000000000000000" + }, + "stamp": { + "$ref": "#/components/schemas/Stamp" + }, + "companyName": { + "maxLength": 140, + "minLength": 0, + "type": "string" + }, + "transferMetadata": { + "maxItems": 10, + "minItems": 0, + "type": "array", + "description": "it can added a maximum of 10 key-value pairs for metadata", + "items": { + "$ref": "#/components/schemas/TransferMetadataModel" } } } }, - "ProblemJson" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" - }, - "status" : { - "maximum" : 600, - "minimum" : 100, - "type" : "integer", - "description" : "The HTTP status code generated by the origin server for this occurrence of the problem.", - "format" : "int32", - "example" : 200 - }, - "detail" : { - "type" : "string", - "description" : "A human readable explanation specific to this occurrence of the problem.", - "example" : "There was an error processing the request" + "ProblemJson": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" + }, + "status": { + "maximum": 600, + "minimum": 100, + "type": "integer", + "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", + "format": "int32", + "example": 200 + }, + "detail": { + "type": "string", + "description": "A human readable explanation specific to this occurrence of the problem.", + "example": "There was an error processing the request" } } }, - "InstallmentModelResponse" : { - "type" : "object", - "properties" : { - "nav" : { - "type" : "string" - }, - "iuv" : { - "type" : "string" - }, - "organizationFiscalCode" : { - "type" : "string" - }, - "amount" : { - "type" : "integer", - "format" : "int64" - }, - "description" : { - "type" : "string" - }, - "dueDate" : { - "type" : "string", - "format" : "date-time" - }, - "paymentDate" : { - "type" : "string", - "format" : "date-time" - }, - "reportingDate" : { - "type" : "string", - "format" : "date-time" - }, - "paymentMethod" : { - "type" : "string" - }, - "pspCompany" : { - "type" : "string" - }, - "fee" : { - "type" : "integer", - "format" : "int64" - }, - "notificationFee" : { - "type" : "integer", - "format" : "int64" - }, - "idReceipt" : { - "type" : "string" - }, - "idFlowReporting" : { - "type" : "string" - }, - "status" : { - "type" : "string", - "enum" : [ "UNPAID", "PAID", "PARTIALLY_REPORTED", "REPORTED", "UNPAYABLE", "EXPIRED" ] - }, - "lastUpdatedDate" : { - "type" : "string", - "format" : "date-time" - }, - "installmentMetadata" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/InstallmentMetadataModel" + "InstallmentModelResponse": { + "type": "object", + "properties": { + "nav": { + "type": "string" + }, + "iuv": { + "type": "string" + }, + "organizationFiscalCode": { + "type": "string" + }, + "amount": { + "type": "integer", + "format": "int64" + }, + "description": { + "type": "string" + }, + "dueDate": { + "type": "string", + "format": "date-time" + }, + "paymentDate": { + "type": "string", + "format": "date-time" + }, + "reportingDate": { + "type": "string", + "format": "date-time" + }, + "paymentMethod": { + "type": "string" + }, + "pspCompany": { + "type": "string" + }, + "fee": { + "type": "integer", + "format": "int64" + }, + "notificationFee": { + "type": "integer", + "format": "int64" + }, + "idReceipt": { + "type": "string" + }, + "idFlowReporting": { + "type": "string" + }, + "status": { + "type": "string", + "enum": [ + "UNPAID", + "PAID", + "PARTIALLY_REPORTED", + "REPORTED", + "UNPAYABLE", + "EXPIRED" + ] + }, + "lastUpdatedDate": { + "type": "string", + "format": "date-time" + }, + "installmentMetadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InstallmentMetadataModel" } }, - "transfer" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/TransferModelResponse" + "transfer": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransferModelResponse" } } } }, - "PageInfo" : { - "required" : [ "items_found", "limit", "page", "total_pages" ], - "type" : "object", - "properties" : { - "page" : { - "type" : "integer", - "description" : "Page number", - "format" : "int32" - }, - "limit" : { - "type" : "integer", - "description" : "Required number of items per page", - "format" : "int32" - }, - "items_found" : { - "type" : "integer", - "description" : "Number of items found. (The last page may have fewer elements than required)", - "format" : "int32" - }, - "total_pages" : { - "type" : "integer", - "description" : "Total number of pages", - "format" : "int32" + "PageInfo": { + "required": [ + "items_found", + "limit", + "page", + "total_pages" + ], + "type": "object", + "properties": { + "page": { + "type": "integer", + "description": "Page number", + "format": "int32" + }, + "limit": { + "type": "integer", + "description": "Required number of items per page", + "format": "int32" + }, + "items_found": { + "type": "integer", + "description": "Number of items found. (The last page may have fewer elements than required)", + "format": "int32" + }, + "total_pages": { + "type": "integer", + "description": "Total number of pages", + "format": "int32" } } }, - "PaymentOptionModelResponseV3" : { - "type" : "object", - "properties" : { - "switchToExpired" : { - "type" : "boolean" - }, - "retentionDate" : { - "type" : "string", - "format" : "date-time" - }, - "insertedDate" : { - "type" : "string", - "format" : "date-time" - }, - "validityDate" : { - "type" : "string", - "format" : "date-time" - }, - "debtor" : { - "$ref" : "#/components/schemas/DebtorModel" - }, - "installments" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/InstallmentModelResponse" + "PaymentOptionModelResponseV3": { + "type": "object", + "properties": { + "switchToExpired": { + "type": "boolean" + }, + "retentionDate": { + "type": "string", + "format": "date-time" + }, + "insertedDate": { + "type": "string", + "format": "date-time" + }, + "validityDate": { + "type": "string", + "format": "date-time" + }, + "debtor": { + "$ref": "#/components/schemas/DebtorModel" + }, + "installments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InstallmentModelResponse" } } } }, - "PaymentPositionModelResponseV3" : { - "type" : "object", - "properties" : { - "iupd" : { - "type" : "string" - }, - "organizationFiscalCode" : { - "type" : "string" - }, - "companyName" : { - "type" : "string" - }, - "officeName" : { - "type" : "string" - }, - "insertedDate" : { - "type" : "string", - "format" : "date-time" - }, - "publishDate" : { - "type" : "string", - "format" : "date-time" - }, - "paymentDate" : { - "type" : "string", - "format" : "date-time" - }, - "status" : { - "type" : "string", - "enum" : [ "DRAFT", "PUBLISHED", "VALID", "UNPAYABLE", "PARTIALLY_PAID", "PAID" ] - }, - "lastUpdatedDate" : { - "type" : "string", - "format" : "date-time" - }, - "paymentOption" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PaymentOptionModelResponseV3" + "PaymentPositionModelResponseV3": { + "type": "object", + "properties": { + "iupd": { + "type": "string" + }, + "organizationFiscalCode": { + "type": "string" + }, + "companyName": { + "type": "string" + }, + "officeName": { + "type": "string" + }, + "insertedDate": { + "type": "string", + "format": "date-time" + }, + "publishDate": { + "type": "string", + "format": "date-time" + }, + "paymentDate": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "DRAFT", + "PUBLISHED", + "VALID", + "UNPAYABLE", + "PARTIALLY_PAID", + "PAID" + ] + }, + "lastUpdatedDate": { + "type": "string", + "format": "date-time" + }, + "paymentOption": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentOptionModelResponseV3" } } } }, - "PaymentPositionsInfoV3" : { - "required" : [ "page_info", "payment_position_list" ], - "type" : "object", - "properties" : { - "payment_position_list" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PaymentPositionModelResponseV3" - } - }, - "page_info" : { - "$ref" : "#/components/schemas/PageInfo" + "PaymentPositionsInfoV3": { + "required": [ + "page_info", + "payment_position_list" + ], + "type": "object", + "properties": { + "payment_position_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentPositionModelResponseV3" + } + }, + "page_info": { + "$ref": "#/components/schemas/PageInfo" } } }, - "TransferMetadataModelResponse" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string" - }, - "value" : { - "type" : "string" + "TransferMetadataModelResponse": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" } } }, - "TransferModelResponse" : { - "type" : "object", - "properties" : { - "organizationFiscalCode" : { - "type" : "string" + "TransferModelResponse": { + "type": "object", + "properties": { + "organizationFiscalCode": { + "type": "string" }, - "companyName" : { - "type" : "string" + "companyName": { + "type": "string" }, - "idTransfer" : { - "type" : "string" + "idTransfer": { + "type": "string" }, - "amount" : { - "type" : "integer", - "format" : "int64" + "amount": { + "type": "integer", + "format": "int64" }, - "remittanceInformation" : { - "type" : "string" + "remittanceInformation": { + "type": "string" }, - "category" : { - "type" : "string" + "category": { + "type": "string" }, - "iban" : { - "type" : "string" + "iban": { + "type": "string" }, - "postalIban" : { - "type" : "string" + "postalIban": { + "type": "string" }, - "stamp" : { - "$ref" : "#/components/schemas/Stamp" + "stamp": { + "$ref": "#/components/schemas/Stamp" }, - "insertedDate" : { - "type" : "string", - "format" : "date-time" + "insertedDate": { + "type": "string", + "format": "date-time" }, - "status" : { - "type" : "string", - "enum" : [ "T_UNREPORTED", "T_REPORTED" ] + "status": { + "type": "string", + "enum": [ + "T_UNREPORTED", + "T_REPORTED" + ] }, - "lastUpdatedDate" : { - "type" : "string", - "format" : "date-time" + "lastUpdatedDate": { + "type": "string", + "format": "date-time" }, - "transferMetadata" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/TransferMetadataModelResponse" + "transferMetadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransferMetadataModelResponse" } } } } }, - "securitySchemes" : { - "ApiKey" : { - "type" : "apiKey", - "description" : "The API key to access this function app.", - "name" : "Ocp-Apim-Subscription-Key", - "in" : "header" + "securitySchemes": { + "ApiKey": { + "type": "apiKey", + "description": "The API key to access this function app.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" }, - "Authorization" : { - "type" : "http", - "description" : "JWT token get after Azure Login", - "scheme" : "bearer", - "bearerFormat" : "JWT" + "Authorization": { + "type": "http", + "description": "JWT token get after Azure Login", + "scheme": "bearer", + "bearerFormat": "JWT" } } } -} \ No newline at end of file +} diff --git a/openapi/openapi_internal.json b/openapi/openapi_internal.json index 08fada0d..e4d1cff8 100644 --- a/openapi/openapi_internal.json +++ b/openapi/openapi_internal.json @@ -4,7 +4,7 @@ "title": "PagoPA API Debt Position", "description": "Progetto Gestione Posizioni Debitorie", "termsOfService": "https://www.pagopa.gov.it/", - "version": "0.13.0-1-PIDM-35-optimize-transfer-iban-update" + "version": "0.13.1" }, "servers": [ { diff --git a/openapi/openapi_internal_massive.json b/openapi/openapi_internal_massive.json index bf36f8cf..aba1e383 100644 --- a/openapi/openapi_internal_massive.json +++ b/openapi/openapi_internal_massive.json @@ -4,7 +4,7 @@ "title": "PagoPA API Debt Position", "description": "Progetto Gestione Posizioni Debitorie", "termsOfService": "https://www.pagopa.gov.it/", - "version": "0.13.0-1-PIDM-35-optimize-transfer-iban-update" + "version": "0.13.1" }, "servers": [ { diff --git a/openapi/openapi_send.json b/openapi/openapi_send.json index 9a40127b..66959601 100644 --- a/openapi/openapi_send.json +++ b/openapi/openapi_send.json @@ -1,766 +1,833 @@ { - "openapi" : "3.0.1", - "info" : { - "title" : "PagoPA API Debt Position", - "description" : "Progetto Gestione Posizioni Debitorie", - "termsOfService" : "https://www.pagopa.gov.it/", - "version" : "0.13.0-1-PIDM-35-optimize-transfer-iban-update" + "openapi": "3.0.1", + "info": { + "title": "PagoPA API Debt Position", + "description": "Progetto Gestione Posizioni Debitorie", + "termsOfService": "https://www.pagopa.gov.it/", + "version": "0.13.1" }, - "servers" : [ { - "url" : "https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v1/", - "description" : "GPD Test environment" - }, { - "url" : "https://api.platform.pagopa.it/gpd/debt-positions-service/v1/", - "description" : "GPD Production Environment" - }, { - "url" : "https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v3/", - "description" : "GPD Test environment" - }, { - "url" : "https://api.platform.pagopa.it/gpd/debt-positions-service/v3/", - "description" : "GPD Production Environment" - }, { - "url" : "https://api.uat.platform.pagopa.it/aca/debt-positions-service/v1/", - "description" : "ACA Test environment" - }, { - "url" : "https://api.platform.pagopa.it/aca/debt-positions-service/v1/", - "description" : "ACA Production environment" - } ], - "tags" : [ { - "name" : "Payments API" - } ], - "paths" : { - "/organizations/{organizationfiscalcode}/paymentoptions/{nav}/notificationfee" : { - "put" : { - "tags" : [ "Payments API" ], - "summary" : "The organization updates the notification fee of a payment option.", - "operationId" : "updateNotificationFee", - "parameters" : [ { - "name" : "organizationfiscalcode", - "in" : "path", - "description" : "Organization fiscal code, the fiscal code of the Organization.", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "nav", - "in" : "path", - "description" : "NAV (notice number) is the unique reference assigned to the payment by a creditor institution.", - "required" : true, - "schema" : { - "type" : "string" + "servers": [ + { + "url": "https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v1/", + "description": "GPD Test environment" + }, + { + "url": "https://api.platform.pagopa.it/gpd/debt-positions-service/v1/", + "description": "GPD Production Environment" + }, + { + "url": "https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v3/", + "description": "GPD Test environment" + }, + { + "url": "https://api.platform.pagopa.it/gpd/debt-positions-service/v3/", + "description": "GPD Production Environment" + }, + { + "url": "https://api.uat.platform.pagopa.it/aca/debt-positions-service/v1/", + "description": "ACA Test environment" + }, + { + "url": "https://api.platform.pagopa.it/aca/debt-positions-service/v1/", + "description": "ACA Production environment" + } + ], + "tags": [ + { + "name": "Payments API" + } + ], + "paths": { + "/organizations/{organizationfiscalcode}/paymentoptions/{nav}/notificationfee": { + "put": { + "tags": [ + "Payments API" + ], + "summary": "The organization updates the notification fee of a payment option.", + "operationId": "updateNotificationFee", + "parameters": [ + { + "name": "organizationfiscalcode", + "in": "path", + "description": "Organization fiscal code, the fiscal code of the Organization.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "nav", + "in": "path", + "description": "NAV (notice number) is the unique reference assigned to the payment by a creditor institution.", + "required": true, + "schema": { + "type": "string" + } } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/NotificationFeeUpdateModel" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationFeeUpdateModel" } } }, - "required" : true + "required": true }, - "responses" : { - "400" : { - "description" : "Malformed request.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "responses": { + "400": { + "description": "Malformed request.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "500" : { - "description" : "Service unavailable.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "500": { + "description": "Service unavailable.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "200" : { - "description" : "Request updated.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "200": { + "description": "Request updated.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentsModelResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentsModelResponse" } } } }, - "209" : { - "description" : "Request updated with a payment in progress.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "209": { + "description": "Request updated with a payment in progress.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentsModelResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentsModelResponse" } } } }, - "401" : { - "description" : "Wrong or missing function key.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Wrong or missing function key.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "422" : { - "description" : "Unprocessable payment option.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "422": { + "description": "Unprocessable payment option.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "404" : { - "description" : "No payment option found.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "404": { + "description": "No payment option found.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } } }, - "security" : [ { - "ApiKey" : [ ] - }, { - "Authorization" : [ ] - } ] + "security": [ + { + "ApiKey": [] + }, + { + "Authorization": [] + } + ] }, - "parameters" : [ { - "name" : "X-Request-Id", - "in" : "header", - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "schema" : { - "type" : "string" + "parameters": [ + { + "name": "X-Request-Id", + "in": "header", + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "schema": { + "type": "string" + } } - } ] + ] }, - "/organizations/{organizationfiscalcode}/paymentoptions/{nav}" : { - "get" : { - "tags" : [ "Payments API" ], - "summary" : "Return the details of a specific payment option.", - "operationId" : "getOrganizationPaymentOptionByNAV", - "parameters" : [ { - "name" : "organizationfiscalcode", - "in" : "path", - "description" : "Organization fiscal code, the fiscal code of the Organization.", - "required" : true, - "schema" : { - "pattern" : "\\d{1,30}", - "type" : "string" - } - }, { - "name" : "nav", - "in" : "path", - "description" : "NAV (notice number) is the unique reference assigned to the payment by a creditor institution.", - "required" : true, - "schema" : { - "pattern" : "^\\d{1,30}$", - "type" : "string" + "/organizations/{organizationfiscalcode}/paymentoptions/{nav}": { + "get": { + "tags": [ + "Payments API" + ], + "summary": "Return the details of a specific payment option.", + "operationId": "getOrganizationPaymentOptionByNAV", + "parameters": [ + { + "name": "organizationfiscalcode", + "in": "path", + "description": "Organization fiscal code, the fiscal code of the Organization.", + "required": true, + "schema": { + "pattern": "\\d{1,30}", + "type": "string" + } + }, + { + "name": "nav", + "in": "path", + "description": "NAV (notice number) is the unique reference assigned to the payment by a creditor institution.", + "required": true, + "schema": { + "pattern": "^\\d{1,30}$", + "type": "string" + } } - } ], - "responses" : { - "200" : { - "description" : "Obtained payment option details.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + ], + "responses": { + "200": { + "description": "Obtained payment option details.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/PaymentsWithDebtorInfoModelResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentsWithDebtorInfoModelResponse" } } } }, - "500" : { - "description" : "Service unavailable.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "500": { + "description": "Service unavailable.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "401" : { - "description" : "Wrong or missing function key.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Wrong or missing function key.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "404" : { - "description" : "No payment option found.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "404": { + "description": "No payment option found.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } } }, - "security" : [ { - "ApiKey" : [ ] - }, { - "Authorization" : [ ] - } ] + "security": [ + { + "ApiKey": [] + }, + { + "Authorization": [] + } + ] }, - "parameters" : [ { - "name" : "X-Request-Id", - "in" : "header", - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "schema" : { - "type" : "string" + "parameters": [ + { + "name": "X-Request-Id", + "in": "header", + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "schema": { + "type": "string" + } } - } ] + ] }, - "/info" : { - "get" : { - "tags" : [ "Home" ], - "summary" : "Return OK if application is started", - "operationId" : "healthCheck", - "responses" : { - "200" : { - "description" : "OK.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "/info": { + "get": { + "tags": [ + "Home" + ], + "summary": "Return OK if application is started", + "operationId": "healthCheck", + "responses": { + "200": { + "description": "OK.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/AppInfo" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppInfo" } } } }, - "500" : { - "description" : "Service unavailable.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "500": { + "description": "Service unavailable.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ProblemJson" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemJson" } } } }, - "403" : { - "description" : "Forbidden.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "403": { + "description": "Forbidden.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } }, - "401" : { - "description" : "Wrong or missing function key.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "401": { + "description": "Wrong or missing function key.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } } } }, - "security" : [ { - "ApiKey" : [ ] - }, { - "Authorization" : [ ] - } ] + "security": [ + { + "ApiKey": [] + }, + { + "Authorization": [] + } + ] }, - "parameters" : [ { - "name" : "X-Request-Id", - "in" : "header", - "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "schema" : { - "type" : "string" + "parameters": [ + { + "name": "X-Request-Id", + "in": "header", + "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "schema": { + "type": "string" + } } - } ] + ] } }, - "components" : { - "schemas" : { - "NotificationFeeUpdateModel" : { - "required" : [ "notificationFee" ], - "type" : "object", - "properties" : { - "notificationFee" : { - "type" : "integer", - "format" : "int64" + "components": { + "schemas": { + "NotificationFeeUpdateModel": { + "required": [ + "notificationFee" + ], + "type": "object", + "properties": { + "notificationFee": { + "type": "integer", + "format": "int64" } } }, - "ProblemJson" : { - "type" : "object", - "properties" : { - "title" : { - "type" : "string", - "description" : "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" - }, - "status" : { - "maximum" : 600, - "minimum" : 100, - "type" : "integer", - "description" : "The HTTP status code generated by the origin server for this occurrence of the problem.", - "format" : "int32", - "example" : 200 - }, - "detail" : { - "type" : "string", - "description" : "A human readable explanation specific to this occurrence of the problem.", - "example" : "There was an error processing the request" + "ProblemJson": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" + }, + "status": { + "maximum": 600, + "minimum": 100, + "type": "integer", + "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", + "format": "int32", + "example": 200 + }, + "detail": { + "type": "string", + "description": "A human readable explanation specific to this occurrence of the problem.", + "example": "There was an error processing the request" } } }, - "PaymentOptionMetadataModelResponse" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string" - }, - "value" : { - "type" : "string" + "PaymentOptionMetadataModelResponse": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" } } }, - "PaymentsModelResponse" : { - "type" : "object", - "properties" : { - "nav" : { - "type" : "string" + "PaymentsModelResponse": { + "type": "object", + "properties": { + "nav": { + "type": "string" }, - "iuv" : { - "type" : "string" + "iuv": { + "type": "string" }, - "organizationFiscalCode" : { - "type" : "string" + "organizationFiscalCode": { + "type": "string" }, - "amount" : { - "type" : "integer", - "format" : "int64" + "amount": { + "type": "integer", + "format": "int64" }, - "description" : { - "type" : "string" + "description": { + "type": "string" }, - "isPartialPayment" : { - "type" : "boolean" + "isPartialPayment": { + "type": "boolean" }, - "dueDate" : { - "type" : "string", - "format" : "date-time" + "dueDate": { + "type": "string", + "format": "date-time" }, - "retentionDate" : { - "type" : "string", - "format" : "date-time" + "retentionDate": { + "type": "string", + "format": "date-time" }, - "paymentDate" : { - "type" : "string", - "format" : "date-time" + "paymentDate": { + "type": "string", + "format": "date-time" }, - "reportingDate" : { - "type" : "string", - "format" : "date-time" + "reportingDate": { + "type": "string", + "format": "date-time" }, - "insertedDate" : { - "type" : "string", - "format" : "date-time" + "insertedDate": { + "type": "string", + "format": "date-time" }, - "paymentMethod" : { - "type" : "string" + "paymentMethod": { + "type": "string" }, - "fee" : { - "type" : "integer", - "format" : "int64" + "fee": { + "type": "integer", + "format": "int64" }, - "notificationFee" : { - "type" : "integer", - "format" : "int64" + "notificationFee": { + "type": "integer", + "format": "int64" }, - "pspCompany" : { - "type" : "string" + "pspCompany": { + "type": "string" }, - "idReceipt" : { - "type" : "string" + "idReceipt": { + "type": "string" }, - "idFlowReporting" : { - "type" : "string" + "idFlowReporting": { + "type": "string" }, - "status" : { - "type" : "string", - "enum" : [ "PO_UNPAID", "PO_PAID", "PO_PARTIALLY_REPORTED", "PO_REPORTED" ] + "status": { + "type": "string", + "enum": [ + "PO_UNPAID", + "PO_PAID", + "PO_PARTIALLY_REPORTED", + "PO_REPORTED" + ] }, - "lastUpdatedDate" : { - "type" : "string", - "format" : "date-time" + "lastUpdatedDate": { + "type": "string", + "format": "date-time" }, - "lastUpdatedDateNotificationFee" : { - "type" : "string", - "format" : "date-time" + "lastUpdatedDateNotificationFee": { + "type": "string", + "format": "date-time" }, - "paymentOptionMetadata" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PaymentOptionMetadataModelResponse" + "paymentOptionMetadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentOptionMetadataModelResponse" } }, - "transfer" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/TransferModelResponse" + "transfer": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransferModelResponse" } } } }, - "Stamp" : { - "required" : [ "hashDocument", "provincialResidence", "stampType" ], - "type" : "object", - "properties" : { - "hashDocument" : { - "maxLength" : 72, - "minLength" : 0, - "type" : "string", - "description" : "Document hash type is stBase64Binary72 as described in https://github.com/pagopa/pagopa-api." - }, - "stampType" : { - "maxLength" : 2, - "minLength" : 2, - "type" : "string", - "description" : "The type of the stamp" - }, - "provincialResidence" : { - "pattern" : "[A-Z]{2}", - "type" : "string", - "description" : "The provincial of the residence", - "example" : "RM" + "Stamp": { + "required": [ + "hashDocument", + "provincialResidence", + "stampType" + ], + "type": "object", + "properties": { + "hashDocument": { + "maxLength": 72, + "minLength": 0, + "type": "string", + "description": "Document hash type is stBase64Binary72 as described in https://github.com/pagopa/pagopa-api." + }, + "stampType": { + "maxLength": 2, + "minLength": 2, + "type": "string", + "description": "The type of the stamp" + }, + "provincialResidence": { + "pattern": "[A-Z]{2}", + "type": "string", + "description": "The provincial of the residence", + "example": "RM" } } }, - "TransferMetadataModelResponse" : { - "type" : "object", - "properties" : { - "key" : { - "type" : "string" - }, - "value" : { - "type" : "string" + "TransferMetadataModelResponse": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" } } }, - "TransferModelResponse" : { - "type" : "object", - "properties" : { - "organizationFiscalCode" : { - "type" : "string" + "TransferModelResponse": { + "type": "object", + "properties": { + "organizationFiscalCode": { + "type": "string" }, - "companyName" : { - "type" : "string" + "companyName": { + "type": "string" }, - "idTransfer" : { - "type" : "string" + "idTransfer": { + "type": "string" }, - "amount" : { - "type" : "integer", - "format" : "int64" + "amount": { + "type": "integer", + "format": "int64" }, - "remittanceInformation" : { - "type" : "string" + "remittanceInformation": { + "type": "string" }, - "category" : { - "type" : "string" + "category": { + "type": "string" }, - "iban" : { - "type" : "string" + "iban": { + "type": "string" }, - "postalIban" : { - "type" : "string" + "postalIban": { + "type": "string" }, - "stamp" : { - "$ref" : "#/components/schemas/Stamp" + "stamp": { + "$ref": "#/components/schemas/Stamp" }, - "insertedDate" : { - "type" : "string", - "format" : "date-time" + "insertedDate": { + "type": "string", + "format": "date-time" }, - "status" : { - "type" : "string", - "enum" : [ "T_UNREPORTED", "T_REPORTED" ] + "status": { + "type": "string", + "enum": [ + "T_UNREPORTED", + "T_REPORTED" + ] }, - "lastUpdatedDate" : { - "type" : "string", - "format" : "date-time" + "lastUpdatedDate": { + "type": "string", + "format": "date-time" }, - "transferMetadata" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/TransferMetadataModelResponse" + "transferMetadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransferMetadataModelResponse" } } } }, - "PaymentsWithDebtorInfoModelResponse" : { - "type" : "object", - "properties" : { - "nav" : { - "type" : "string" + "PaymentsWithDebtorInfoModelResponse": { + "type": "object", + "properties": { + "nav": { + "type": "string" }, - "iuv" : { - "type" : "string" + "iuv": { + "type": "string" }, - "organizationFiscalCode" : { - "type" : "string" + "organizationFiscalCode": { + "type": "string" }, - "amount" : { - "type" : "integer", - "format" : "int64" + "amount": { + "type": "integer", + "format": "int64" }, - "description" : { - "type" : "string" + "description": { + "type": "string" }, - "isPartialPayment" : { - "type" : "boolean" + "isPartialPayment": { + "type": "boolean" }, - "dueDate" : { - "type" : "string", - "format" : "date-time" + "dueDate": { + "type": "string", + "format": "date-time" }, - "retentionDate" : { - "type" : "string", - "format" : "date-time" + "retentionDate": { + "type": "string", + "format": "date-time" }, - "paymentDate" : { - "type" : "string", - "format" : "date-time" + "paymentDate": { + "type": "string", + "format": "date-time" }, - "reportingDate" : { - "type" : "string", - "format" : "date-time" + "reportingDate": { + "type": "string", + "format": "date-time" }, - "insertedDate" : { - "type" : "string", - "format" : "date-time" + "insertedDate": { + "type": "string", + "format": "date-time" }, - "paymentMethod" : { - "type" : "string" + "paymentMethod": { + "type": "string" }, - "fee" : { - "type" : "integer", - "format" : "int64" + "fee": { + "type": "integer", + "format": "int64" }, - "notificationFee" : { - "type" : "integer", - "format" : "int64" + "notificationFee": { + "type": "integer", + "format": "int64" }, - "pspCompany" : { - "type" : "string" + "pspCompany": { + "type": "string" }, - "idReceipt" : { - "type" : "string" + "idReceipt": { + "type": "string" }, - "idFlowReporting" : { - "type" : "string" + "idFlowReporting": { + "type": "string" }, - "status" : { - "type" : "string", - "enum" : [ "PO_UNPAID", "PO_PAID", "PO_PARTIALLY_REPORTED", "PO_REPORTED" ] + "status": { + "type": "string", + "enum": [ + "PO_UNPAID", + "PO_PAID", + "PO_PARTIALLY_REPORTED", + "PO_REPORTED" + ] }, - "paymentOptionMetadata" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PaymentOptionMetadataModelResponse" + "paymentOptionMetadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentOptionMetadataModelResponse" } }, - "iupd" : { - "type" : "string" + "iupd": { + "type": "string" }, - "type" : { - "type" : "string", - "enum" : [ "F", "G" ] + "type": { + "type": "string", + "enum": [ + "F", + "G" + ] }, - "fiscalCode" : { - "type" : "string" + "fiscalCode": { + "type": "string" }, - "fullName" : { - "type" : "string" + "fullName": { + "type": "string" }, - "streetName" : { - "type" : "string" + "streetName": { + "type": "string" }, - "civicNumber" : { - "type" : "string" + "civicNumber": { + "type": "string" }, - "postalCode" : { - "type" : "string" + "postalCode": { + "type": "string" }, - "city" : { - "type" : "string" + "city": { + "type": "string" }, - "province" : { - "type" : "string" + "province": { + "type": "string" }, - "region" : { - "type" : "string" + "region": { + "type": "string" }, - "country" : { - "type" : "string" + "country": { + "type": "string" }, - "email" : { - "type" : "string" + "email": { + "type": "string" }, - "phone" : { - "type" : "string" + "phone": { + "type": "string" }, - "companyName" : { - "type" : "string" + "companyName": { + "type": "string" }, - "officeName" : { - "type" : "string" + "officeName": { + "type": "string" }, - "debtPositionStatus" : { - "type" : "string", - "enum" : [ "DRAFT", "PUBLISHED", "VALID", "INVALID", "EXPIRED", "PARTIALLY_PAID", "PAID", "REPORTED" ] + "debtPositionStatus": { + "type": "string", + "enum": [ + "DRAFT", + "PUBLISHED", + "VALID", + "INVALID", + "EXPIRED", + "PARTIALLY_PAID", + "PAID", + "REPORTED" + ] }, - "transfer" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/TransferModelResponse" + "transfer": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TransferModelResponse" } } } }, - "AppInfo" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" + "AppInfo": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "version" : { - "type" : "string" + "version": { + "type": "string" }, - "environment" : { - "type" : "string" + "environment": { + "type": "string" } } } }, - "securitySchemes" : { - "ApiKey" : { - "type" : "apiKey", - "description" : "The API key to access this function app.", - "name" : "Ocp-Apim-Subscription-Key", - "in" : "header" + "securitySchemes": { + "ApiKey": { + "type": "apiKey", + "description": "The API key to access this function app.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" }, - "Authorization" : { - "type" : "http", - "description" : "JWT token get after Azure Login", - "scheme" : "bearer", - "bearerFormat" : "JWT" + "Authorization": { + "type": "http", + "description": "JWT token get after Azure Login", + "scheme": "bearer", + "bearerFormat": "JWT" } } } -} \ No newline at end of file +} diff --git a/pom.xml b/pom.xml index 42c6c0b6..3dabbbbc 100644 --- a/pom.xml +++ b/pom.xml @@ -11,7 +11,7 @@ it.gov.pagopa.debtposition gpd - 0.13.0-1-PIDM-35-optimize-transfer-iban-update + 0.13.1 Gestione Posizioni Debitorie Progetto Gestione Posizioni Debitorie