Jump to

• Request
• Response

Update a formula plan charge

patch

/crmRestApi/resources/11.13.18.05/subscriptionFormulaPlans/{FormulaPlanPuid}/child/formulaPlanCharges/{formulaPlanChargesUniqID}

Request

Path Parameters

• FormulaPlanPuid(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• formulaPlanChargesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Formula Charges resource and used to uniquely identify an instance of Formula Charges. The client should not generate the hash key value. Instead, the client should query on the Formula Charges collection resource in order to navigate to a specific instance of Formula Charges to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ChargeDefinitionCode: string
  Maximum Length: 30

  The unique charge definition code for the adjustment.
• ChargeDefinitionId: integer (int64)
  The unique identifier of the charge definition for the adjustment.
• FormulaChargeType: string
  Maximum Length: 30

  The formula charge type used such as Billable, Revenue, or Prepared Variable.
• FormulaPlanId: integer (int64)
  The unique identifier of the formula plan of associated with this charge.

{
    "type":"object",
    "properties":{
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique 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
            }
        },
        "FormulaChargeType":{
            "maxLength":30,
            "type":"string",
            "description":"The formula charge type used such as Billable, Revenue, or Prepared Variable.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FormulaPlanId":{
            "type":"integer",
            "description":"The unique identifier of the formula plan of associated with this charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : subscriptionFormulaPlans-formulaPlanCharges-item-response

Type: object

Show Source

• ChargeDefinitionCode: string
  Maximum Length: 30

  The unique charge definition code for the adjustment.
• ChargeDefinitionId: integer (int64)
  The unique identifier of the charge definition for the adjustment.
• 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.
• FormulaChargeId: integer (int64)
  Read Only: true

  The unique identifier of the formula charges.
• FormulaChargeType: string
  Maximum Length: 30

  The formula charge type used such as Billable, Revenue, or Prepared Variable.
• FormulaPlanId: integer (int64)
  The unique identifier of the formula plan of associated with this charge.
• FormulaPlanPuid: string
  Read Only: true

  Maximum Length: 120

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

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

  Maximum Length: 64

  The user who updated the record last.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique 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
        },
        "FormulaChargeId":{
            "type":"integer",
            "description":"The unique identifier of the formula charges.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaChargeType":{
            "maxLength":30,
            "type":"string",
            "description":"The formula charge type used such as Billable, Revenue, or Prepared Variable.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FormulaPlanId":{
            "type":"integer",
            "description":"The unique identifier of the formula plan of associated with this charge.",
            "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 charge.",
            "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 of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the record last.",
            "nullable":false,
            "readOnly":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

FormulaChargeTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_FORMULA_CHARGE_TYPES

The following properties are defined on the LOV link relation:

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

Back to Top