MMP-11683-orderitems-getall #765
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
operations/orderitems.md
Outdated
Comment on lines
417
to
422
| | Property | Type | Contract | Description | | ||
| | :-- | :-- | :-- | :-- | | ||
| | `AllowanceProductOrderItemId` | string | required | Unique identifier of the allowance product [Order item](orderitems.md#order-item) which credit has been consumed by current item. | | ||
| | `AllowanceProductId` | string | required | Unique identifier of the allowance [Product](products.md#product) which credit been been consumed by current item. | | ||
| | `DiscountedOrderItemId` | string | required | Unique identifier of [Order item](orderitems.md#order-item) which has been discounted by current item. | | ||
| | `DiscountedProductId` | string | optional | Unique identifier of the [Product](products.md#product) which has been been discounted by current item. | |
There was a problem hiding this comment.
From the four fields available for allowance discount, we propose to keep only DiscountedOrderItemId.
All other values are available in the relevant Orderitem record for the allowance product or discounted item.
operations/orderitems.md
Outdated
Comment on lines
424
to
454
| #### Allowance Breakage Data | ||
|
|
||
| | Property | Type | Contract | Description | | ||
| | :-- | :-- | :-- | :-- | | ||
| | `AllowanceProductOrderItemId` | string | required | Unique identifier of the allowance product [Order item](orderitems.md#order-item) which credit has been consumed by current item. | | ||
| | `AllowanceProductId` | string | required | Unique identifier of the allowance [Product](products.md#product) which credit been been consumed by current item. | | ||
| | `ContraBreakageOrderItemId` | string | required | Unique identifier of [Order item](orderitems.md#order-item) which balances current item. | | ||
|
|
||
| #### Allowance Breakage Contra Revenue Data | ||
|
|
||
| | Property | Type | Contract | Description | | ||
| | :-- | :-- | :-- | :-- | | ||
| | `AllowanceProductOrderItemId` | string | required | Unique identifier of the allowance product [Order item](orderitems.md#order-item) which credit has been consumed by current item. | | ||
| | `AllowanceProductId` | string | required | Unique identifier of the allowance [Product](products.md#product) which credit been been consumed by current item. | | ||
| | `BreakageOrderItemId` | string | required | Unique identifier of [Order item](orderitems.md#order-item) which has been balanced by current item. | | ||
|
|
||
| #### Allowance Loss Data | ||
|
|
||
| | Property | Type | Contract | Description | | ||
| | :-- | :-- | :-- | :-- | | ||
| | `AllowanceProductOrderItemId` | string | required | Unique identifier of the allowance product [Order item](orderitems.md#order-item) which credit has been consumed by current item. | | ||
| | `AllowanceProductId` | string | required | Unique identifier of the allowance [Product](products.md#product) which credit been been consumed by current item. | | ||
| | `ContraLossOrderItemId` | string | required | Unique identifier of [Order item](orderitems.md#order-item) which balances current item. | | ||
|
|
||
| #### Allowance Loss Contra Revenue Data | ||
|
|
||
| | Property | Type | Contract | Description | | ||
| | :-- | :-- | :-- | :-- | | ||
| | `AllowanceProductOrderItemId` | string | required | Unique identifier of the allowance product [Order item](orderitems.md#order-item) which credit has been consumed by current item. | | ||
| | `AllowanceProductId` | string | required | Unique identifier of the allowance [Product](products.md#product) which credit been been consumed by current item. | | ||
| | `LossOrderItemId` | string | required | Unique identifier of [Order item](orderitems.md#order-item) which has been balanced by current item. | |
There was a problem hiding this comment.
We propose to avoid including those additional fields for breakage (profit) and losses.
We think the discriminator value is sufficient to identify the type of allowance related order item.
All other relevant information of the order item is already included in regular amounts fields.
| | `Type` | [VoucherTypeUpdateValue](_objects.md#string-update-value) | optional | Type of the voucher e.g. 'Public', 'PartnerCompany' or 'TravelAgency' (or `null` if the type should not be updated). | | ||
| | `Type` | [Voucher Type update value](_objects.md#string-update-value) | optional | Type of the voucher e.g. 'Public', 'PartnerCompany' or 'TravelAgency' (or `null` if the type should not be updated). | |
There was a problem hiding this comment.
Change Not related to allowances. It seems o be a change merged but not yet published by automated generation.
| @@ -111,6 +112,7 @@ Returns all enterprises within scope of the `Access Token`, optionally filtered | |||
| | :-- | :-- | :-- | :-- | | |||
| | `Id` | string | required | Unique identifier of the enterprise. | | |||
| | `ExternalIdentifier` | string | optional, max length 255 characters | Identifier of the enterprise from external system. | | |||
| | `HoldingKey` | string | optional, max length 255 characters | Identifies an enterprise in the external system of a holding company. The holding company may administer multiple portfolios. | | |||
There was a problem hiding this comment.
Change Not related to allowances. It seems o be a change merged but not yet published by automated generation.
| @@ -151,6 +152,7 @@ Returns the enterprise configuration. For single-enterprise Access Tokens, this | |||
| | :-- | :-- | :-- | :-- | | |||
| | `Id` | string | required | Unique identifier of the enterprise. | | |||
| | `ExternalIdentifier` | string | optional, max length 255 characters | Identifier of the enterprise from external system. | | |||
| | `HoldingKey` | string | optional, max length 255 characters | Identifies an enterprise in the external system of a holding company. The holding company may administer multiple portfolios. | | |||
There was a problem hiding this comment.
Change Not related to allowances. It seems o be a change merged but not yet published by automated generation.
| | `Basic` | [CreditRatingBasicUpdateValue](_objects.md#string-update-value) | optional | Credit status of a company (or `null` if the credit status should not be updated). | | ||
| | `Basic` | [Credit rating basic update value](_objects.md#string-update-value) | optional | Credit status of a company (or `null` if the credit status should not be updated). | |
There was a problem hiding this comment.
Change Not related to allowances. It seems o be a change merged but not yet published by automated generation.
Comment on lines
+379
to
+383
| | `AllowanceDiscount` | [Allowance Discount Data](orderitems.md#allowance-discount-data) | optional | Contains additional data in the case of allowance discount. | | ||
| | `AllowanceBreakage` | [Allowance Breakage Data](orderitems.md#allowance-breakage-data) | optional | Contains additional data in the case of allowance breakage (profit). | | ||
| | `AllowanceContraBreakage` | [Allowance Breakage Contra Revenue Data](orderitems.md#allowance-breakage-contra-revenue-data) | optional | Contains additional data in the case of allowance breakage contra revenue. | | ||
| | `AllowanceLoss` | [Allowance Loss Data](orderitems.md#allowance-loss-data) | optional | Contains additional data in the case of allowance loss. | | ||
| | `AllowanceContraLoss` | [Allowance Loss Contra Revenue Data](orderitems.md#allowance-loss-contra-revenue-data) | optional | Contains additional data in the case of allowance breakage contra revenue. | |
Comment on lines
+361
to
+362
| * `AllowanceLoss` | ||
| * `AllowanceContraLoss` |
|
@chema-ortega-mews Looks like you have encountered changes which are not related to your intended change. Since we are regenerating docs manually, it's possible we sometimes miss those changes and we're filling up the changelog (see e.g. here: #750). Could you please remove files unrelated to the changes in orderitems from the PR? Also, @MikeAdamsMews, could you please take a look at the changelog on how to document this breaking change? 😕 |
|
@chema-ortega-mews Is there already a PR for the underlying API contracts that this one depends on? |
chema-ortega-mews
force-pushed
the
MMP-11683-orderitems-getall
branch
from
4d09033 to
251bb08
Compare
|
Closed this due to lack of activity. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added 2 new order item types for allowances (loss, contraloss)
Added 5 new values for discriminator of order item data related to allowances
Added 5 new dto's used for the new order item data discriminators
Checklist