stadlar / IST-FUT-FMTH

Creative Commons Attribution 4.0 International
12 stars 19 forks source link

Feature/claims 3 1 improvements #198

Open Kristinn-Stefansson opened 1 year ago

Kristinn-Stefansson commented 1 year ago

Summary of Overall Changes:

The PR is the result discussions and comments were made regarding various aspects of the IOBWS 3.0 specification. The following changes that have been proposed and accepted and form the proposal for the IOBWS 3.1. are summarized below. For details see the PRs merged into the underlying branch, comments and issues that are referenced:

  1. Property Name Changes: Descriptive property names were suggested and accepted for clarity and consistency. This includes renaming properties in claimDetails, claimTransaction, and other related objects to provide clearer understanding of their purpose and meaning.

  2. Additional ClaimType Property: A new property called ClaimType was proposed and accepted for inclusion in the response data of the GetClaims API endpoint. This property indicates the type of the claim, such as normal claim, optional payment claim, refund claim, or government balance claim. This addition helps differentiate between different types of claims in the response.

  3. Payment Properties Terminology Refinement: The terminology used for payment properties was refined to improve clarity and accuracy. Changes include replacing "directDebitFee" with "paperlessFee" and aligning the naming with the RB service backend terminology for printing fees and paperless fees.

  4. CreatedDate Property Addition: A new property called CreatedDate was proposed and accepted to provide information about the creation date of each claim in the GetClaims response. This addition facilitates data analysis and processing by including the creation date information.

  5. Revisiting Mixed Batches: The need for supporting mixed batches, where create, alter, and cancel operations are combined, was discussed. It was concluded that currently, there is no business requirement for mixed batches. The PR submitted separates creation and updates in batches, and future considerations for supporting mixed batches will depend on the roadmap decisions of the IH system at RB.

  6. The defaultInterest entity included enums with only one option, giving the illusion of choice.The properties in question were calculationPeriod, calculationDayRule, and defaultInterestException. These where remove from the IOBWS 3.0 specification.

  7. Removal of isPostRefDate: This option was present in claimDetails and createClaimDetails, but no longer supported by the underlying core systems due to lack of use.

  8. Removal of DueDateRate: This was another feature no longer present in the underlying core system in the current form that was removed to prevent unnecessary confusion.

The changes overall aim to improve clarity, consistency, and functionality within the IOBWS 3.0 specification. They address naming conventions, property additions, and refine terminology to enhance understanding and usability for implementers and users of the API.

asgeirhall commented 1 year ago

Just wanted to point out that LastChanged is not consistent with other dates in the schema.

    - "DueDate"
    - "FinalDueDate"
    - "ExpirationDate"
    - "ClosingDate"
    - "CreationDate"
    - "LastChanged"
danielsveins commented 1 year ago

@asgeirhall good catch, we'll change it to LastChangeDate for consistency.

asgeirhall commented 10 months ago

Nust noticed the version of the file is still 3.0 should it not be 3.1? title: IOBWS 3.0 Domestic Claims version: "3.0"