Jump to

• Request
• Response
• Examples

Add a Rate Card

post

/rest/v19/pricingSetup/rateCards

Use this endpoint to add a rate card.

Request

Supported Media Types

• application/json

Body ()

Root Schema : PricingMatrix

Type: object

Show Source

• active: boolean()
  Title: Active

  Indicates if the pricing matrix is active.
• allowedChargeDefinitions: array Allowed Charge Definitions
  Title: Allowed Charge Definitions

  The list of charge definitions that this pricing matrix will apply to.
• allowedUsageUOM: Allowed Usage UOM
  Title: Allowed Usage UOM

  The usage UOM lookup code that this pricing matrix will apply to.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• data: Pricing Matrix data
  Title: Pricing Matrix data

  Read Only: true

  List of Pricing Matrix data.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation Date of the Pricing Matrix.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last Modified date of the Pricing Matrix.
• description: string()
  Title: Description

  Description of the Pricing Matrix.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• name: string()
  Title: Name

  Name of the Pricing Matrix.
• priceModelCount: integer()
  Title: Linked Pricing Models Count

  Read Only: true

  The count of price models linked to this pricing matrix.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• template: Pricing Matrix template
  Title: Pricing Matrix template

  Read Only: true

  Pricing Matrix template name and variableName
• templateVariableName(required): string()
  Title: Pricing Matrix Template Variable Name

  Variable Name of the Pricing Matrix Template.
• variableName: string()
  Title: Variable Name

  Unique Variable Name of the Pricing Matrix.

{
    "required":[
        "templateVariableName"
    ],
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "templateVariableName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the Pricing Matrix Template.",
            "title":"Pricing Matrix Template Variable Name"
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Pricing Matrix.",
            "title":"Name"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Unique Variable Name of the Pricing Matrix.",
            "title":"Variable Name"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Pricing Matrix.",
            "title":"Description"
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the pricing matrix is active.",
            "title":"Active"
        },
        "priceModelCount":{
            "type":"integer",
            "format":"",
            "description":"The count of price models linked to this pricing matrix.",
            "title":"Linked Pricing Models Count",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Pricing Matrix.",
            "title":"Date Added",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Pricing Matrix.",
            "title":"Date Modified",
            "readOnly":true
        },
        "data":{
            "format":"",
            "description":"List of Pricing Matrix data.",
            "title":"Pricing Matrix data",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_PricingMatrixData"
                }
            ]
        },
        "template":{
            "format":"",
            "description":"Pricing Matrix template name and variableName",
            "title":"Pricing Matrix template",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingMatrixTemplate"
                }
            ]
        },
        "allowedChargeDefinitions":{
            "type":"array",
            "format":"",
            "description":"The list of charge definitions that this pricing matrix will apply to.",
            "title":"Allowed Charge Definitions",
            "items":{
                "$ref":"#/definitions/PricingMenuItem"
            }
        },
        "allowedUsageUOM":{
            "format":"",
            "description":"The usage UOM lookup code that this pricing matrix will apply to.",
            "title":"Allowed Usage UOM",
            "allOf":[
                {
                    "$ref":"#/definitions/PricingMenuItem"
                }
            ]
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Allowed Charge Definitions

Type: array

Title: Allowed Charge Definitions

The list of charge definitions that this pricing matrix will apply to.

Show Source

• Array of: object PricingMenuItem

{
    "type":"array",
    "format":"",
    "description":"The list of charge definitions that this pricing matrix will apply to.",
    "title":"Allowed Charge Definitions",
    "items":{
        "$ref":"#/definitions/PricingMenuItem"
    }
}

Nested Schema : Allowed Usage UOM

Title: Allowed Usage UOM

The usage UOM lookup code that this pricing matrix will apply to.

Match All

The usage UOM lookup code that this pricing matrix will apply to.

Show Source

• object PricingMenuItem

{
    "format":"",
    "description":"The usage UOM lookup code that this pricing matrix will apply to.",
    "title":"Allowed Usage UOM",
    "allOf":[
        {
            "$ref":"#/definitions/PricingMenuItem"
        }
    ]
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Pricing Matrix data

Title: Pricing Matrix data

Read Only: true

List of Pricing Matrix data.

Match All

List of Pricing Matrix data.

Show Source

• object PricingResourceCollection_PricingMatrixData

{
    "format":"",
    "description":"List of Pricing Matrix data.",
    "title":"Pricing Matrix data",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_PricingMatrixData"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Pricing Matrix template

Title: Pricing Matrix template

Read Only: true

Pricing Matrix template name and variableName

Match All

Pricing Matrix template name and variableName

Show Source

• object PricingMatrixTemplate

{
    "format":"",
    "description":"Pricing Matrix template name and variableName",
    "title":"Pricing Matrix template",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingMatrixTemplate"
        }
    ]
}

Nested Schema : PricingMenuItem

Type: object

Show Source

• displayValue: string()
  Title: Display Value

  The display value of the menu item.
• value: string()
  Title: Value

  The raw value of the menu item.

{
    "properties":{
        "value":{
            "type":"string",
            "format":"",
            "description":"The raw value of the menu item.",
            "title":"Value"
        },
        "displayValue":{
            "type":"string",
            "format":"",
            "description":"The display value of the menu item.",
            "title":"Display Value"
        }
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : PricingResourceCollection_PricingMatrixData

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  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: array items
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• totalResults: integer()
  Title: Total Results

  Read Only: true

  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.

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingMatrixData"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"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.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"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.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object PricingMatrixData

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PricingMatrixData"
    }
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : PricingMatrixData

Type: object

Show Source

• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation Date of the Pricing Matrix data.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last Modified date of the Pricing Matrix data.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• id: integer()
  Title: Id

  The Unique Identifier of the Pricing Matrix data.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Pricing Matrix data.",
            "title":"Id"
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Pricing Matrix data.",
            "title":"Date Added",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Pricing Matrix data.",
            "title":"Date Modified",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : PricingMatrixTemplate

Type: object

Show Source

• name: string
• variableName: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "variableName":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingMatrix

Type: object

Show Source

• active: boolean()
  Title: Active

  Indicates if the pricing matrix is active.
• allowedChargeDefinitions: array Allowed Charge Definitions
  Title: Allowed Charge Definitions

  The list of charge definitions that this pricing matrix will apply to.
• allowedUsageUOM: Allowed Usage UOM
  Title: Allowed Usage UOM

  The usage UOM lookup code that this pricing matrix will apply to.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• data: Pricing Matrix data
  Title: Pricing Matrix data

  Read Only: true

  List of Pricing Matrix data.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation Date of the Pricing Matrix.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last Modified date of the Pricing Matrix.
• description: string()
  Title: Description

  Description of the Pricing Matrix.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• name: string()
  Title: Name

  Name of the Pricing Matrix.
• priceModelCount: integer()
  Title: Linked Pricing Models Count

  Read Only: true

  The count of price models linked to this pricing matrix.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• template: Pricing Matrix template
  Title: Pricing Matrix template

  Read Only: true

  Pricing Matrix template name and variableName
• templateVariableName(required): string()
  Title: Pricing Matrix Template Variable Name

  Variable Name of the Pricing Matrix Template.
• variableName: string()
  Title: Variable Name

  Unique Variable Name of the Pricing Matrix.

{
    "required":[
        "templateVariableName"
    ],
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "templateVariableName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the Pricing Matrix Template.",
            "title":"Pricing Matrix Template Variable Name"
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Pricing Matrix.",
            "title":"Name"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Unique Variable Name of the Pricing Matrix.",
            "title":"Variable Name"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Pricing Matrix.",
            "title":"Description"
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the pricing matrix is active.",
            "title":"Active"
        },
        "priceModelCount":{
            "type":"integer",
            "format":"",
            "description":"The count of price models linked to this pricing matrix.",
            "title":"Linked Pricing Models Count",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Pricing Matrix.",
            "title":"Date Added",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Pricing Matrix.",
            "title":"Date Modified",
            "readOnly":true
        },
        "data":{
            "format":"",
            "description":"List of Pricing Matrix data.",
            "title":"Pricing Matrix data",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_PricingMatrixData"
                }
            ]
        },
        "template":{
            "format":"",
            "description":"Pricing Matrix template name and variableName",
            "title":"Pricing Matrix template",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingMatrixTemplate"
                }
            ]
        },
        "allowedChargeDefinitions":{
            "type":"array",
            "format":"",
            "description":"The list of charge definitions that this pricing matrix will apply to.",
            "title":"Allowed Charge Definitions",
            "items":{
                "$ref":"#/definitions/PricingMenuItem"
            }
        },
        "allowedUsageUOM":{
            "format":"",
            "description":"The usage UOM lookup code that this pricing matrix will apply to.",
            "title":"Allowed Usage UOM",
            "allOf":[
                {
                    "$ref":"#/definitions/PricingMenuItem"
                }
            ]
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Allowed Charge Definitions

Type: array

Title: Allowed Charge Definitions

The list of charge definitions that this pricing matrix will apply to.

Show Source

• Array of: object PricingMenuItem

{
    "type":"array",
    "format":"",
    "description":"The list of charge definitions that this pricing matrix will apply to.",
    "title":"Allowed Charge Definitions",
    "items":{
        "$ref":"#/definitions/PricingMenuItem"
    }
}

Nested Schema : Allowed Usage UOM

Title: Allowed Usage UOM

The usage UOM lookup code that this pricing matrix will apply to.

Match All

The usage UOM lookup code that this pricing matrix will apply to.

Show Source

• object PricingMenuItem

{
    "format":"",
    "description":"The usage UOM lookup code that this pricing matrix will apply to.",
    "title":"Allowed Usage UOM",
    "allOf":[
        {
            "$ref":"#/definitions/PricingMenuItem"
        }
    ]
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Pricing Matrix data

Title: Pricing Matrix data

Read Only: true

List of Pricing Matrix data.

Match All

List of Pricing Matrix data.

Show Source

• object PricingResourceCollection_PricingMatrixData

{
    "format":"",
    "description":"List of Pricing Matrix data.",
    "title":"Pricing Matrix data",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_PricingMatrixData"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Pricing Matrix template

Title: Pricing Matrix template

Read Only: true

Pricing Matrix template name and variableName

Match All

Pricing Matrix template name and variableName

Show Source

• object PricingMatrixTemplate

{
    "format":"",
    "description":"Pricing Matrix template name and variableName",
    "title":"Pricing Matrix template",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingMatrixTemplate"
        }
    ]
}

Nested Schema : PricingMenuItem

Type: object

Show Source

• displayValue: string()
  Title: Display Value

  The display value of the menu item.
• value: string()
  Title: Value

  The raw value of the menu item.

{
    "properties":{
        "value":{
            "type":"string",
            "format":"",
            "description":"The raw value of the menu item.",
            "title":"Value"
        },
        "displayValue":{
            "type":"string",
            "format":"",
            "description":"The display value of the menu item.",
            "title":"Display Value"
        }
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : PricingResourceCollection_PricingMatrixData

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  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: array items
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• totalResults: integer()
  Title: Total Results

  Read Only: true

  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.

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingMatrixData"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"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.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"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.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object PricingMatrixData

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PricingMatrixData"
    }
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : PricingMatrixData

Type: object

Show Source

• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation Date of the Pricing Matrix data.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last Modified date of the Pricing Matrix data.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• id: integer()
  Title: Id

  The Unique Identifier of the Pricing Matrix data.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Pricing Matrix data.",
            "title":"Id"
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Pricing Matrix data.",
            "title":"Date Added",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Pricing Matrix data.",
            "title":"Date Modified",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : PricingMatrixTemplate

Type: object

Show Source

• name: string
• variableName: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "variableName":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to add a Rate Card by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/pricingSetup/rateCards

Request Body Sample

{
  "name": "Zoom Phone Calling Card",
  "variableName": "zoomPhoneCallingCard",
  "templateVariableName": "zoomPhoneCallingTemplate",
  "description": ""
}

Response Body Sample

{
  "templateVariableName": "zoomPhoneCallingTemplate",
  "name": "Zoom Phone Calling Card",
  "variableName": "zoomPhoneCallingCard",
  "description": "",
  "active": true,
  "dateAdded": "2023-09-27T18:01:48Z",
  "dateModified": "2023-09-27T18:01:48Z"
}

Back to Top