Jump to

• Request
• Response

Create a formula rate

post

/crmRestApi/resources/11.13.18.05/formulaRates

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CalculationMethodCode: string
  Title: Rate Type

  Maximum Length: 15

  The calculation method used for the formula negotiated value, such as VALUE, MATRIX, or TIER.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code for the adjustment.
• ChargeDefinitionId: integer (int64)
  The unique identifier of the charge definition for the adjustment.
• CPITierAdjustmentFlag: boolean
  Maximum Length: 1

  Indicates whether CPI is applied to the tier.
• CPIValueAdjustmentFlag: boolean
  Maximum Length: 1

  Indicates whether CPI is applied to the value.
• DynamicMatrixClassId: integer (int64)
  The unique identifier of the dynamic matrix class. Populated only when the calculation method is MATRIX.
• DynamicMatrixId: integer (int64)
  The unique identifier of the dynamic matrix. Populated only when the calculation method is MATRIX.
• FormulaPlanId: integer (int64)
  The unique identifier of the formula plan associated with the pricing.
• RateCode: string
  Title: Variable

  Maximum Length: 200

  The negotiated rate code that identifies the charge component used for formula-based pricing.
• RateCodeName: string
  Maximum Length: 200

  The name of the negotiated rate code used for formula-based pricing.
• RateDescription: string
  Title: Description

  Maximum Length: 4000

  The description of the negotiated rate code used in formula-based pricing.
• RateVariableId: integer (int64)
  The unique identifier of the formula negotiated value.
• RateVariablePuid: string
  Maximum Length: 120

  The public unique identifier of the rate variable. This is used to identify the formula negotiated value record.
• TieredPricingHeaderId: integer (int64)
  The unique identifier of the tiered pricing header.
• Value: number
  Title: Base Value

  The value used for the formula negotiated value. Populated only when the calculation method is VALUE.
• ValueType: string
  Maximum Length: 15

  The type of value, such as percentage or amount, based on the calculation method.

{
    "type":"object",
    "properties":{
        "CPITierAdjustmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether CPI is applied to the tier.",
            "nullable":true
        },
        "CPIValueAdjustmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether CPI is applied to the value.",
            "nullable":true
        },
        "CalculationMethodCode":{
            "title":"Rate Type",
            "maxLength":15,
            "type":"string",
            "description":"The calculation method used for the formula negotiated value, such as VALUE, MATRIX, or TIER.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code for the adjustment.",
            "nullable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of the charge definition for the adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DynamicMatrixClassId":{
            "type":"integer",
            "description":"The unique identifier of the dynamic matrix class. Populated only when the calculation method is MATRIX.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DynamicMatrixId":{
            "type":"integer",
            "description":"The unique identifier of the dynamic matrix. Populated only when the calculation method is MATRIX.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "FormulaPlanId":{
            "type":"integer",
            "description":"The unique identifier of the formula plan associated with the pricing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RateCode":{
            "title":"Variable",
            "maxLength":200,
            "type":"string",
            "description":"The negotiated rate code that identifies the charge component used for formula-based pricing.",
            "nullable":true
        },
        "RateCodeName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the negotiated rate code used for formula-based pricing.",
            "nullable":true
        },
        "RateDescription":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"The description of the negotiated rate code used in formula-based pricing.",
            "nullable":true
        },
        "RateVariableId":{
            "type":"integer",
            "description":"The unique identifier of the formula negotiated value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RateVariablePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the rate variable. This is used to identify the formula negotiated value record.",
            "nullable":false
        },
        "TieredPricingHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the tiered pricing header.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Value":{
            "title":"Base Value",
            "type":"number",
            "description":"The value used for the formula negotiated value. Populated only when the calculation method is VALUE.",
            "nullable":true
        },
        "ValueType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of value, such as percentage or amount, based on the calculation method.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : formulaRates-item-response

Type: object

Show Source

• CalculationMethodCode: string
  Title: Rate Type

  Maximum Length: 15

  The calculation method used for the formula negotiated value, such as VALUE, MATRIX, or TIER.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code for the adjustment.
• ChargeDefinitionId: integer (int64)
  The unique identifier of the charge definition for the adjustment.
• CPITierAdjustmentFlag: boolean
  Maximum Length: 1

  Indicates whether CPI is applied to the tier.
• CPIValueAdjustmentFlag: boolean
  Maximum Length: 1

  Indicates whether CPI is applied to the value.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• DynamicMatrixClassId: integer (int64)
  The unique identifier of the dynamic matrix class. Populated only when the calculation method is MATRIX.
• DynamicMatrixId: integer (int64)
  The unique identifier of the dynamic matrix. Populated only when the calculation method is MATRIX.
• FormulaPlanId: integer (int64)
  The unique identifier of the formula plan associated with the pricing.
• FormulaPlanPuid: string
  Read Only: true

  Maximum Length: 120

  The unique identifier of the formula plan associated with this rate.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login identifier used for the last update.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RateCode: string
  Title: Variable

  Maximum Length: 200

  The negotiated rate code that identifies the charge component used for formula-based pricing.
• RateCodeName: string
  Maximum Length: 200

  The name of the negotiated rate code used for formula-based pricing.
• RateDescription: string
  Title: Description

  Maximum Length: 4000

  The description of the negotiated rate code used in formula-based pricing.
• RateVariableId: integer (int64)
  The unique identifier of the formula negotiated value.
• RateVariablePuid: string
  Maximum Length: 120

  The public unique identifier of the rate variable. This is used to identify the formula negotiated value record.
• TieredPricingHeaderId: integer (int64)
  The unique identifier of the tiered pricing header.
• Value: number
  Title: Base Value

  The value used for the formula negotiated value. Populated only when the calculation method is VALUE.
• ValueType: string
  Maximum Length: 15

  The type of value, such as percentage or amount, based on the calculation method.

{
    "type":"object",
    "properties":{
        "CPITierAdjustmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether CPI is applied to the tier.",
            "nullable":true,
            "x-queryable":true
        },
        "CPIValueAdjustmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether CPI is applied to the value.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculationMethodCode":{
            "title":"Rate Type",
            "maxLength":15,
            "type":"string",
            "description":"The calculation method used for the formula negotiated value, such as VALUE, MATRIX, or TIER.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code for the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of the charge definition for the adjustment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicMatrixClassId":{
            "type":"integer",
            "description":"The unique identifier of the dynamic matrix class. Populated only when the calculation method is MATRIX.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DynamicMatrixId":{
            "type":"integer",
            "description":"The unique identifier of the dynamic matrix. Populated only when the calculation method is MATRIX.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaPlanId":{
            "type":"integer",
            "description":"The unique identifier of the formula plan associated with the pricing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaPlanPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The unique identifier of the formula plan associated with this rate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login identifier used for the last update.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateCode":{
            "title":"Variable",
            "maxLength":200,
            "type":"string",
            "description":"The negotiated rate code that identifies the charge component used for formula-based pricing.",
            "nullable":true,
            "x-queryable":true
        },
        "RateCodeName":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the negotiated rate code used for formula-based pricing.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDescription":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"The description of the negotiated rate code used in formula-based pricing.",
            "nullable":true,
            "x-queryable":true
        },
        "RateVariableId":{
            "type":"integer",
            "description":"The unique identifier of the formula negotiated value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateVariablePuid":{
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the rate variable. This is used to identify the formula negotiated value record.",
            "nullable":false,
            "x-queryable":true
        },
        "TieredPricingHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the tiered pricing header.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Value":{
            "title":"Base Value",
            "type":"number",
            "description":"The value used for the formula negotiated value. Populated only when the calculation method is VALUE.",
            "nullable":true,
            "x-queryable":true
        },
        "ValueType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of value, such as percentage or amount, based on the calculation method.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

CalculationMethodCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_FORMULA_CALC_METHODS

The following properties are defined on the LOV link relation:

• Source Attribute: CalculationMethodCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top