Jump to

• Request
• Response

Create a subscription balance register adjustment

post

/crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerAllowances/{AllowanceGrantNumber}/child/SubscriptionBalanceRegisterAdjustments

Request

Path Parameters

• AllowanceGrantNumber(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=
• BalanceRegisterNumber(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.
• 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

• AdjustedAmount: number
  Title: Adjusted Amount

  The calculated adjusted amount for the subscription balance register adjustment.
• AdjustedQuantity: number
  Title: Adjusted Quantity

  The calculated adjusted quantity for the subscription balance register adjustment.
• AdjustmentDescription: string
  Title: Description

  Maximum Length: 120

  The description of the subscription balance register adjustment.
• AdjustmentName: string
  Title: Name

  Maximum Length: 30

  The name of the subscription balance register adjustment.
• AdjustmentReasonCode: string
  Title: Adjustment Reason

  Maximum Length: 30

  The reason of the subscription balance register adjustment.
• AdjustmentType: string
  Title: Adjustment Type

  Maximum Length: 30

  The type of the subscription balance register adjustment.
• AdjustmentValue: number
  Title: Value

  The adjustment value provided by the user of the subscription balance register adjustment.
• BalanceAdjustmentId: integer (int64)
  Title: Balance Adjustment ID

  The identifier of the subscription balance register adjustments.
• BalanceAdjustmentNumber: string
  Title: Balance Adjustment Number

  Maximum Length: 120

  The balance adjustment number of the subscription balance register adjustments.
• BalanceAdjustmentPartialPeriodOption: string
  Title: Partial Period Option

  Maximum Length: 30

  The balance partial period option of the balance register adjustments.
• BalanceAdjustmentTerminatedPartialPeriodOption: string
  Title: Terminated Partial Period Option

  Maximum Length: 30

  The balance terminated partial period option of the balance register adjustments.
• BalanceCodeId: integer (int64)
  Title: Balance Code ID

  The identifier of the balance code associated to the subscription balance register adjustments.
• BalanceCodeType: string
  Title: Balance Code Type

  Maximum Length: 30

  The type of balance code for the subscription balance register adjustments.
• BalanceRegisterId: integer (int64)
  Title: Balance Register ID

  The identifier of balance register of the subscription balance register adjustments.
• BalanceRegisterPeriodId: integer (int64)
  Title: Balance Register Period ID

  The identifier of balance register period of the subscription balance register adjustments.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 30

  The currency code of the subscription balance register adjustment.
• EntitlementId: integer (int64)
  Title: Entitlement ID

  The identifier of entitlement for which the balance register adjustment is created.
• EntitlementType: string
  Title: Entitlement Types

  Maximum Length: 120

  The type of entitlement for which the balance register adjustment is created.
• NetAdjustedAmount: number
  Title: Net Adjusted Amount

  The net adjusted amount of the subscription balance register adjustment.
• NetAdjustedQuantity: number
  Title: Net Adjusted Quantity

  The net adjusted quantity of the subscription balance register adjustment.
• SequenceNumber: number
  Title: Sequence Number

  The sequence number in which subscription balance register adjustment is created.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The identifier of the subscription product associated to the subscription balance register adjustment.
• TerminatedAmount: number
  Title: Terminated Adjusted Amount

  The adjusted amount of the balance register adjustment that got terminated because the product was close.
• TerminatedQuantity: number
  Title: Terminated Adjusted Quantity

  The adjusted quantity of the balance register adjustment that got terminated because the product was close.

{
    "type":"object",
    "properties":{
        "AdjustedAmount":{
            "title":"Adjusted Amount",
            "type":"number",
            "description":"The calculated adjusted amount for the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustedQuantity":{
            "title":"Adjusted Quantity",
            "type":"number",
            "description":"The calculated adjusted quantity for the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentDescription":{
            "title":"Description",
            "maxLength":120,
            "type":"string",
            "description":"The description of the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentReasonCode":{
            "title":"Adjustment Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason of the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentType":{
            "title":"Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the subscription balance register adjustment.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value provided by the user of the subscription balance register adjustment.",
            "nullable":false,
            "x-queryable":false
        },
        "BalanceAdjustmentId":{
            "title":"Balance Adjustment ID",
            "type":"integer",
            "description":"The identifier of the subscription balance register adjustments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceAdjustmentNumber":{
            "title":"Balance Adjustment Number",
            "maxLength":120,
            "type":"string",
            "description":"The balance adjustment number of the subscription balance register adjustments.",
            "nullable":false
        },
        "BalanceAdjustmentPartialPeriodOption":{
            "title":"Partial Period Option",
            "maxLength":30,
            "type":"string",
            "description":"The balance partial period option of the balance register adjustments.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceAdjustmentTerminatedPartialPeriodOption":{
            "title":"Terminated Partial Period Option",
            "maxLength":30,
            "type":"string",
            "description":"The balance terminated partial period option of the balance register adjustments.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceCodeId":{
            "title":"Balance Code ID",
            "type":"integer",
            "description":"The identifier of the balance code associated to the subscription balance register adjustments.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceCodeType":{
            "title":"Balance Code Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of balance code for the subscription balance register adjustments.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceRegisterId":{
            "title":"Balance Register ID",
            "type":"integer",
            "description":"The identifier of balance register of the subscription balance register adjustments.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceRegisterPeriodId":{
            "title":"Balance Register Period ID",
            "type":"integer",
            "description":"The identifier of balance register period of the subscription balance register adjustments.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"The currency code of the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "EntitlementId":{
            "title":"Entitlement ID",
            "type":"integer",
            "description":"The identifier of entitlement for which the balance register adjustment is created.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EntitlementType":{
            "title":"Entitlement Types",
            "maxLength":120,
            "type":"string",
            "description":"The type of entitlement for which the balance register adjustment is created.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NetAdjustedAmount":{
            "title":"Net Adjusted Amount",
            "type":"number",
            "description":"The net adjusted amount of the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "NetAdjustedQuantity":{
            "title":"Net Adjusted Quantity",
            "type":"number",
            "description":"The net adjusted quantity of the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"number",
            "description":"The sequence number in which subscription balance register adjustment is created.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The identifier of the subscription product associated to the subscription balance register adjustment.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TerminatedAmount":{
            "title":"Terminated Adjusted Amount",
            "type":"number",
            "description":"The adjusted amount of the balance register adjustment that got terminated because the product was close.",
            "nullable":true,
            "x-queryable":false
        },
        "TerminatedQuantity":{
            "title":"Terminated Adjusted Quantity",
            "type":"number",
            "description":"The adjusted quantity of the balance register adjustment that got terminated because the product was close.",
            "nullable":true,
            "x-queryable":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 : subscriptionBalanceRegisters-registerAllowances-SubscriptionBalanceRegisterAdjustments-item-response

Type: object

Show Source

• AdjustedAmount: number
  Title: Adjusted Amount

  The calculated adjusted amount for the subscription balance register adjustment.
• AdjustedQuantity: number
  Title: Adjusted Quantity

  The calculated adjusted quantity for the subscription balance register adjustment.
• AdjustmentDescription: string
  Title: Description

  Maximum Length: 120

  The description of the subscription balance register adjustment.
• AdjustmentName: string
  Title: Name

  Maximum Length: 30

  The name of the subscription balance register adjustment.
• AdjustmentReasonCode: string
  Title: Adjustment Reason

  Maximum Length: 30

  The reason of the subscription balance register adjustment.
• AdjustmentType: string
  Title: Adjustment Type

  Maximum Length: 30

  The type of the subscription balance register adjustment.
• AdjustmentValue: number
  Title: Value

  The adjustment value provided by the user of the subscription balance register adjustment.
• BalanceAdjustmentId: integer (int64)
  Title: Balance Adjustment ID

  The identifier of the subscription balance register adjustments.
• BalanceAdjustmentNumber: string
  Title: Balance Adjustment Number

  Maximum Length: 120

  The balance adjustment number of the subscription balance register adjustments.
• BalanceAdjustmentPartialPeriodOption: string
  Title: Partial Period Option

  Maximum Length: 30

  The balance partial period option of the balance register adjustments.
• BalanceAdjustmentTerminatedPartialPeriodOption: string
  Title: Terminated Partial Period Option

  Maximum Length: 30

  The balance terminated partial period option of the balance register adjustments.
• BalanceCodeId: integer (int64)
  Title: Balance Code ID

  The identifier of the balance code associated to the subscription balance register adjustments.
• BalanceCodeMaxPrecision: integer (int32)
  Title: Maximum Precision

  Read Only: true

  The maximum precision of balance code for the subscription balance register adjustments.
• BalanceCodeType: string
  Title: Balance Code Type

  Maximum Length: 30

  The type of balance code for the subscription balance register adjustments.
• BalanceFirstPartialPeriodOption: string
  Title: Balance First Partial Period Option

  Read Only: true

  Maximum Length: 30

  The first balance partial period option of the product line of the balance register adjustments.
• BalanceLastPartialPeriodOption: string
  Title: Balance Last Partial Period Option

  Read Only: true

  Maximum Length: 30

  The last balance partial period option of the product line of the balance register adjustments.
• BalanceRegisterId: integer (int64)
  Title: Balance Register ID

  The identifier of balance register of the subscription balance register adjustments.
• BalanceRegisterPeriodId: integer (int64)
  Title: Balance Register Period ID

  The identifier of balance register period of the subscription balance register adjustments.
• BalanceTerminatedPartialPeriodOption: string
  Title: Balance Terminated Partial Period Option

  Read Only: true

  Maximum Length: 30

  The terminated balance partial period option of the product line of the balance register adjustments.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the subscription balance register adjustment was created.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 30

  The currency code of the subscription balance register adjustment.
• EntitlementId: integer (int64)
  Title: Entitlement ID

  The identifier of entitlement for which the balance register adjustment is created.
• EntitlementType: string
  Title: Entitlement Types

  Maximum Length: 120

  The type of entitlement for which the balance register adjustment is created.
• ExtendedPrecision: integer (int32)
  Title: Extended Precision

  Read Only: true

  The actual extended precision of the subscription balance register adjustment.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  The user who last updated the subscription balance register adjustment.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription register adjustment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NetAdjustedAmount: number
  Title: Net Adjusted Amount

  The net adjusted amount of the subscription balance register adjustment.
• NetAdjustedQuantity: number
  Title: Net Adjusted Quantity

  The net adjusted quantity of the subscription balance register adjustment.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number updated after every update of a subscription balance register adjustment.
• SequenceNumber: number
  Title: Sequence Number

  The sequence number in which subscription balance register adjustment is created.
• SubscriptionProductId: integer (int64)
  Title: Subscription Product ID

  The identifier of the subscription product associated to the subscription balance register adjustment.
• TerminatedAmount: number
  Title: Terminated Adjusted Amount

  The adjusted amount of the balance register adjustment that got terminated because the product was close.
• TerminatedQuantity: number
  Title: Terminated Adjusted Quantity

  The adjusted quantity of the balance register adjustment that got terminated because the product was close.

{
    "type":"object",
    "properties":{
        "AdjustedAmount":{
            "title":"Adjusted Amount",
            "type":"number",
            "description":"The calculated adjusted amount for the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustedQuantity":{
            "title":"Adjusted Quantity",
            "type":"number",
            "description":"The calculated adjusted quantity for the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentDescription":{
            "title":"Description",
            "maxLength":120,
            "type":"string",
            "description":"The description of the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentName":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "AdjustmentReasonCode":{
            "title":"Adjustment Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason of the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentType":{
            "title":"Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the subscription balance register adjustment.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value provided by the user of the subscription balance register adjustment.",
            "nullable":false,
            "x-queryable":false
        },
        "BalanceAdjustmentId":{
            "title":"Balance Adjustment ID",
            "type":"integer",
            "description":"The identifier of the subscription balance register adjustments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceAdjustmentNumber":{
            "title":"Balance Adjustment Number",
            "maxLength":120,
            "type":"string",
            "description":"The balance adjustment number of the subscription balance register adjustments.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceAdjustmentPartialPeriodOption":{
            "title":"Partial Period Option",
            "maxLength":30,
            "type":"string",
            "description":"The balance partial period option of the balance register adjustments.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceAdjustmentTerminatedPartialPeriodOption":{
            "title":"Terminated Partial Period Option",
            "maxLength":30,
            "type":"string",
            "description":"The balance terminated partial period option of the balance register adjustments.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceCodeId":{
            "title":"Balance Code ID",
            "type":"integer",
            "description":"The identifier of the balance code associated to the subscription balance register adjustments.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceCodeMaxPrecision":{
            "title":"Maximum Precision",
            "type":"integer",
            "description":"The maximum precision of balance code for the subscription balance register adjustments.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":2
            }
        },
        "BalanceCodeType":{
            "title":"Balance Code Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of balance code for the subscription balance register adjustments.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceFirstPartialPeriodOption":{
            "title":"Balance First Partial Period Option",
            "maxLength":30,
            "type":"string",
            "description":"The first balance partial period option of the product line of the balance register adjustments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BalanceLastPartialPeriodOption":{
            "title":"Balance Last Partial Period Option",
            "maxLength":30,
            "type":"string",
            "description":"The last balance partial period option of the product line of the balance register adjustments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BalanceRegisterId":{
            "title":"Balance Register ID",
            "type":"integer",
            "description":"The identifier of balance register of the subscription balance register adjustments.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceRegisterPeriodId":{
            "title":"Balance Register Period ID",
            "type":"integer",
            "description":"The identifier of balance register period of the subscription balance register adjustments.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceTerminatedPartialPeriodOption":{
            "title":"Balance Terminated Partial Period Option",
            "maxLength":30,
            "type":"string",
            "description":"The terminated balance partial period option of the product line of the balance register adjustments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance register adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance register adjustment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"The currency code of the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "EntitlementId":{
            "title":"Entitlement ID",
            "type":"integer",
            "description":"The identifier of entitlement for which the balance register adjustment is created.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntitlementType":{
            "title":"Entitlement Types",
            "maxLength":120,
            "type":"string",
            "description":"The type of entitlement for which the balance register adjustment is created.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExtendedPrecision":{
            "title":"Extended Precision",
            "type":"integer",
            "description":"The actual extended precision of the subscription balance register adjustment.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":2
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance register adjustment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription register adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription balance register adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "NetAdjustedAmount":{
            "title":"Net Adjusted Amount",
            "type":"number",
            "description":"The net adjusted amount of the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "NetAdjustedQuantity":{
            "title":"Net Adjusted Quantity",
            "type":"number",
            "description":"The net adjusted quantity of the subscription balance register adjustment.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance register adjustment.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"number",
            "description":"The sequence number in which subscription balance register adjustment is created.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The identifier of the subscription product associated to the subscription balance register adjustment.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TerminatedAmount":{
            "title":"Terminated Adjusted Amount",
            "type":"number",
            "description":"The adjusted amount of the balance register adjustment that got terminated because the product was close.",
            "nullable":true,
            "x-queryable":false
        },
        "TerminatedQuantity":{
            "title":"Terminated Adjusted Quantity",
            "type":"number",
            "description":"The adjusted quantity of the balance register adjustment that got terminated because the product was close.",
            "nullable":true,
            "x-queryable":false
        },
        "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

BalanceAdjustmentModeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BALANCE_ADJ_MODE

The following properties are defined on the LOV link relation:

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

BalanceAdjustmentReasonCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BALNC_ADJ_REASON_CODE

The following properties are defined on the LOV link relation:

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

BalanceCodeTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BALANCE_CODE_TYPES

The following properties are defined on the LOV link relation:

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

EntitlementTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_ENTITLEMENT_TYPES

The following properties are defined on the LOV link relation:

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

Back to Top