Overview
These endpoints enable administration of CPQ Price Agreements, Price Agreement Items, Price Agreement stand-alone Charges, Price Agreement Rate Plans, and Price Agreement Rate Plan Charges using REST API services.
Administration
Price Agreements
|
Description |
Use this endpoint to add a price agreement. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
customerId |
Customer Id of the price agreement |
|
customerName |
Customer name of the price agreement |
|
|
description |
Description of the price agreement |
|
|
dynamicPricingType |
The type of dynamic pricing applied by the price agreement. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", or "attributeBasedCharge" |
|
|
endDate |
The date at which the price agreement will end |
|
|
integrationId |
Price list Id from Oracle Fusion Supply Chain Management (SCM) |
|
|
name |
Name of the price agreement |
|
|
startDate |
Effective start date of the price agreement |
|
|
variableName |
(optional) Unique number of the price agreement |
|
| Response Body Parameters |
JSON data for the newly added price agreement. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements
{ "name": "1a", "variableName": "a1aaccount11", "description": "www", "startDate": "2024-01-01T08:00:00Z", "endDate": "2024-01-20T08:00:00Z", "customerId": "account11", "customerName": "Company_account11", "status": "active" }
{ "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "name": "1a", "variableName": "a1aaccount11", "description": "www", "dateModified": "2024-04-29T20:33:20Z", "dateAdded": "2024-04-29T20:33:20Z", "startDate": "2024-01-01T08:00:00Z", "endDate": "2024-01-20T08:00:00Z", "customerId": "account11", "customerName": "Company_account11", "conditionType": "alwaysTrue", "valueType": "absolutePrice", "dynamicPricingType": "static", "status": "active" }
|
Description |
Use this endpoint to delete the specified price agreement. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve the specified price agreement. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
conditionType |
The condition type of the price agreement. Allowed Values: "alwaysTrue" or "simple" |
|
createdBy |
The details of the user who created the record. | |
|
customerId |
Customer Id of the price agreement |
|
|
customerName |
Customer name of the price agreement |
|
|
data |
List of data for the price agreement |
|
|
dateAdded |
Creation date of the price agreement |
|
|
dateModified |
Last modified date of the price agreement |
|
|
description |
Description of the price agreement |
|
|
dynamicPricingType |
The type of dynamic pricing applied by the price agreement. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", or "attributeBasedCharge" |
|
|
endDate |
The date at which the price agreement will end |
|
|
hasBomItem |
Indicates whether this price agreement has prices defined for BOM Items |
|
|
hasCharges |
Indicates if this price agreement data has linked charges. | |
|
hasChargeSupport |
Indicates whether this price agreement has charge support (Starting v16 this will be always true and will be deprecated) |
|
|
hasRateCards |
Indicates if this price agreement data has linked rate cards (Preview only) |
|
|
hasRatePlans |
Indicates if this price agreement data has linked rate plans |
|
|
hasTiers |
Indicates whether this model has any price agreement data that has tiers |
|
|
integrationId |
Price list Id from Oracle Fusion Supply Chain Management (SCM) |
|
|
lastModifiedBy |
The details of the user who modified the record. | |
|
matrixTemplateVariableName |
The dynamic matrix template variable name of the Price Agreement. |
|
|
matrixTemplateName |
The dynamic matrix template name of the Price Agreement. |
|
|
name |
Name of the price agreement |
|
|
priceAgreementItems |
List of agreement items for the price agreement |
|
|
sourceTransactionId |
The source transaction id of the Price Agreement. |
|
|
startDate |
Effective start date of the price agreement |
|
|
status |
The status of the Price Agreement. |
|
|
supportedMatrixTemplateVariableName |
The supported dynamic matrix pricing template of the Price Agreement. | |
|
valueType |
The value type of the price agreement Allowed Values: "absolutePrice", "discountAmount", "discountPercent", "markupAmount", or "markupPercent" |
|
|
variableName |
Unique number of the price agreement |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112
{ "name": "AgreementAPI", "variableName": "agreementAPIaccount112", "dateModified": "2024-01-26T20:36:47Z", "dateAdded": "2024-01-26T20:36:47Z", "customerId": "account112", "customerName": "Company_account112", "conditionType": "alwaysTrue", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/data" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems" } ], "valueType": "absolutePrice", "dynamicPricingType": "static", "hasBomItem": false, "hasChargeSupport": true, "hasRateCards": false, "hasTiers": false }
|
Description |
Use this endpoint to retrieve all price agreements. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements |
|
|
Endpoint Parameters |
None |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of price agreements. |
|
|
conditionType |
The condition type of the price agreement. Allowed Values: "alwaysTrue" or "simple" |
|
|
createdBy |
The details of the user who created the record. | |
|
customerId |
Customer Id of the price agreement |
|
|
customerName |
Customer name of the price agreement |
|
|
data |
List of data for the price agreement |
|
|
dateAdded |
Creation date of the price agreement |
|
|
dateModified |
Last modified date of the price agreement |
|
|
description |
Description of the price agreement |
|
|
dynamicPricingType |
The type of dynamic pricing applied by the price agreement. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", or "attributeBasedCharge" |
|
|
endDate |
The date at which the price agreement will end |
|
|
hasBomItem |
Indicates whether this price agreement has prices defined for BOM Items |
|
|
hasCharges |
Indicates if this price agreement data has linked charges. | |
|
hasChargeSupport |
Indicates whether this price agreement has charge support (Starting v16 this will be always true and will be deprecated) |
|
|
hasRateCards |
Indicates if this price agreement data has linked rate cards (Preview only) |
|
|
hasRatePlans |
Indicates if this price agreement data has linked rate plans |
|
|
hasTiers |
Indicates whether this model has any price agreement data that has tiers |
|
|
integrationId |
Price list Id from Oracle Fusion Supply Chain Management (SCM) |
|
|
lastModifiedBy |
The details of the user who modified the record. | |
|
matrixTemplateVariableName |
The dynamic matrix template variable name of the Price Agreement. |
|
|
matrixTemplateName |
The dynamic matrix template name of the Price Agreement. |
|
|
name |
Name of the price agreement |
|
|
priceAgreementItems |
List of agreement items for the price agreement |
|
|
sourceTransactionId |
The source transaction id of the Price Agreement. |
|
|
startDate |
Effective start date of the price agreement |
|
|
status |
The status of the Price Agreement. |
|
|
supportedMatrixTemplateVariableName |
The supported dynamic matrix pricing template of the Price Agreement. | |
|
valueType |
The value type of the price agreement Allowed Values: "absolutePrice", "discountAmount", "discountPercent", "markupAmount", or "markupPercent" |
|
|
variableName |
Unique number of the price agreement |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements
{ "items": [{ "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "M1a", "variableName": "m1aaccount11", "dateModified": "2024-01-19T06:46:48Z", "dateAdded": "2024-01-19T06:46:48Z", "startDate": "2024-01-01T08:00:00Z", "endDate": "2024-01-20T08:00:00Z", "customerId": "account11", "customerName": "Company_account11", "conditionType": "alwaysTrue", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/m1aaccount11" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/m1aaccount11/data" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/m1aaccount11/priceAgreementItems" } ], "valueType": "absolutePrice", "dynamicPricingType": "static", "hasBomItem": false, "hasChargeSupport": true, "hasRateCards": false, "hasRatePlans": false, "hasTiers": false, "hasCharges": false, "status": "active" }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "M1", "variableName": "m1account11", "description": "www", "dateModified": "2024-01-19T07:01:07Z", "dateAdded": "2024-01-19T06:44:42Z", "startDate": "2024-01-01T08:00:00Z", "endDate": "2024-01-20T08:00:00Z", "customerId": "account11", "customerName": "Company_account11", "conditionType": "alwaysTrue", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/m1account11" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/m1account11/data" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/m1account11/priceAgreementItems" } ], "valueType": "absolutePrice", "dynamicPricingType": "static", "hasBomItem": false, "hasChargeSupport": true, "hasRateCards": false, "hasRatePlans": false, "hasTiers": false, "hasCharges": false, "status": "active" }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "1a", "variableName": "a1aaccount11", "description": "www", "dateModified": "2024-01-19T06:57:15Z", "dateAdded": "2024-01-19T06:45:41Z", "startDate": "2024-01-01T08:00:00Z", "endDate": "2024-01-20T08:00:00Z", "customerId": "account11", "customerName": "Company_account11", "conditionType": "alwaysTrue", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/a1aaccount11" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/a1aaccount11/data" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/a1aaccount11/priceAgreementItems" } ], "valueType": "absolutePrice", "dynamicPricingType": "static", "hasBomItem": false, "hasChargeSupport": true, "hasRateCards": false, "hasRatePlans": false, "hasTiers": false, "hasCharges": false, "status": "active" }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "AgreementAPI", "variableName": "agreementAPIaccount112", "dateModified": "2024-01-26T20:36:47Z", "dateAdded": "2024-01-26T20:36:47Z", "customerId": "account112", "customerName": "Company_account112", "conditionType": "alwaysTrue", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/data" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems" } ], "valueType": "absolutePrice", "dynamicPricingType": "static", "hasBomItem": false, "hasChargeSupport": true, "hasRateCards": false, "hasRatePlans": false, "hasTiers": false, "hasCharges": false, "status": "active" }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "a1", "variableName": "a1account138", "dateModified": "2024-01-19T05:18:31Z", "dateAdded": "2024-01-19T05:18:31Z", "customerId": "account138", "customerName": "Company_account138", "conditionType": "alwaysTrue", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/a1account138" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/a1account138/data" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/a1account138/priceAgreementItems" } ], "valueType": "absolutePrice", "dynamicPricingType": "static", "hasBomItem": false, "hasChargeSupport": true, "hasRateCards": false, "hasRatePlans": false, "hasTiers": false, "hasCharges": false, "status": "active" } ], "offset": 0, "limit": 1000, "count": 5, "hasMore": false, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements?offset=0&limit=1000" } ] }
Get Price Agreement Pricing Matrix Grid Data
|
Description |
Use this endpoint to retrieve all pricing matrix grid data. The matrix data input and output fields will be prefixed by the "matrix" string in the response to distinguish from other charge or reference fields with the same name. |
||
|---|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/matrixGrid |
||
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement | |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
|||
|
HTTP Method |
GET |
||
| Request Body Parameters | None | ||
| Response Body Parameters |
count |
The number of resource instances returned in the current range. | |
|
createdBy |
The details of the user who created the record. | ||
|
hasMore |
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. | ||
|
items |
An array of pricing matrix grid items | ||
|
_proxy_id |
The proxy identifier for the resource that was added. | ||
|
bomItemName |
The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request. | ||
|
bomItemVariableName |
The BOM Item's variable name. | ||
|
chargeDefinition |
The display label of the charge definition. | ||
|
chargeDefinitionCode |
The unique code of the charge definition. | ||
|
chargeDefinitionIntegrationId |
The integration Id of the charge definition. | ||
|
chargeEndDate |
The date at which the charge will end. | ||
|
chargeId |
ID of the Charge. | ||
|
chargeStartDate |
The date from which the Charge will be applicable. | ||
|
chargeType |
The category of charge. | ||
|
createdBy |
The details of the user who created the record. | ||
|
dateAdded |
Creation Date of the Pricing Matrix data. | ||
|
dateModified |
Last Modified date of the Pricing Matrix data. | ||
|
description |
The description of the Price Agreement Data | ||
|
dynamicPricingType |
The dynamic pricing type of the charge. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", and "attributeBasedCharge" | ||
|
id |
The Unique Identifier of the Pricing Matrix data. | ||
|
lastModifiedBy |
The details of the user who modified the record. | ||
|
links |
The link relations associated with the resource instance. | ||
|
partNumber |
The part number | ||
|
priceModelItemId |
ID of the Price Model item. | ||
|
pricePeriod |
The billing period. | ||
|
priceType |
The type of charge. | ||
|
primaryCharge |
Indicates whether this is the primary charge. | ||
|
ratePlanDescription |
The Rate Plan description. | ||
|
ratePlanEndDate |
The date at which the Rate Plan will end. | ||
|
ratePlanName |
The Rate Plan name | ||
|
ratePlanNumber |
The Rate Plan number | ||
|
ratePlanStartDate |
The date from which the Rate Plan will be applicable. | ||
|
rootBomItemName |
The root BOM item's display name. | ||
|
rootBomItemVariableName |
The root BOM item's variable name. | ||
|
salesProductType |
The Sales Product Type | ||
|
serviceDuration |
The Service Duration | ||
|
serviceDurationPeriod |
The Service Duration Period Code | ||
|
serviceDurationType |
The Service Duration Type | ||
|
usageUOM |
The unit of measure for the charge. | ||
|
lastModifiedBy |
The details of the user who modified the record. | ||
|
limit |
The actual paging size used by the server. | ||
|
links |
The link relations associated with the resource instance. | ||
|
offset |
The offset value used in the current page. | ||
|
totalResults |
Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request. | ||
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/mbpAgreement/matrixGrid
{ "items": [{ "id": 452345, "partNumber": "part10", "description": "Part 10", "bomItemVariableName": "child", "rootBomItemVariableName": "parent", "bomItemName": "Child", "rootBomItemName": "Parent", "serviceDuration": 1, "serviceDurationPeriod": "months", "chargeType": "salesPrice", "priceType": "oneTime", "ratePlanName": "myRatePlan", "ratePlanNumber": "RP10234", "dynamicPricingType": "attributeBasedCharge", "chargeDefinitionCode": "ONE_TIME_SALES_PRICE", "chargeStartDate": "2024-11-08T00:0:00Z", "chargeEndDate": "2025-10-07T23:59:59Z", "dateAdded": "2023-11-08T05:42:17Z", "dateModified": "2023-11-08T05:42:17Z", "str1_c": "test", "int1_c": 11, "_matrix_str1": "testMatrix1", "_matrix_int1": 102, "_matrix_itemPrice": { "currency": "USD", "value": 20 } }, { "id": 452346, "partNumber": "part10", "description": "Part 10", "bomItemVariableName": "child", "rootBomItemVariableName": "parent", "bomItemName": "Child", "rootBomItemName": "Parent", "serviceDuration": 1, "serviceDurationPeriod": "months", "chargeType": "salesPrice", "priceType": "oneTime", "ratePlanName": "myRatePlan", "ratePlanNumber": "RP10234", "dynamicPricingType": "attributeBasedCharge", "chargeDefinitionCode": "ONE_TIME_SALES_PRICE", "chargeStartDate": "2024-11-08T00:0:00Z", "chargeEndDate": "2025-10-07T23:59:59Z", "dateAdded": "2023-11-08T05:42:17Z", "dateModified": "2023-11-08T05:42:17Z", "str1_c": "test", "int1_c": 11, "_matrix_str1": "testMatrix2", "_matrix_int1": 103, "_matrix_itemPrice": { "currency": "USD", "value": 22 } } ], "offset": 0, "limit": 1000, "count": 2, "hasMore": false }
|
Description |
Use this endpoint to update the specified price agreement. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
customerId |
Customer Id of the price agreement |
|
customerName |
Customer name of the price agreement |
|
|
data |
List of data for the price agreement |
|
|
description |
Description of the price agreement |
|
|
dynamicPricingType |
The type of dynamic pricing applied by the price agreement. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", or "attributeBasedCharge" |
|
|
endDate |
The date at which the price agreement will end |
|
|
integrationId |
Price list Id from Oracle Fusion Supply Chain Management (SCM) |
|
|
name |
Name of the price agreement |
|
|
priceAgreementItems |
List of agreement items for the price agreement |
|
|
startDate |
Effective start date of the price agreement |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/jtaiPriceAgreement2
{ "name": "AgreementAPI", "variableName": "agreementAPIaccount112", "description": "price agreementupdate", "startDate": "2023-10-26T07:00:00Z", "endDate": "2023-10-28T07:00:00Z", "customerId": "account112", "customerName": "Company_account112", }
|
Description |
Use this endpoint to update price agreements. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
The array of price agreement patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", and "replace". | |
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target value. Refer to Update Price Agreement for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements
[{ "op": "add", "path": "/", "value": { "name": "example price agreement 2", "description": "example price agreement 2", "startDate": "2023-10-26T07:00:00Z", "endDate": "2023-10-28T07:00:00Z", "customerId": "account113", "customerName": "Company_account113" } }, { "op": "remove", "path": "/examplePriceAgreement1" }, { "op": "replace", "path": "/examplePriceAgreement3", "value": { "name": "example price agreement 3", "variableName": "examplePriceAgreement3", "description": "example price agreement 3 update", "customerId": "account114", "customerName": "Company_account114" } } ]
Update Price Agreement Pricing Grid Data
|
Description |
Use this endpoint to update pricing matrix grid data. The matrix input and output fields should be prefixed with the "matrix" string. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/matrixGrid |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
The array of pricing patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", and "replace". | |
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target value. Refer to Get Price Agreement Pricing Matrix Grid Data for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/mbpAgreement/matrixGrid
[{ "op": "add", "path": "/", "value": { "id": -1, "partNumber": "part10", "description": "Part 10", "bomItemVariableName": "child", "rootBomItemVariableName": "parent", "bomItemName": "Child", "rootBomItemName": "Parent", "serviceDuration": 1, "serviceDurationPeriod": "months", "chargeType": "salesPrice", "priceType": "oneTime", "ratePlanName": "myRatePlan", "ratePlanNumber": "RP10234", "dynamicPricingType": "attributeBasedCharge", "chargeDefinitionCode": "ONE_TIME_SALES_PRICE", "chargeStartDate": "2024-11-08T00:0:00Z", "chargeEndDate": "2025-10-07T23:59:59Z", "dateAdded": "2023-11-08T05:42:17Z", "dateModified": "2023-11-08T05:42:17Z", "chargeAttrStr_c": "test", "chargeAttrInt_c": 11, "_matrix_str1": "testMatrix1", "_matrix_int1": 102, "_matrix_itemPrice": { "currency": "USD", "value": 20 } } }, { "op": "replace", "path": "/3453466", "value": { "_matrix_str1": "testMatrix1a", "_matrix_itemPrice": { "currency": "USD", "value": 21 } } } ]
{ [{ "_proxy_id": -1, "id": 456234 } ] }
Price Agreement Items
|
Description |
Use this endpoint to add a price agreement item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
HTTP Method |
POST |
|
| Request Body Parameters |
bomItemName |
The BOM item's display name. When the |
|
bomItemVariableName |
The BOM item's variable name |
|
|
charges |
The standalone charges associated with this price agreement item |
|
|
description |
The description of the price agreement item |
|
|
id |
The Unique Identifier of the price model data |
|
|
integrationId |
Price list Id from Oracle Fusion Supply Chain Management (SCM) |
|
|
partNumber |
The part number of the price agreement item |
|
|
ratePlans |
The rate plans linked to this price agreement item |
|
|
rootBomItemName |
The root BOM item's display name |
|
|
rootBomItemVariableName |
The root BOM item's variable name | |
|
salesProductType |
The sales product type of the price agreement item |
|
|
serviceDuration |
The service duration of this price agreement item. This value is relevant only for parts with variable service duration type and is ignored for other types | |
|
serviceDurationPeriod |
The service duration period code of this price agreement item. This value is relevant only for parts with variable service duration type and is ignored for other types |
|
|
serviceDurationType |
The service duration type |
|
| Response Body Parameters |
JSON data for the newly added price agreement item. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems
{ "partNumber": "Floor Mats", "hasRatePlanSupport": true }
{ "id": 3023203536, "partNumber": "Floor Mats", "description": "", "salesProductType": "SUBSCRIPTION", "dateModified": "2024-01-30T18:06:25Z", "dateAdded": "2024-01-30T18:06:25Z", "hasRatePlanSupport": true, "chargeCount": 0, "ratePlanCount": 0 }
|
Description |
Use this endpoint to delete the specified price agreement item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve the specified price agreement item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
bomItemName |
The BOM item's display name. When the |
|
bomItemVariableName |
The BOM item's variable name |
|
|
chargeCount |
The count of charges directly associated with this price agreement item |
|
|
charges |
The standalone charges associated with this price agreement item |
|
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation date of the price agreement item |
|
|
dateModified |
Last modified date of the price agreement item |
|
|
description |
The description of the price agreement item |
|
|
hasRatePlanSupport |
Indicates if the price agreement item supports rate plans |
|
|
id |
The Unique Identifier of the price model data |
|
|
integrationId |
Price list Id from Oracle Fusion Supply Chain Management (SCM) |
|
|
lastModifiedBy |
The details of the user who modified the record. | |
|
partNumber |
The part number of the price agreement item |
|
|
ratePlanCount |
The count of rate plans directly associated with this price agreement item |
|
|
ratePlans |
The rate plans linked to this price agreement item |
|
|
rootBomItemName |
The root BOM item's display name |
|
|
rootBomItemVariableName |
The root BOM item's variable name | |
|
salesProductType |
The sales product type of the price agreement item |
|
|
serviceDuration |
The service duration of this price agreement item. This value is relevant only for parts with variable service duration type and is ignored for other types | |
|
serviceDurationPeriod |
The service duration period code of this price agreement item. This value is relevant only for parts with variable service duration type and is ignored for other types |
|
|
serviceDurationType |
The service duration type |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276
{ "id": 3023202276, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/charges" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/ratePlans" } ], "partNumber": "Floor Mats", "description": "", "salesProductType": "SUBSCRIPTION", "dateModified": "2024-01-26T20:36:59Z", "dateAdded": "2024-01-26T20:36:59Z", "hasRatePlanSupport": true, "chargeCount": 1, "ratePlanCount": 0 }
|
Description |
Use this endpoint to retrieve all items for the specified price agreement. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of price agreement items |
|
|
bomItemName |
The BOM item's display name. When the |
|
|
bomItemVariableName |
The BOM item's variable name |
|
|
chargeCount |
The count of charges directly associated with this price agreement item |
|
|
charges |
The standalone charges associated with this price agreement item |
|
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation date of the price agreement item |
|
|
dateModified |
Last modified date of the price agreement item |
|
|
description |
The description of the price agreement item |
|
|
hasRatePlanSupport |
Indicates if the price agreement item supports rate plans |
|
|
id |
The Unique Identifier of the price model data |
|
|
integrationId |
Price list Id from Oracle Fusion Supply Chain Management (SCM) |
|
|
lastModifiedBy |
The details of the user who modified the record. | |
|
partNumber |
The part number of the price agreement item |
|
|
ratePlanCount |
The count of rate plans directly associated with this price agreement item |
|
|
ratePlans |
The rate plans linked to this price agreement item |
|
|
rootBomItemName |
The root BOM item's display name |
|
|
rootBomItemVariableName |
The root BOM item's variable name | |
|
salesProductType |
The sales product type of the price agreement item |
|
|
serviceDuration |
The service duration of this price agreement item. This value is relevant only for parts with variable service duration type and is ignored for other types | |
|
serviceDurationPeriod |
The service duration period code of this price agreement item. This value is relevant only for parts with variable service duration type and is ignored for other types |
|
|
serviceDurationType |
The service duration type |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems
{ "items": [{ "id": 3023202291, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/charges" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans" } ], "partNumber": "Car Cover", "description": "", "salesProductType": "SUBSCRIPTION", "dateModified": "2024-01-26T20:58:32Z", "dateAdded": "2024-01-26T20:58:32Z", "hasRatePlanSupport": true, "chargeCount": 0, "ratePlanCount": 1 }, { "id": 3023202276, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/charges" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/ratePlans" } ], "partNumber": "Floor Mats", "description": "", "salesProductType": "SUBSCRIPTION", "dateModified": "2024-01-26T20:36:59Z", "dateAdded": "2024-01-26T20:36:59Z", "hasRatePlanSupport": true, "chargeCount": 1, "ratePlanCount": 0 } ], "offset": 0, "limit": 1000, "count": 2, "hasMore": false, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems?offset=0&limit=1000" } ] }
Get Price Agreement Pricing Data
|
Description |
Use this endpoint to retrieve all charges for the specified price agreement. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/data |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceModelItemId |
The unique identifier of the Price Model Item. | |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of price agreement pricing data. |
|
|
blockPrices |
The block price |
|
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
The category of the charge |
|
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation date of the charge |
|
|
dateModified |
Last modified date of the charge |
|
|
dynamicPricingType |
The dynamic pricing type of the price agreement charge. Allowed Values: |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. | |
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
The basis on which a price or charge is levied, whether one time, on a periodic basis, or based on usage. |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/data
{ "items": [{ "id": 3023202293, "partNumber": "Car Cover", "dateModified": "2024-01-26T20:59:13Z", "dateAdded": "2024-01-26T20:59:13Z", "prices": [{ "currencyCode": "USD", "value": 900 } ], "chargeDefinitionId": -1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/data/3023202293" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/data" } ], "chargeType": "ORA_SALE", "priceType": "One Time", "primaryCharge": true, "dynamicPricingType": "static", "ratePlanName": "Basic Plan", "blockSize": 1 }, { "id": 3023202282, "partNumber": "Floor Mats", "dateModified": "2024-01-26T20:40:40Z", "dateAdded": "2024-01-26T20:40:40Z", "prices": [{ "currencyCode": "USD", "value": 300 } ], "chargeDefinitionId": -1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/data/3023202282" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/data" } ], "chargeType": "ORA_SALE", "priceType": "One Time", "primaryCharge": true, "dynamicPricingType": "static", "blockSize": 1 } ], "offset": 0, "limit": 1000, "count": 2, "hasMore": false, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/data" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/data?offset=0&limit=1000" } ] }
Get Price Agreement Pricing Data Item
|
Description |
Use this endpoint to retrieve the specified price agreement pricing data item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/data/{id} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
id |
The unique identifier of the data item |
|
|
(Optional) This endpoint supports the |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
blockPrices |
The block price |
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
The category of the charge |
|
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation date of the charge |
|
|
dateModified |
Last modified date of the charge |
|
|
dynamicPricingType |
The dynamic pricing type of the price agreement charge. Allowed Values: |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. | |
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
The basis on which a price or charge is levied, whether one time, on a periodic basis, or based on usage. |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/data/3023202282
{ "id": 3023202282, "partNumber": "Floor Mats", "dateModified": "2024-01-26T20:40:40Z", "dateAdded": "2024-01-26T20:40:40Z", "prices": [{ "currencyCode": "USD", "value": 300 } ], "chargeDefinitionId": -1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/data/3023202282" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/data" } ], "chargeType": "ORA_SALE", "priceType": "One Time", "primaryCharge": true, "dynamicPricingType": "static", "serviceDuration": -1, "blockSize": 1 }
Update Price Agreement Pricing Data
|
Description |
Use this endpoint to update pricing data for the specified price agreement. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/data |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
The array of price agreement pricing data patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", and "replace". | |
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target value. Refer to Update a Price Agreement Pricing Data Item for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/data
[{ "op": "replace", "path": "/3023119071", "value": { "prices": [{ "currencyCode": "USD", "value": 9999 } ], "blockPrices": [] } } ]
Price Agreement Item Charges
|
Description |
Use this endpoint to add a charge to the specified price agreement item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/charges |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
HTTP Method |
POST |
|
| Request Body Parameters |
blockPrices |
The block price |
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
The category of the charge |
|
|
dynamicPricingType |
The dynamic pricing type of the price agreement charge. Allowed Values: |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
The basis on which a price or charge is levied, whether one time, on a periodic basis, or based on usage. |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
startDate |
The date from which the charge will be applicable |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
| Response Body Parameters |
JSON data for the newly added price agreement charge. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/a1aaccount11/priceAgreementItems/3023168048/charges
{ "prices": [{ "currencyCode": "USD", "value": 100 } ], "primaryCharge": false, "chargeType": "ORA_SALE", "priceType": "One Time", "dynamicPricingType": "static" }
{ "id": 3023203512, "dateModified": "2024-01-30T17:04:55Z", "dateAdded": "2024-01-30T17:04:55Z", "prices": [{ "currencyCode": "USD", "value": 100 } ], "chargeDefinitionId": -1, "primaryCharge": false, "chargeType": "ORA_SALE", "priceType": "One Time", "dynamicPricingType": "static", "blockSize": 1 }
|
Description |
Use this endpoint to delete the specified price agreement item charge. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/charges/{id} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
id |
The unique identifier of the charge |
|
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve the specified a price agreement item charge. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/charges/{id} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
id |
The unique identifier of the charge |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
blockPrices |
The block price |
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
The category of the charge |
|
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation date of the charge |
|
|
dateModified |
Last modified date of the charge |
|
|
dynamicPricingType |
The dynamic pricing type of the price agreement charge. Allowed Values: |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. | |
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
The basis on which a price or charge is levied, whether one time, on a periodic basis, or based on usage. |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/charges/3023202282
{ "id": 3023202282, "dateModified": "2024-01-26T20:40:40Z", "dateAdded": "2024-01-26T20:40:40Z", "prices": [{ "currencyCode": "USD", "value": 300 } ], "chargeDefinitionId": -1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/charges/3023202282" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/charges" } ], "primaryCharge": true, "chargeType": "ORA_SALE", "priceType": "One Time", "dynamicPricingType": "static", "blockSize": 1 }
|
Description |
Use this endpoint to retrieve all charges for the specified price agreement item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/charges |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of charges for the specified price agreement. |
|
|
blockPrices |
The block price |
|
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
The category of the charge |
|
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation date of the charge |
|
|
dateModified |
Last modified date of the charge |
|
|
dynamicPricingType |
The dynamic pricing type of the price agreement charge. Allowed Values: |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. | |
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
The basis on which a price or charge is levied, whether one time, on a periodic basis, or based on usage. |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/charges
{ "items": [{ "id": 3023202282, "dateModified": "2024-01-26T20:40:40Z", "dateAdded": "2024-01-26T20:40:40Z", "prices": [{ "currencyCode": "USD", "value": 300 } ], "chargeDefinitionId": -1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/charges/3023202282" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/charges" } ], "primaryCharge": true, "chargeType": "ORA_SALE", "priceType": "One Time", "dynamicPricingType": "static", "blockSize": 1 } ], "offset": 0, "limit": 1000, "count": 1, "hasMore": true, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/charges" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/charges?offset=0&limit=1000" }, { "rel": "next", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/charges?offset=1000&limit=1000" } ] }
Update a Price Agreement Charge
|
Description |
Use this endpoint to update the specified price agreement item charge. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17//pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/charges/{id} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
id |
The unique identifier of the charge |
|
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
blockPrices |
The block price |
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
The category of the charge |
|
|
dynamicPricingType |
The dynamic pricing type of the price agreement charge. Allowed Values: |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
The basis on which a price or charge is levied, whether one time, on a periodic basis, or based on usage. |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/promoAPIaccount112/priceAgreementItems/3023155942/charges/3023155943
{ "prices": [{ "currencyCode": "USD", "value": 200 } ], "chargeType": "ORA_SALE", "priceType": "One Time", "dynamicPricingType": "static" }
Update Price Agreement Charges
|
Description |
Use this endpoint to update charges for the specified price agreement item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17//pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/charges |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
The array of pricing patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", and "replace". | |
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target value. Refer to Add Price Agreement Charge for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/promoAPIaccount112/priceAgreementItems/3023155942/charges
[{ "op": "replace", "path": "/3023155943", "value": { "prices": [{ "currencyCode": "USD", "value": 9999 } ], "blockPrices": [] } } ]
Price Agreement Item Rate Plans
|
Description |
Use this endpoint to add a rate plan to the specified price agreement item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
HTTP Method |
POST |
|
| Request Body Parameters |
chargeCount |
The count of charges directly associated with rate plan |
|
charges |
The charges associated with this rate plan |
|
|
description |
The description of the rate plan |
|
|
endDate |
The date at which the rate will plan end |
|
|
integrationId |
The integration Id of the rate plan |
|
|
name |
The name of the rate plan |
|
|
orderNumber |
The position in an ordered list of rate plans |
|
|
priceModelItemId |
The price agreement item ID |
|
|
ratePlanNumber |
Unique variable name of the rate plan |
|
|
startDate |
The date from which the charge will be applicable |
|
| Response Body Parameters |
JSON data for the newly added price agreement rate plan. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans
{ "description": "test", "name": "jtai rate plan 4", "ratePlanNumber": "jtaiRatePlan4", "priceModelItemId": 3023136883 }
{ "dateAdded": "2024-01-30T16:55:35Z", "dateModified": "2024-01-30T16:55:35Z", "description": "test", "name": "jtai rate plan 4", "ratePlanNumber": "jtaiRatePlan4", "priceModelItemId": 3023202291, "chargeCount": 0, "orderNumber": 2 }
Delete Price Agreement Rate Plan
|
Description |
Use this endpoint to delete the specified price agreement item rate plan. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
ratePlanNumber |
The variable name of the rate plan |
|
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve the specified price agreement item rate plan. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
ratePlanNumber |
The variable name of the rate plan |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
chargeCount |
The count of charges directly associated with rate plan |
|
charges |
The charges associated with this rate plan |
|
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation date of the rate plan |
|
|
dateModified |
Last modified date of the rate plan |
|
|
description |
The description of the rate plan |
|
|
endDate |
The date at which the rate will plan end |
|
|
integrationId |
The integration Id of the rate plan |
|
|
lastModifiedBy |
The details of the user who modified the record. | |
|
name |
The name of the rate plan |
|
|
orderNumber |
The position in an ordered list of rate plans |
|
|
priceModelItemId |
The price agreement item ID |
|
|
ratePlanNumber |
Unique variable name of the rate plan |
|
|
startDate |
The date from which the charge will be applicable |
|
https://sitename.oracle.com/rest/v17/pricingSetup//agreements/agreementAPIaccount112/priceAgreementItems/3023202276/ratePlans/basicPlan
{ "dateAdded": "2024-01-26T20:59:02Z", "dateModified": "2024-01-26T20:59:02Z", "description": "", "endDate": "2024-04-27T07:00:00Z", "name": "Basic Plan", "ratePlanNumber": "basicPlan", "startDate": "2024-01-26T08:00:00Z", "priceModelItemId": 3023202291, "chargeCount": 1, "orderNumber": 1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans/basicPlan" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans/basicPlan/charges" } ] }
Get Price Agreement Rate Plans
|
Description |
Use this endpoint to retrieve all rate plans for the specified price agreement item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of price agreement rate plans. |
|
|
chargeCount |
The count of charges directly associated with rate plan |
|
|
charges |
The charges associated with this rate plan |
|
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation date of the rate plan |
|
|
dateModified |
Last modified date of the rate plan |
|
|
description |
The description of the rate plan |
|
|
endDate |
The date at which the rate will plan end |
|
|
integrationId |
The integration Id of the rate plan |
|
|
lastModifiedBy |
The details of the user who modified the record. | |
|
name |
The name of the rate plan |
|
|
orderNumber |
The position in an ordered list of rate plans |
|
|
priceModelItemId |
The price agreement item ID |
|
|
ratePlanNumber |
Unique variable name of the rate plan |
|
|
startDate |
The date from which the Charge will be applicable |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/ratePlans
{ "items": [{ "dateAdded": "2024-01-26T20:59:02Z", "dateModified": "2024-01-26T20:59:02Z", "description": "", "endDate": "2024-04-27T07:00:00Z", "name": "Basic Plan", "ratePlanNumber": "basicPlan", "startDate": "2024-01-26T08:00:00Z", "priceModelItemId": 3023202291, "chargeCount": 1, "orderNumber": 1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans/basicPlan" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans/basicPlan/charges" } ] } ], "offset": 0, "limit": 1000, "count": 1, "hasMore": false, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans?offset=0&limit=1000" } ] }
Update a Price Agreement Rate Plan
|
Description |
Use this endpoint to update the specified price agreement item rate plan. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
ratePlanNumber |
The variable name of the rate plan |
|
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
charges |
The charges associated with this rate plan |
|
description |
The description of the rate plan |
|
|
endDate |
The date at which the rate will plan end |
|
|
integrationId |
The integration Id of the rate plan |
|
|
name |
The name of the rate plan |
|
|
orderNumber |
The position in an ordered list of rate plans |
|
|
priceModelItemId |
The price agreement item ID |
|
|
ratePlanNumber |
Unique variable name of the rate plan |
|
|
startDate |
The date from which the charge will be applicable |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/models/_defaultPriceModel/priceModelItems/36947090/ratePlans/ratePlan1/charges/3022960005
{ "prices": [{ "currencyCode": "USD", "value": 30 }, { "currencyCode": "GBP", "value": 40 }, { "currencyCode": "JPY", "value": 50 } ] }
Update Price Agreement Rate Plans
|
Description |
Use this endpoint to update rate plans for the specified price agreement item. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17//pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
The array of price agreement rate plan patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", and "replace". | |
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target value. Refer to Add Price Agreement Rate Plan for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/promoAPIaccount112/priceAgreementItems/3023155942/ratePlans
[{ "op": "add", "path": "/", "value": { "description": "test", "name": "rate 2", "ratePlanNumber": "rate2", "priceModelItemId": 3023155942 } } ]
Price Agreement Item Rate Plan Charges
Add Price Agreement Rate Plan Charge
|
Description |
Use this endpoint to add a charge to the specified price agreement item rate plan. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
ratePlanNumber |
The variable name of the rate plan |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
blockPrices |
The block price |
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
The category of the charge |
|
|
dynamicPricingType |
The dynamic pricing type of the price agreement charge. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", or "attributeBasedCharge" |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
The basis on which a price or charge is levied, whether one time, on a periodic basis, or based on usage. |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
| Response Body Parameters |
JSON data for the newly added price agreement rate plan charge |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans/basicPlan/charges
{ "prices": [{ "currencyCode": "USD", "value": 90000 } ], "primaryCharge": false, "chargeType": "ORA_SALE", "priceType": "One Time", "dynamicPricingType": "static" }
{ "id": 3023203503, "dateModified": "2024-01-30T16:49:30Z", "dateAdded": "2024-01-30T16:49:30Z", "prices": [{ "currencyCode": "USD", "value": 90000 } ], "chargeDefinitionId": -1, "primaryCharge": false, "chargeType": "ORA_SALE", "priceType": "One Time", "dynamicPricingType": "static", "blockSize": 1 }
Delete Price Agreement Rate Plan Charge
|
Description |
Use this endpoint to delete the specified price agreement item rate plan charge. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetupagreem/ents/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges/{id} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
ratePlanNumber |
The variable name of the rate plan |
|
|
id |
The unique identifier of the charge |
|
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
Get Price Agreement Rate Plan Charge
|
Description |
Use this endpoint to retrieve the specified price agreement item rate plan charge. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges/{id} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
ratePlanNumber |
The variable name of the rate plan |
|
|
id |
The unique identifier of the charge |
|
|
(Optional) This endpoint supports the |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
blockPrices |
The block price |
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
The category of the charge |
|
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation date of the charge |
|
|
dateModified |
Last modified date of the charge |
|
|
dynamicPricingType |
The dynamic pricing type of the price agreement charge. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", or "attributeBasedCharge" |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. | |
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
The basis on which a price or charge is levied, whether one time, on a periodic basis, or based on usage. |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/ratePlans/basicPlan/charges/3023202293
{ "id": 3023202293, "dateModified": "2024-01-26T20:59:13Z", "dateAdded": "2024-01-26T20:59:13Z", "prices": [{ "currencyCode": "USD", "value": 900 } ], "chargeDefinitionId": -1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans/basicPlan/charges/3023202293" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans/basicPlan/charges" } ], "primaryCharge": true, "chargeType": "ORA_SALE", "priceType": "One Time", "dynamicPricingType": "static", "blockSize": 1 }
Get Price Agreement Rate Plan Charges
|
Description |
Use this endpoint to retrieve all charges for the specified price agreement item rate plan. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
ratePlanNumber |
The variable name of the rate plan |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of price agreement rate plan charges. |
|
|
blockPrices |
The block price |
|
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
The category of the charge |
|
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation date of the charge |
|
|
dateModified |
Last modified date of the charge |
|
|
dynamicPricingType |
The dynamic pricing type of the price agreement charge. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", or "attributeBasedCharge" |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. | |
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
The basis on which a price or charge is levied, whether one time, on a periodic basis, or based on usage. |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202276/ratePlans/basicPlan/charges
{ "items": [{ "id": 3023202293, "dateModified": "2024-01-26T20:59:13Z", "dateAdded": "2024-01-26T20:59:13Z", "prices": [{ "currencyCode": "USD", "value": 900 } ], "chargeDefinitionId": -1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans/basicPlan/charges/3023202293" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans/basicPlan/charges" } ], "primaryCharge": true, "chargeType": "ORA_SALE", "priceType": "One Time", "dynamicPricingType": "static", "blockSize": 1 } ], "offset": 0, "limit": 1000, "count": 1, "hasMore": true, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans/basicPlan" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans/basicPlan/charges" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans/basicPlan/charges?offset=0&limit=1000" }, { "rel": "next", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans/basicPlan/charges?offset=1000&limit=1000" } ] }
Update a Price Agreement Rate Plan Charge
|
Description |
Use this endpoint to update the specified price agreement item rate plan charge. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges/{id} |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
ratePlanNumber |
The variable name of the Pricing Rate Plan |
|
|
id |
The unique identifier of the charge |
|
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
blockPrices |
The block price |
|
blockSize |
The block size |
|
|
chargeDefinition |
Display name of the charge definition | |
|
chargeDefinitionCode |
The unique code of the charge definition |
|
|
chargeDefinitionId |
ID of the charge definition |
|
|
chargeType |
The category of the charge |
|
|
dynamicPricingType |
The dynamic pricing type of the price agreement charge. Allowed Values: "static", "advanced", "volume", "tiered", "rateCard", or "attributeBasedCharge" |
|
|
endDate |
The date at which the charge will end |
|
|
id |
The unique identifier of the charge |
|
|
integrationId |
Integration ID |
|
|
pricePeriod |
The billing period |
|
|
prices |
An array of the prices (currency code and value) |
|
|
priceType |
The basis on which a price or charge is levied, whether one time, on a periodic basis, or based on usage. |
|
|
primaryCharge |
Indicates whether this is the primary charge |
|
|
rateCardName |
Rate card name (Preview only. Not available for use) |
|
|
rateCardVariableName |
Rate card variable name (Preview only. Not available for use) |
|
|
startDate |
The date from which the charge will be applicable |
|
|
tiers |
An array of the range from, range to, and prices | |
|
usageUOM |
The unit of measure for the charge | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/promoAPIaccount112/priceAgreementItems/3023155942/ratePlans/rateAPI/charges/3023156096
{ "prices": [{ "currencyCode": "USD", "value": 200 } ], "chargeType": "ORA_SALE", "priceType": "One Time", "dynamicPricingType": "static" }
Update Price Agreement Rate Plan Charges
|
Description |
Use this endpoint to update charges for the specified price agreement item rate plan. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges |
|
|
Endpoint Parameters |
agreementVariableName |
The variable name of the price agreement |
|
priceAgreementItemId |
The unique identifier of the price agreement item | |
|
ratePlanNumber |
The variable name of the Pricing Rate Plan |
|
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
The array of price agreement rate plan charge patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", and "replace". | |
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target value. Refer to Add Price Agreement Rate Plan Charge for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreements/agreementAPIaccount112/priceAgreementItems/3023202291/ratePlans/basicPlan/charges
[{ "op": "replace", "path": "/3022960005", "value": { "prices": [{ "currencyCode": "USD", "value": 10 }, { "currencyCode": "GBP", "value": 20 }, { "currencyCode": "JPY", "value": 30 } ] } } ]
