Changelog: payment-forecast-api (Group: ALL)

4.3.0 - 4.4.0

This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

4.2.0 - 4.3.0

This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

4.1.0 - 4.2.0

What's New


    What's Deleted


      What's Deprecated


        What's Changed


        1. PUT/payment-forecast-api/payment-forecast-versions/{pfVerId}/forecast
          • Request

            • Changed body: 'application/json'

              Schema

              Missing property: empty (boolean)

              Missing property: first (object)

              Missing property: last (object)

              Missing property: list (array)

        2. PUT/payment-forecast-api/payment-forecast-versions/{pfVerId}/forecast-eafrd
          • Request

            • Changed body: 'application/json'

              Schema

              Missing property: empty (boolean)

              Missing property: first (object)

              Missing property: last (object)

              Missing property: list (array)

        4.0.0 - 4.1.0

        This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

        3.61.0 - 4.0.0

        What's New


          What's Deleted


            What's Deprecated


              What's Changed


              1. GET/payment-forecast-api/commission-reference-document/{commissionReferenceNumber}
                • Response

                  • Changed response : [200]//successful operation
                    • Changed body: '*/*'

                      Schema

                      Changed property: deletable (boolean)

                      Changed property: editable (boolean)

                      Changed property: isReferring (boolean)

                      Changed property: sendEnabled (boolean)

                      Changed property: sentDocumentAcknowledgeable (boolean)

                      Changed property: sentDocumentEditable (boolean)

                      Changed property: sentDocumentRefreshable (boolean)

                      Changed property: tabLabel (string)

                  • Changed response : [404]//commission reference document not found
                    • Changed body: '*/*'

                      Schema

                      Changed property: deletable (boolean)

                      Changed property: editable (boolean)

                      Changed property: isReferring (boolean)

                      Changed property: sendEnabled (boolean)

                      Changed property: sentDocumentAcknowledgeable (boolean)

                      Changed property: sentDocumentEditable (boolean)

                      Changed property: sentDocumentRefreshable (boolean)

                      Changed property: tabLabel (string)

              2. POST/payment-forecast-api/payment-forecast-versions/{id}/general/documents
                • Response

                  • Changed response : [200]//successful operation
                    • Changed body: '*/*'

                      Schema

                      Changed property: deletable (boolean)

                      Changed property: editable (boolean)

                      Changed property: isReferring (boolean)

                      Changed property: sendEnabled (boolean)

                      Changed property: sentDocumentAcknowledgeable (boolean)

                      Changed property: sentDocumentEditable (boolean)

                      Changed property: sentDocumentRefreshable (boolean)

                      Changed property: tabLabel (string)

              3. GET/payment-forecast-api/payment-forecast-versions/{id}/general/documents/{documentId}
                • Response

                  • Changed response : [200]//successful operation
                    • Changed body: '*/*'

                      Schema

                      Changed property: deletable (boolean)

                      Changed property: editable (boolean)

                      Changed property: isReferring (boolean)

                      Changed property: sendEnabled (boolean)

                      Changed property: sentDocumentAcknowledgeable (boolean)

                      Changed property: sentDocumentEditable (boolean)

                      Changed property: sentDocumentRefreshable (boolean)

                      Changed property: tabLabel (string)

              4. PUT/payment-forecast-api/payment-forecast-versions/{id}/general/documents/{documentId}
                • Response

                  • Changed response : [200]//successful operation
                    • Changed body: '*/*'

                      Schema

                      Changed property: deletable (boolean)

                      Changed property: editable (boolean)

                      Changed property: isReferring (boolean)

                      Changed property: sendEnabled (boolean)

                      Changed property: sentDocumentAcknowledgeable (boolean)

                      Changed property: sentDocumentEditable (boolean)

                      Changed property: sentDocumentRefreshable (boolean)

                      Changed property: tabLabel (string)

              5. PUT/payment-forecast-api/payment-forecast-versions/{id}/general/documents/{documentId}/refresh
                • Response

                  • Changed response : [200]//successful operation
                    • Changed body: '*/*'

                      Schema

                      Changed property: deletable (boolean)

                      Changed property: editable (boolean)

                      Changed property: isReferring (boolean)

                      Changed property: sendEnabled (boolean)

                      Changed property: sentDocumentAcknowledgeable (boolean)

                      Changed property: sentDocumentEditable (boolean)

                      Changed property: sentDocumentRefreshable (boolean)

                      Changed property: tabLabel (string)

              6. GET/payment-forecast-api/{id}/global-search/documents/{documentId}
                • Response

                  • Changed response : [200]//successful operation
                    • Changed body: '*/*'

                      Schema

                      Changed property: deletable (boolean)

                      Changed property: editable (boolean)

                      Changed property: isReferring (boolean)

                      Changed property: sendEnabled (boolean)

                      Changed property: sentDocumentAcknowledgeable (boolean)

                      Changed property: sentDocumentEditable (boolean)

                      Changed property: sentDocumentRefreshable (boolean)

                      Changed property: tabLabel (string)

              3.60.0 - 3.61.0

              This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

              3.59.0 - 3.60.0

              This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

              3.58.0 - 3.59.0

              This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

              3.57.0 - 3.58.0

              This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

              3.56.0 - 3.57.0

              What's New


                What's Deleted


                  What's Deprecated


                    What's Changed


                    1. GET/payment-forecast-api/payment-forecast-versions/{id}/general/documents/metadata
                      • Response

                        • Changed response : [200]//successful operation
                          • Changed body: '*/*'

                            Schema

                            Added property: canImportFromExcel (boolean)

                            Added property: compareChaptersDto (array)

                            Added property: compareDto (array)

                            Added property: disabledFundIds (array)

                            Added property: editablePagesDto (object)

                            Added property: editableSectionsDto (object)

                            Added property: exportExtraDto (object)

                            Added property: nextActionsDtoList (array)

                        • Changed response : [404]//documentable object not found
                          • Changed body: '*/*'

                            Schema

                            Added property: canImportFromExcel (boolean)

                            Added property: compareChaptersDto (array)

                            Added property: compareDto (array)

                            Added property: disabledFundIds (array)

                            Added property: editablePagesDto (object)

                            Added property: editableSectionsDto (object)

                            Added property: exportExtraDto (object)

                            Added property: nextActionsDtoList (array)

                    3.55.0 - 3.56.0

                    This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                    3.54.0 - 3.55.0

                    This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                    3.53.0 - 3.54.0

                    This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                    3.52.0 - 3.53.0

                    This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                    3.51.0 - 3.52.0

                    This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                    3.50.0 - 3.51.0

                    This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                    3.49.0 - 3.50.0

                    This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                    3.48.0 - 3.49.0

                    This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                    3.47.0 - 3.48.0

                    This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                    3.46.0 - 3.47.0

                    This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                    3.45.0 - 3.46.0

                    What's New


                      What's Deleted


                        What's Deprecated


                          What's Changed


                          1. POST/payment-forecast-api/payment-forecast-versions/{pfVerId}/actions/CAN
                            • Description

                                old: 'This use case occurs when a user wants to cancel a Payment Forecast version with documents sent to the Commission and without any previous work version in status ‘Revision requested by EC’. The notification utility will be called to notify the Commission of the cancel of the version.', new: 'This use case occurs when a user wants to cancel a Payment Forecast version with documents sent to the Commission and without any previous work version in status ‘Revision requested by EC’. The notification utility will be called to notify the Commission of the cancel of the version.'

                          3.44.0 - 3.45.0

                          What's New


                            What's Deleted


                              What's Deprecated


                                What's Changed


                                1. POST/payment-forecast-api/payment-forecast-versions/{pfVerId}/general/observations
                                  • Request

                                    • Changed body: 'application/json'

                                      Schema incompatible

                                      Changed property: isEcUser (boolean)

                                      Changed property: nameAndSurname (string)

                                  • Response

                                    • Changed response : [200]//OK
                                      • Changed body: '*/*'

                                        Schema

                                        Changed property: isEcUser (boolean)

                                        Changed property: nameAndSurname (string)

                                3.43.0 - 3.44.0

                                This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                3.42.0 - 3.43.0

                                This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                3.41.0 - 3.42.0

                                This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                3.40.0 - 3.41.0

                                This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                3.39.0 - 3.40.0

                                What's New


                                  What's Deleted


                                    What's Deprecated


                                      What's Changed


                                      1. POST/payment-forecast-api/payment-forecast-versions/{pfVerId}/actions/CRE
                                        • Response

                                          • Changed response : [201]//Create New Version executed
                                            • Changed body: '*/*'

                                              Schema

                                              Added property: statusComments (string)

                                      2. GET/payment-forecast-api/payment-forecast-versions/{pfVerId}/summary
                                        • Response

                                          • Changed response : [200]//successful operation
                                            • Changed body: '*/*'

                                              Schema

                                              Added property: statusComments (string)

                                      3. POST/payment-forecast-api/payment-forecast-versions
                                        • Response

                                          • Changed response : [400]//Invalid input
                                            • Changed body: '*/*'

                                              Schema

                                              Added property: statusComments (string)

                                      3.38.0 - 3.39.0

                                      This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                      3.37.0 - 3.38.0

                                      This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                      3.36.0 - 3.37.0

                                      This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                      3.35.0 - 3.36.0

                                      What's New


                                        What's Deleted


                                          What's Deprecated


                                            What's Changed


                                            1. GET/payment-forecast-api/payment-forecast-versions/{id}/tocs
                                              • Parameters

                                                • Add sourceLanguageCode in query
                                                • Add targetLanguageCode in query

                                            3.34.0 - 3.35.0

                                            What's New


                                              What's Deleted


                                                What's Deprecated


                                                  What's Changed


                                                  1. GET/payment-forecast-api/payment-forecast-versions/{pfVerId}/summary
                                                    • Response

                                                      • Changed response : [200]//successful operation
                                                        • Changed body: '*/*'

                                                          Schema

                                                          Added property: sourceLanguageCode (string)

                                                  3.33.0 - 3.34.0

                                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                  3.32.0 - 3.33.0

                                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                  3.31.0 - 3.32.0

                                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                  3.30.0 - 3.31.0

                                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                  3.29.0 - 3.30.0

                                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                  3.28.0 - 3.29.0

                                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                  3.27.0 - 3.28.0

                                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                  3.26.0 - 3.27.0

                                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                  3.25.0 - 3.26.0

                                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                  3.24.0 - 3.25.0

                                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                  3.23.0 - 3.24.0

                                                  This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                  3.22.0 - 3.23.0

                                                  What's New


                                                    What's Deleted


                                                    1. POST/payment-forecast-api/payment-forecast-versions/update-crc/{pfType} Updates the CRC for all sections of all objects for a specific object type
                                                    2. GET/payment-forecast-api/payment-forecast-versions/{pfVerId}/crc-info/{tocCode}/{tocItemArgs} Gets crc information for the specified object and section
                                                    3. POST/payment-forecast-api/payment-forecast-versions/{pfVerId}/update-crc-all-sections Updates the CRC for all sections of the payment forecast version

                                                    What's Deprecated


                                                      What's Changed


                                                        3.21.0 - 3.22.0

                                                        This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                        3.20.0 - 3.21.0

                                                        This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                        3.19.0 - 3.20.0

                                                        This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                        3.18.0 - 3.19.0

                                                        This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                        3.17.0 - 3.18.0

                                                        What's New


                                                          What's Deleted


                                                            What's Deprecated


                                                              What's Changed


                                                              1. POST/payment-forecast-api/payment-forecast-versions/{pfVerId}/actions/CRE
                                                                • Response

                                                                  • Changed response : [201]//Create New Version executed
                                                                    • Changed body: '*/*'

                                                                      Schema

                                                                      Added property: listOfFundIds (array)

                                                              2. POST/payment-forecast-api/payment-forecast-versions
                                                                • Response

                                                                  • Changed response : [400]//Invalid input
                                                                    • Changed body: '*/*'

                                                                      Schema

                                                                      Added property: listOfFundIds (array)

                                                              3.16.0 - 3.17.0

                                                              This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                              3.15.0 - 3.16.0

                                                              What's New


                                                              1. POST/payment-forecast-api/payment-forecast-versions/update-crc/{pfType} Updates the CRC for all sections of all objects for a specific object type
                                                              2. GET/payment-forecast-api/payment-forecast-versions/{pfVerId}/crc-info/{tocCode}/{tocItemArgs} Gets crc information for the specified object and section
                                                              3. POST/payment-forecast-api/payment-forecast-versions/{pfVerId}/update-crc-all-sections Updates the CRC for all sections of the payment forecast version

                                                              What's Deleted


                                                                What's Deprecated


                                                                  What's Changed


                                                                    3.14.0 - 3.15.0

                                                                    This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                                    3.13.0 - 3.14.0

                                                                    This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                                    3.12.0 - 3.13.0

                                                                    This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                                    3.11.0 - 3.12.0

                                                                    What's New


                                                                      What's Deleted


                                                                        What's Deprecated


                                                                          What's Changed


                                                                          1. GET/payment-forecast-api/commission-reference-document/{commissionReferenceNumber} gets a commission reference document
                                                                            • Description

                                                                                old: 'Get Commission Reference Document.', new: 'Provides the commission reference document in a documentDto model. (only to be used by EC users)The documentTypeId can optionally be given to determine if the rendition version is needed or the original version.'
                                                                            • Operation ID

                                                                              • Changed getHRSPA to getCommissionReferenceDocument
                                                                            • Parameters

                                                                              • Add documentTypeId in query

                                                                          3.10.0 - 3.11.0

                                                                          This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                                          3.9.0 - 3.10.0

                                                                          This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                                          3.8.0 - 3.9.0

                                                                          This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                                          3.7.0 - 3.8.0

                                                                          This version does not introduce any new endpoints, parameters, or changes to existing API behavior.

                                                                          3.6.0 - 3.7.0

                                                                          What's New


                                                                            What's Deleted


                                                                              What's Deprecated


                                                                                What's Changed


                                                                                1. GET/payment-forecast-api/payment-forecast-versions/validation-rules/{pfrVerId}
                                                                                  • Response

                                                                                    • Changed response : [200]//successful operation
                                                                                      • Changed body: '*/*'

                                                                                        Schema

                                                                                        Added property: listOfLabelValue (array)

                                                                                    • Changed response : [404]//PaymentForecastVersion not found
                                                                                      • Changed body: '*/*'

                                                                                        Schema

                                                                                        Added property: listOfLabelValue (array)

                                                                                3.3.0 - 3.6.0

                                                                                What's New


                                                                                1. POST/payment-forecast-api/document-search/download-all Download all documents

                                                                                What's Deleted


                                                                                  What's Deprecated


                                                                                    What's Changed


                                                                                    1. POST/payment-forecast-api/document-search
                                                                                      • Request

                                                                                        • Changed body: 'application/json'

                                                                                          Schema

                                                                                          Added property: empty (boolean)

                                                                                          Added property: page (integer)

                                                                                          Added property: size (integer)

                                                                                    3.2.0 - 3.3.0

                                                                                    What's New


                                                                                      What's Deleted


                                                                                        What's Deprecated


                                                                                          What's Changed


                                                                                          1. POST/payment-forecast-api/payment-forecast-versions/{pfVerId}/general/officials
                                                                                            • Response

                                                                                              • Changed response : [200]//OK
                                                                                                • Changed body: '*/*'

                                                                                                  Schema

                                                                                                  Added property: key (string)

                                                                                          2. GET/payment-forecast-api/payment-forecast-versions/{pfVerId}/general/officials/{offId}
                                                                                            • Response

                                                                                              • Changed response : [200]//OK
                                                                                                • Changed body: '*/*'

                                                                                                  Schema

                                                                                                  Added property: key (string)

                                                                                          3. PUT/payment-forecast-api/payment-forecast-versions/{pfVerId}/general/officials/{offId}
                                                                                            • Response

                                                                                              • Changed response : [200]//OK
                                                                                                • Changed body: '*/*'

                                                                                                  Schema

                                                                                                  Added property: key (string)