Jump to

• Request
• Response

Update a balance profile balance code

patch

/crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileBalanceCodes/{ProfileBalanceCodeNumber}

Request

Path Parameters

• BalanceProfileNumber(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=
• ProfileBalanceCodeNumber(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=

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

• AllowanceGrantCodeFlag: boolean
  Title: Enable allowance

  Maximum Length: 1

  Default Value: false

  The balance code should be used for allowance grant of the subscription profile balance code.
• BalanceCode: string
  Title: Code

  Maximum Length: 30

  The balance code of the subscription balance profile balance code.
• BalanceCodeId: integer (int64)
  Title: Balance Code

  The unique identifier of the balance code.
• BalancePrecedence: number
  Title: Precedence

  The precedence for balance code for given subscription balance profile.
• BalanceProfileChargeId: integer (int64)
  The unique identifier of the balance profile charge.
• BalanceProfileId: integer (int64)
  The unique identifier of the balance profile.
• CommitmentCodeFlag: boolean
  Title: Enable commitment

  Maximum Length: 1

  Default Value: false

  Indicates whether the balance code is for enable commitments.
• EstimateCodeFlag: boolean
  Title: Enable estimate

  Maximum Length: 1

  Default Value: false

  Indicates whether the balance code is for enable estimates.
• ProfileBalanceCodeNumber: string
  Maximum Length: 120

  The alternate identifier of the profile balance code.
• VolumePricingFlag: boolean
  Title: Enable volume pricing

  Maximum Length: 1

  Default Value: false

  Indicates whether the profile balance code is enable for volume pricing.

{
    "type":"object",
    "properties":{
        "AllowanceGrantCodeFlag":{
            "title":"Enable allowance",
            "maxLength":1,
            "type":"boolean",
            "description":"The balance code should be used for allowance grant of the subscription profile balance code.",
            "nullable":true,
            "default":false
        },
        "BalanceCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of the subscription balance profile balance code.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BalanceCodeId":{
            "title":"Balance Code",
            "type":"integer",
            "description":"The unique identifier of the balance code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "BalancePrecedence":{
            "title":"Precedence",
            "type":"number",
            "description":"The precedence for balance code for given subscription balance profile.",
            "nullable":true
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CommitmentCodeFlag":{
            "title":"Enable commitment",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the balance code is for enable commitments.",
            "nullable":true,
            "default":false
        },
        "EstimateCodeFlag":{
            "title":"Enable estimate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the balance code is for enable estimates.",
            "nullable":true,
            "default":false
        },
        "ProfileBalanceCodeNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the profile balance code.",
            "nullable":true
        },
        "VolumePricingFlag":{
            "title":"Enable volume pricing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the profile balance code is enable for volume pricing.",
            "nullable":true,
            "default":false
        }
    }
}

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 : subscriptionBalanceProfiles-profileBalanceCodes-item-response

Type: object

Show Source

• AllowanceGrantCodeFlag: boolean
  Title: Enable allowance

  Maximum Length: 1

  Default Value: false

  The balance code should be used for allowance grant of the subscription profile balance code.
• BalanceCode: string
  Title: Code

  Maximum Length: 30

  The balance code of the subscription balance profile balance code.
• BalanceCodeDescription: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  The balance code description of the subscription profile balance code.
• BalanceCodeId: integer (int64)
  Title: Balance Code

  The unique identifier of the balance code.
• BalancePrecedence: number
  Title: Precedence

  The precedence for balance code for given subscription balance profile.
• BalanceProfileChargeId: integer (int64)
  The unique identifier of the balance profile charge.
• BalanceProfileId: integer (int64)
  The unique identifier of the balance profile.
• CommitmentCodeFlag: boolean
  Title: Enable commitment

  Maximum Length: 1

  Default Value: false

  Indicates whether the balance code is for enable commitments.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription profile balance code.
• CreationDate: string (date-time)
  Read Only: true

  The date when the subscription profile balance code was created.
• EstimateCodeFlag: boolean
  Title: Enable estimate

  Maximum Length: 1

  Default Value: false

  Indicates whether the balance code is for enable estimates.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription profile balance code was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription profile balance code.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription profile balance code.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number of the subscription profile balance code.
• ProfileBalanceCodeId: integer (int64)
  The unique identifier of the balance profile code.
• ProfileBalanceCodeNumber: string
  Maximum Length: 120

  The alternate identifier of the profile balance code.
• VolumePricingFlag: boolean
  Title: Enable volume pricing

  Maximum Length: 1

  Default Value: false

  Indicates whether the profile balance code is enable for volume pricing.

{
    "type":"object",
    "properties":{
        "AllowanceGrantCodeFlag":{
            "title":"Enable allowance",
            "maxLength":1,
            "type":"boolean",
            "description":"The balance code should be used for allowance grant of the subscription profile balance code.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of the subscription balance profile balance code.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceCodeDescription":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"The balance code description of the subscription profile balance code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code",
            "type":"integer",
            "description":"The unique identifier of the balance code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "BalancePrecedence":{
            "title":"Precedence",
            "type":"number",
            "description":"The precedence for balance code for given subscription balance profile.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CommitmentCodeFlag":{
            "title":"Enable commitment",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the balance code is for enable commitments.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription profile balance code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription profile balance code was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimateCodeFlag":{
            "title":"Enable estimate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the balance code is for enable estimates.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription profile balance code 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 subscription profile balance code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription profile balance code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription profile balance code.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ProfileBalanceCodeId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProfileBalanceCodeNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the profile balance code.",
            "nullable":true,
            "x-queryable":true
        },
        "VolumePricingFlag":{
            "title":"Enable volume pricing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the profile balance code is enable for volume pricing.",
            "nullable":true,
            "default":false,
            "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."
        }
    }
}

Back to Top