Overview
These endpoints enable administration of Rate Cards and Rate Card Templates using REST API services.
Administration
Rate Cards
|
Description |
Use this endpoint to add a rate card. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCards |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
active |
Indicates if the pricing matrix is active |
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
allowedUsageUOM |
The usage UOM lookup code that this pricing matrix will apply to |
|
|
data |
An array of pricing matrix data | |
|
description |
Description of the pricing matrix | |
|
name |
Name of the pricing matrix |
|
|
priceModelCount |
The count of pricing models linked to this pricing matrix | |
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateVariableName |
The variable name of the pricing matrix template | |
|
variableName |
Variable name of the pricing matrix |
|
| Response Body Parameters |
JSON data for the rate card. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCards
{ "name": "Zoom Phone Calling Card", "variableName": "zoomPhoneCallingCard", "templateVariableName": "zoomPhoneCallingTemplate", "description": "" }
{ "templateVariableName": "zoomPhoneCallingTemplate", "name": "Zoom Phone Calling Card", "variableName": "zoomPhoneCallingCard", "description": "", "active": true, "dateAdded": "2023-09-27T18:01:48Z", "dateModified": "2023-09-27T18:01:48Z" }
|
Description |
Use this endpoint to delete a rate card. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCards/{rateCardVariableName} |
|
|
Endpoint Parameters |
rateCardVariableName |
The variable name of the rate card. |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve all rate cards. | |
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCards |
|
|
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 rate cards. |
|
|
active |
Indicates if the pricing matrix is active |
|
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
allowedUsageUOM |
The usage UOM lookup code that this pricing matrix will apply to |
|
|
createdBy |
The details of the user who created the record. |
|
|
data |
An array of pricing matrix data | |
|
dateAdded |
Creation date of the pricing matrix |
|
|
dateModified |
Last modified date of the pricing matrix |
|
|
description |
Description of the pricing matrix | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
name |
Name of the pricing matrix |
|
|
priceModelCount |
The count of pricing models linked to this pricing matrix | |
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateVariableName |
The variable name of the pricing matrix template | |
|
variableName |
Variable name of the pricing matrix |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCards
{ "items": [{ "name": "NA Phone Call Rate Card", "variableName": "naPhoneRateCard", "description": "", "active": true, "template": { "name": "Zoom Phone Call Template", "variableName": "zoomPhoneCallTemplate" }, "priceModelCount": 3 }, { "name": "APAC Phone Call Rate Card", "variableName": "apacPhoneRateCard", "description": "", "active": true, "template": { "name": "Zoom Phone Call Template", "variableName": "zoomPhoneCallTemplate" }, "priceModelCount": 0 }, { "name": "Enterprise Data Usage Rate Card", "variableName": "enterpriseDataUsageRateCard", "description": "", "active": true, "template": { "name": "Data Usage Rate Template", "variableName": "dataUsageRateTemplate" }, "priceModelCount": 2 } ], "offset": 0, "limit": 25, "count": 3, "totalResults": 3, "hasMore": false, "links": [{ "rel": "string", "href": "string" } ] }
|
Description |
Use this endpoint to retrieve the specified rate card. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCards/{rateCardVariableName} |
|
|
Endpoint Parameters |
rateCardVariableName |
The variable name of the rate card |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
active |
Indicates if the pricing matrix is active |
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
allowedUsageUOM |
The usage UOM lookup code that this pricing matrix will apply to |
|
|
createdBy |
The details of the user who created the record. |
|
|
data |
An array of pricing matrix data | |
|
dateAdded |
Creation date of the pricing matrix |
|
|
dateModified |
Last modified date of the pricing matrix |
|
|
description |
Description of the pricing matrix | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
name |
Name of the pricing matrix |
|
|
priceModelCount |
The count of pricing models linked to this pricing matrix | |
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateVariableName |
The variable name of the pricing matrix template | |
|
variableName |
Variable name of the pricing matrix |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/naPhoneRateCard?expand=all
{ "name": "NA Phone Call Rate Card", "variableName": "naPhoneRateCard", "description": "", "active": true, "priceModelCount": 3, "dateAdded": "", "dateModified": "", "data": { "items": [{ "fromCountry": "US", "toCountry": "Canada", "rate": [{ "currencyCode": "USD", "value": 1.20 }, { "currencyCode": "CAD", "value": 1.35 } ] }, { "fromCountry": "US", "toCountry": "Mexico", "rate": [{ "currencyCode": "USD", "value": 1.20 }, { "currencyCode": "CAD", "value": 1.35 } ] }, { "fromCountry": "US", "toCountry": "India", "rate": [{ "currencyCode": "USD", "value": 1.20 }, { "currencyCode": "CAD", "value": 1.35 } ] }, { "fromCountry": "US", "toCountry": "Britain", "rate": [{ "currencyCode": "USD", "value": 1.20 }, { "currencyCode": "CAD", "value": 1.35 } ] } ] }, "template": { "name": "test4", "variableName": "test4" } }
|
Description |
Use this endpoint to retrieve data for the specified rate card. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCards/{rateCardVariableName}/data |
|
|
Endpoint Parameters |
rateCardVariableName |
The variable name of the rate card |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
An array of pricing matrix data items |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the pricing matrix data item |
|
|
dateModified |
Last modified date of the pricing matrix data item |
|
|
id |
The unique identifier of the pricing matrix data item |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
... |
Additional fields as specified in the associated pricing matrix template |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/zoomPhoneCallingCard/data
{ "items": [{ "id": 36991428, "dateAdded": "2023-09-27T18:09:01Z", "dateModified": "2023-09-27T18:09:01Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/zoomPhoneCallingCard/data/36991428" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/zoomPhoneCallingCard/data" } ], "fromCountry": "US", "rate": [{ "currencyCode": "USD", "value": 0.1 } ], "toCountry": "Canada" }, { "id": 36991430, "dateAdded": "2023-09-27T18:09:01Z", "dateModified": "2023-09-27T18:09:01Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/zoomPhoneCallingCard/data/36991430" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/zoomPhoneCallingCard/data" } ], "fromCountry": "US", "rate": [{ "currencyCode": "USD", "value": 0.15 } ], "toCountry": "Mexico" }, { "id": 36991432, "dateAdded": "2023-09-27T18:09:01Z", "dateModified": "2023-09-27T18:09:01Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/zoomPhoneCallingCard/data/36991432" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/zoomPhoneCallingCard/data" } ], "fromCountry": "US", "rate": [{ "currencyCode": "USD", "value": 0.2 } ], "toCountry": "India" }, { "id": 36991434, "dateAdded": "2023-09-27T18:09:01Z", "dateModified": "2023-09-27T18:09:01Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/zoomPhoneCallingCard/data/36991434" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/zoomPhoneCallingCard/data" } ], "fromCountry": "US", "rate": [{ "currencyCode": "USD", "value": 0.4 } ], "toCountry": "UK" } ], "offset": 0, "limit": 1000, "count": 4, "hasMore": false, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/zoomPhoneCallingCard" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/zoomPhoneCallingCard/data" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/zoomPhoneCallingCard/data?offset=0&limit=1000" } ] }
|
Description |
Use this endpoint to update the specified rate card. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCards/{rateCardVariableName} |
|
|
Endpoint Parameters |
rateCardVariableName |
The variable name of the rate card. |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
The array of pricing patch operations. |
|
|
active |
Indicates if the pricing matrix is active |
|
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
allowedUsageUOM |
The usage UOM lookup code that this pricing matrix will apply to |
|
|
data |
An array of pricing matrix data | |
|
description |
Description of the pricing matrix | |
|
name |
Name of the pricing matrix |
|
|
priceModelCount |
The count of pricing models linked to this pricing matrix | |
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateVariableName |
The variable name of the pricing matrix template | |
|
variableName |
Variable name of the pricing matrix |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/naPhoneRateCard
{ "name": "NA Internet Data Usage Rate", "active": false, "description": "U.S. Enterprise Discount" }
|
Description |
Use this endpoint to add, update, or delete rate card data. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCards/{rateCardVariableName}/data |
|
|
Endpoint Parameters |
rateCardVariableName |
The variable name of the rate card. |
|
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 for the pricing matrix data items as specified in the associated pricing matrix template. Refer to Get Rate Card Data | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/naPhoneRateCard/data
[{ "op": "add", "path": "/", "value": { "fromCountry": "US", "toCountry": "Canada", "rate": [{ "currencyCode": "USD", "value": 0.10 }, { "currencyCode": "CAD", "value": 0.20 } ], "id": -1 } }, { "op": "add", "path": "/", "value": { "fromCountry": "US", "toCountry": "UK", "rate": [{ "currencyCode": "USD", "value": 0.15 }, { "currencyCode": "CAD", "value": 0.30 } ], "id": -2 } }, { "op": "remove", "path": "/12345" }, { "op": "replace", "path": "/12346", "value": { "fromCountry": "US", "toCountry": "India", "rate": [{ "currencyCode": "USD", "value": 0.10 }, { "currencyCode": "CAD", "value": 0.30 } ] } } ]
Rate Card Templates
|
Description |
Use this endpoint to add a rate card template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
active |
Indicates if the pricing matrix is active |
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
columns |
List of columns for the pricing matrix template. This field is Ignored for rate card templates. |
|
|
data |
An array of pricing matrix data | |
|
description |
Description of the pricing matrix | |
|
name |
Name of the pricing matrix |
|
|
priceMatrixCount |
The count of pricing matrices linked to this template | |
|
rateCardCount |
The count of rate cards linked to this template |
|
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard" or "attributeBasedCharge" |
|
|
variableName |
Variable name of the pricing matrix template |
|
| Response Body Parameters |
JSON data for the newly added rate card template. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates
{ "name": "Zoom Phone Calling Template", "variableName": "zoomPhoneCallingTemplate", "description": "New rate card template description." }
{ "name": "Zoom Phone Calling Template", "variableName": "zoomPhoneCallingTemplate", "active": true, "description": "New rate card template description.", "dateAdded": "2023-09-27T16:42:18Z", "dateModified": "2023-09-27T16:42:18Z" }
|
Description |
Use this endpoint to add a column to the specified rate card template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName}/columns |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the rate card template |
|
HTTP Method |
POST |
|
| Request Body Parameters |
active |
Indicates if the rate card template is active |
|
dataType |
Data type of the rate card template column. Allowed Values: "Boolean", "Currency", "String", "Decimal", "Date", or "Integer" |
|
|
defaultOverridable |
Indicates if the default value is overridable |
|
|
defaultValue |
Default value of the rate card template column |
|
|
description |
Description of the rate card template column | |
|
id |
The unique identifier of the rate card template column |
|
|
integrationId |
Identifier for the corresponding entity in Fusion Pricing. |
|
|
ioType |
The Input/Output type of the pricing matrix column. Allowed Values: "input" or "output" |
|
|
key |
Indicates if the rate card template column is a key |
|
|
lookupType |
Lookup type of the rate card template column |
|
|
lookupTypeLabel |
The lookup type display label of the rate card template column |
|
|
name |
Name of the rate card template column. |
|
|
negotiable |
Indicates if the value stores in this rate card template column is negotiable |
|
|
operator |
The operator to be applied on this pricing matrix column. Allowed Values: "none", "<", "<=", "Not =", "=", ">", ">=", "Contains", "Not Contains", "Starts With", "Not Starts With", "Ends With", or "Not Ends With" |
|
|
orderNumber |
The sequence number of the column in the template |
|
|
pricingAttribute |
The pricing attribute referenced to for this pricing matrix column |
|
|
required |
Indicates if the value of this rate card template column is required |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard" or "attributeBasedCharge" |
|
|
variableName |
Variable name of the rate card template column |
|
|
wildCardSupported |
Indicates if this column supports wild card values |
|
| Response Body Parameters |
JSON data for the newly added rate card template column. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/zoomPhoneCallingTemplate/columns
{ "name": "From Country", "variableName": "fromCountry", "key": true, "dataType": "String", "lookupType": null, "defaultValue": "US", "defaultOverridable": true, "description": "From Country column", "negotiable": false, "required": true }
{ "name": "From Country", "variableName": "fromCountry", "key": true, "dataType": "String", "defaultValue": "US", "defaultOverridable": true, "description": "From Country column", "active": true, "negotiable": false, "required": true, "dateAdded": "2023-09-27T17:51:20Z", "dateModified": "2023-09-27T17:51:20Z" }
|
Description |
Use this endpoint to delete the specified rate card template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the rate card template |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
Delete Rate Card Template Column
|
Description |
Use this endpoint to delete a rate card template column. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName}/columns/{id}} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the rate card template |
|
id |
The unique identifier of the rate card template column |
|
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve all rate card templates. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates |
|
|
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 rate card template items |
|
|
active |
Indicates if the pricing matrix is active |
|
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
columns |
List of columns for the pricing matrix template. This field is Ignored for rate card templates. |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the pricing matrix |
|
|
dateModified |
Last modified date of the pricing matrix |
|
|
description |
Description of the pricing matrix | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
name |
Name of the pricing matrix |
|
|
priceMatrixCount |
The count of pricing matrices linked to this template | |
|
rateCardCount |
The count of rate cards linked to this template |
|
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard" or "attributeBasedCharge" |
|
|
variableName |
Variable name of the pricing matrix template |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates
{ "items": [{ "name": "Data Usage Rate Card Template", "variableName": "dataUsageRateCardTemplate", "active": true, "description": "Data rate per market (North America, Latin America, EMEA, APAC)", "rateCardCount": 1, "dateAdded": "2023-08-25T13:56:51Z", "dateModified": "2023-08-25T13:56:51Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns" } ] }, { "name": "Volume Rate Card Template", "variableName": "volumeRateCardTemplate", "active": true, "description": "Access rates based on usage (per Gb)", "rateCardCount": 1, "dateAdded": "2023-08-25T13:41:37Z", "dateModified": "2023-08-25T13:41:37Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/volumeRateCardTemplate" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/volumeRateCardTemplate/columns" } ] }, { "name": "Tech Support Rate Card Template", "variableName": "techSupportRateCardTemplate", "active": true, "description": "", "rateCardCount": 1, "dateAdded": "2023-08-25T14:00:02Z", "dateModified": "2023-08-25T14:00:02Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/techSupportRateCardTemplate" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/techSupportRateCardTemplate/columns" } ] }, { "name": "New Rate Card Template", "variableName": "newRateCardTemplate_c", "active": true, "description": "New rate card template description.", "rateCardCount": 0, "dateAdded": "2023-09-26T20:25:03Z", "dateModified": "2023-09-26T20:25:03Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/newRateCardTemplate_c" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/newRateCardTemplate_c/columns" } ] } ], "offset": 0, "limit": 1000, "count": 4, "hasMore": false, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates?offset=0&limit=1000" } ] }
|
Description |
Use this endpoint to retrieve the specified rate card template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the rate card template. |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
active |
Indicates if the pricing matrix is active |
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
columns |
List of columns for the pricing matrix template. This field is Ignored for rate card templates. |
|
|
createdBy |
The details of the user who created the record. |
|
|
dateAdded |
Creation date of the pricing matrix |
|
|
dateModified |
Last modified date of the pricing matrix |
|
|
description |
Description of the pricing matrix | |
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
name |
Name of the pricing matrix |
|
|
priceMatrixCount |
The count of pricing matrices linked to this template | |
|
rateCardCount |
The count of rate cards linked to this template |
|
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard" or "attributeBasedCharge" |
|
|
variableName |
Variable name of the pricing matrix template |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate
{ "name": "Data Usage Rate Card Template", "variableName": "dataUsageRateCardTemplate", "active": true, "description": "Data rate per market (North America, Latin America, EMEA, APAC)", "rateCardCount": 1, "dateAdded": "2023-08-25T13:56:51Z", "dateModified": "2023-08-25T13:56:51Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns" } ] }
Get Rate Card Template Columns
|
Description |
Use this endpoint to retrieve all columns for the specified rate card template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName}/columns |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the rate card template |
|
(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 rate card template column items. |
|
|
active |
Indicates if the rate card template is active |
|
|
createdBy |
The details of the user who created the record. |
|
|
dataType |
Data type of the rate card template column. Allowed Values: "Boolean", "Currency", "String", "Decimal", "Date", or "Integer" |
|
|
dateAdded |
Creation date of the rate card template column |
|
|
dateModified |
Last modified date of the rate card template column |
|
|
defaultOverridable |
Indicates if the default value is overridable |
|
|
defaultValue |
Default value of the rate card template column |
|
|
description |
Description of the rate card template column | |
|
id |
The unique identifier of the rate card template column |
|
|
integrationId |
Identifier for the corresponding entity in Fusion Pricing. |
|
|
ioType |
The Input/Output type of the pricing matrix column. Allowed Values: "input" or "output" |
|
|
key |
Indicates if the rate card template column is a key |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
lookupType |
Lookup type of the rate card template column |
|
|
lookupTypeLabel |
The lookup type display label of the rate card template column |
|
|
name |
Name of the rate card template column. |
|
|
negotiable |
Indicates if the value stores in this rate card template column is negotiable |
|
|
operator |
The operator to be applied on this pricing matrix column. Allowed Values: "none", "<", "<=", "Not =", "=", ">", ">=", "Contains", "Not Contains", "Starts With", "Not Starts With", "Ends With", or "Not Ends With" |
|
|
orderNumber |
The sequence number of the column in the template |
|
|
pricingAttribute |
The pricing attribute referenced to for this pricing matrix column |
|
|
required |
Indicates if the value of this rate card template column is required |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard" or "attributeBasedCharge" |
|
|
variableName |
Variable name of the rate card template column |
|
|
wildCardSupported |
Indicates if this column supports wild card values |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns
{ "items": [{ "id": 36956277, "orderNumber": 1, "name": "Market", "variableName": "market", "key": true, "dataType": "String", "lookupType": "globalMarkets_c", "lookupTypeLabel": "Global Markets", "defaultOverridable": false, "description": "", "active": true, "negotiable": false, "required": false, "dateAdded": "2023-08-25T13:57:36Z", "dateModified": "2023-08-25T13:57:36Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns/36956277" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns" } ] }, { "id": 36956278, "orderNumber": 2, "name": "Rate", "variableName": "rate", "key": false, "dataType": "Currency", "defaultOverridable": false, "description": "", "active": true, "negotiable": false, "required": false, "dateAdded": "2023-08-25T13:58:03Z", "dateModified": "2023-08-25T13:58:03Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns/36956278" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns" } ] } ], "offset": 0, "limit": 1000, "count": 2, "hasMore": false, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns?offset=0&limit=1000" } ] }
|
Description |
Use this endpoint to retrieve a rate card template column. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName}/columns/{id} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the rate card template. |
|
id |
The Unique Identifier of the rate card template column. |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
active |
Indicates if the rate card template is active |
|
createdBy |
The details of the user who created the record. |
|
|
dataType |
Data type of the rate card template column. Allowed Values: "Boolean", "Currency", "String", "Decimal", "Date", or "Integer" |
|
|
dateAdded |
Creation date of the rate card template column |
|
|
dateModified |
Last modified date of the rate card template column |
|
|
defaultOverridable |
Indicates if the default value is overridable |
|
|
defaultValue |
Default value of the rate card template column |
|
|
description |
Description of the rate card template column | |
|
id |
The unique identifier of the rate card template column |
|
|
integrationId |
Identifier for the corresponding entity in Fusion Pricing. |
|
|
ioType |
The Input/Output type of the pricing matrix column. Allowed Values: "input" or "output" |
|
|
key |
Indicates if the rate card template column is a key |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
lookupType |
Lookup type of the rate card template column |
|
|
lookupTypeLabel |
The lookup type display label of the rate card template column |
|
|
name |
Name of the rate card template column. |
|
|
negotiable |
Indicates if the value stores in this rate card template column is negotiable |
|
|
operator |
The operator to be applied on this pricing matrix column. Allowed Values: "none", "<", "<=", "Not =", "=", ">", ">=", "Contains", "Not Contains", "Starts With", "Not Starts With", "Ends With", or "Not Ends With" |
|
|
orderNumber |
The sequence number of the column in the template |
|
|
pricingAttribute |
The pricing attribute referenced to for this pricing matrix column |
|
|
required |
Indicates if the value of this rate card template column is required |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard" or "attributeBasedCharge" |
|
|
variableName |
Variable name of the rate card template column |
|
|
wildCardSupported |
Indicates if this column supports wild card values |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns/36956277
{ "id": 36956277, "orderNumber": 1, "name": "Market", "variableName": "market", "key": true, "dataType": "String", "lookupType": "globalMarkets_c", "defaultOverridable": false, "description": "", "active": true, "negotiable": false, "required": false, "dateAdded": "2023-08-25T13:57:36Z", "dateModified": "2023-08-25T13:57:36Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns/36956277" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns" } ] }
|
Description |
Use this endpoint to update the specified rate card template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the rate card template |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
active |
Indicates if the pricing matrix is active |
|
allowedChargeDefinitions |
The list of charge definitions that this pricing matrix will apply to |
|
|
columns |
List of columns for the pricing matrix template. This field is Ignored for rate card templates. |
|
|
description |
Description of the pricing matrix | |
|
name |
Name of the pricing matrix |
|
|
priceMatrixCount |
The count of pricing matrices linked to this template | |
|
rateCardCount |
The count of rate cards linked to this template |
|
|
template |
The name and variable name of the pricing matrix template object |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard" or "attributeBasedCharge" |
|
|
variableName |
Variable name of the pricing matrix template |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/newRateCardTemplate_c
{ "name": "...", "active": false, "description": "..." }
Update Rate Card Template Columns
|
Description |
Use this endpoint to update columns for the specified rate card template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName}/columns |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the rate card template |
|
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 Update Rate Card Template Column for more information. | |
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns
[{ "op": "add", "path": "/", "value": { "orderNumber": 2, "name": "To Country", "variableName": "toCountry", "key": true, "dataType": "String", "lookupType": "countryLOV", "defaultValue": "", "defaultOverridable": false, "description": "", "active": true, "negotiable": true, "required": true } }, { "op": "remove", "path": "/5001" }, { "op": "replace", "path": "/5003", "value": { "name": "Price", "description": "Rate Column", "defaultOverridable": true } } ]
Update Rate Card Template Column
|
Description |
Use this endpoint to update the specified rate card template column. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName}/columns/{id} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the rate card template. |
|
id |
The Unique Identifier of the rate card template column. |
|
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
active |
Indicates if the rate card template is active |
|
dataType |
Data type of the rate card template column. Allowed Values: "Boolean", "Currency", "String", "Decimal", "Date", or "Integer" |
|
|
defaultOverridable |
Indicates if the default value is overridable |
|
|
defaultValue |
Default value of the rate card template column |
|
|
description |
Description of the rate card template column | |
|
id |
The unique identifier of the rate card template column |
|
|
integrationId |
Identifier for the corresponding entity in Fusion Pricing. |
|
|
ioType |
The Input/Output type of the pricing matrix column. Allowed Values: "input" or "output" |
|
|
key |
Indicates if the rate card template column is a key |
|
|
lookupType |
Lookup type of the rate card template column |
|
|
lookupTypeLabel |
The lookup type display label of the rate card template column |
|
|
name |
Name of the rate card template column. |
|
|
negotiable |
Indicates if the value stores in this rate card template column is negotiable |
|
|
operator |
The operator to be applied on this pricing matrix column. Allowed Values: "none", "<", "<=", "Not =", "=", ">", ">=", "Contains", "Not Contains", "Starts With", "Not Starts With", "Ends With", or "Not Ends With" |
|
|
orderNumber |
The sequence number of the column in the template |
|
|
pricingAttribute |
The pricing attribute referenced to for this pricing matrix column |
|
|
required |
Indicates if the value of this rate card template column is required |
|
|
templateType |
The type of this pricing matrix template. Allowed Values: "rateCard" or "attributeBasedCharge" |
|
|
variableName |
Variable name of the rate card template column |
|
|
wildCardSupported |
Indicates if this column supports wild card values |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns/36991124
{ "name": "From Country", "key": true, "defaultOverridable": true, "active": true, "negotiable": false, "description": "" }
Rate Card & Rate Card Template Translations
|
Description |
Use this endpoint to add rate card translations. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCards/{rateCardVariableName}/translations |
|
| Endpoint Parameters |
rateCardVariableName |
The variable name of the rate card |
|
HTTP Method |
PUT |
|
| Response Body Parameters | An array of rate card translations | |
|
description |
Display description of the rate card item | |
|
languageCode |
Language code |
|
|
languageLabel |
Display language label in the given language code | |
|
name |
Display name of rate card item | |
|
Response Body Status |
204 No Content |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/naPhoneCallRateCard/translations
[{ "languageCode": "de", "languageLabel": "German", "name": "NA-Tarifkarte fur Telefongesprache", "description": "Dies ist ein Beispieltext" }, { "languageCode": "fr", "languageLabel": "French", "name": "Carte tarifaire des appels telephoniques NA", "description": "Ceci est un exemple de texte" } ]
Add Rate Card Template Translations
|
Description |
Use this endpoint to add rate card template translations. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName}/translations |
|
| Endpoint Parameters |
templateVariableName |
The variable name of the rate card template |
|
HTTP Method |
PUT |
|
| Response Body Parameters | An array of rate card template translations | |
|
description |
Display description of rate card template column | |
|
languageCode |
Language code |
|
|
languageLabel |
Display language label in the given language code | |
|
name |
Display name of rate card template column | |
|
Response Body Status |
204 No Content |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate
[{ "languageCode": "de", "languageLabel": "German", "name": "Vorlage fur Zoom-Telefonanrufe", "description": "Dies ist ein Beispieltext" }, { "languageCode": "fr", "languageLabel": "French", "name": "Modele d'appel telephonique Zoom", "description": "Ceci est un exemple de texte" } ]
Add Rate Card Template Column Translations
|
Description |
Use this endpoint to add rate card template column translations. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName}/columns/{id}/translations |
|
| Endpoint Parameters |
templateVariableName |
The variable name of the rate card template |
|
id |
The unique identifier of the rate card template column |
|
|
HTTP Method |
PUT |
|
| Request Body Parameters | An array of rate card template column translations | |
|
description |
Display description of rate card template column | |
|
languageCode |
Language code |
|
|
languageLabel |
Display language label in the given language code | |
|
name |
Display name of rate card template column | |
|
Response Body Status |
204 No Content |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns/36991124
[{ "languageCode": "en", "name": "From Country", "description": "...." }, { "languageCode": "de", "name": "Vom Land", "description": "...." } ]
|
Description |
Use this endpoint to retrieve translations for the specified rate card. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCards/{rateCardVariableName}/translations |
|
|
Endpoint Parameters |
rateCardVariableName |
The variable name of the rate card. |
|
(Optional) This endpoint supports the For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of translations for the specified rate card. See Get rate card Translation for detailed response body parameters. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/naPhoneCallRateCard/translations
{ "items": [{ "languageCode": "en", "languageLabel": "English", "name": "NA Phone Call Rate Card", "description": "This is some sample text" }, { "languageCode": "de", "languageLabel": "German", "name": "NA-Tarifkarte fur Telefongesprache", "description": "Dies ist ein Beispieltext" }, { "languageCode": "fr", "languageLabel": "French", "name": "Carte tarifaire des appels telephoniques NA", "description": "Ceci est un exemple de texte" }, { .... } ] }
|
Description |
Use this endpoint to retrieve the specified language translation for a rate card. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCards/{rateCardVariableName}/translations/{languageCode} |
|
|
Endpoint Parameters |
rateCardVariableName |
The variable name of the rate card. |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
description |
Display description of rate card template column. |
|
languageCode |
Language code. |
|
|
languageLabel |
Display language label in the given language code. | |
|
name |
Display name of rate card template column. | |
https://sitename.oracle.com/rest/v17/pricingSetup/rateCards/naPhoneCallRateCard/translations/de
{ "languageCode": "de", "languageLabel": "German", "name": "NA-Tarifkarte fur Telefongesprache", "description": "Dies ist ein Beispieltext" }
Get Rate Card Template Translations
|
Description |
Use this endpoint to retrieve translations for the specified rate card template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName}/translations |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the rate card template |
|
(Optional) This endpoint supports the For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
An array of rate card template translations | |
|
description |
Display description of rate card template column | |
|
languageCode |
Language code |
|
|
languageLabel |
Display language label in the given language code | |
|
name |
Display name of rate card template column | |
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/zoomPhoneCallTemplate/translations
{ "items": [{ "languageCode": "en", "languageLabel": "English", "name": "Zoom Phone Call Template", "description": "This is some sample text" }, { "languageCode": "de", "languageLabel": "German", "name": "Vorlage fur Zoom-Telefonanrufe", "description": "Dies ist ein Beispieltext" }, { "languageCode": "fr", "languageLabel": "French", "name": "Modele d'appel telephonique Zoom", "description": "Ceci est un exemple de texte" } ] }
Get Rate Card Template Translation
|
Description |
Use this endpoint to retrieve the specified language translation for a rate card template. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName}/translations/{languageCode} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the rate card template |
|
languageCode |
The language code |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
description |
Display description of rate card template column |
|
languageCode |
Language code |
|
|
languageLabel |
Display language label in the given language code | |
|
name |
Display name of rate card template column | |
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/zoomPhoneCallTemplate/translations/fr
{ "languageCode": "fr", "languageLabel": "French", "name": "Modele d'appel telephonique Zoom", "description": "Ceci est un exemple de texte" }
Get Rate Card Template Column Translations
|
Description |
Use this endpoint to retrieve translations for the specified rate card template column. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName}/columns/{id}/translations |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the rate card template. |
|
id |
The Unique Identifier of the rate card template column. |
|
|
(Optional) This endpoint supports the For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of rate card template column translations. See Get rate card template Column Translation for detailed response body parameters. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns/36991124
{ "items": [{ "languageCode": "en", "languageLabel": "English", "name": "From Country", "description": "..." }, { "languageCode": "de", "languageLabel": "German", "name": "Vom Land", "description": "..." }, { "languageCode": "fr", "languageLabel": "French", "name": "Du pays", "description": "..." } ] }
Get Rate Card Template Column Translation
|
Description |
Use this endpoint to retrieve the specified language translation for a rate card template column. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/rateCardTemplates/{templateVariableName}/columns/{id}/translations /{languageCode} |
|
|
Endpoint Parameters |
templateVariableName |
The variable name of the rate card template. |
|
id |
The Unique Identifier of the rate card template column. |
|
|
languageCode |
The language code. | |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
description |
Display description of rate card template column. |
|
languageCode |
Language code. |
|
|
languageLabel |
Display language label in the given language code. | |
|
name |
Display name of rate card template column. | |
https://sitename.oracle.com/rest/v17/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns/36991124/de
{ "languageCode": "de", "languageLabel": "German", "name": "Vom Land", "description": "" }
