Jump to

• Request
• Response

Get a subscription balance register allowance grant

get

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

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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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-item-response

Type: object

Show Source

• AllowanceEffectiveEndDate: string (date)
  Title: Effective End Date

  Read Only: true

  The date from when allowance is effective.
• AllowanceEffectiveStartDate: string (date)
  Title: Effective Start Date

  Read Only: true

  The date till which allowance is effective.
• AllowanceGrantId: integer (int64)
  The balance register allowance grant identifier of the subscription balance register allowance grants.
• AllowanceGrantNumber: string
  Title: Allowance Grant Number

  Maximum Length: 120

  The balance register allowance grant number of the subscription balance allowance grants.
• Amount: number
  Title: Amount

  The amount of the subscription balance allowance grants.
• BalanceCode: string
  Title: Balance Code

  Read Only: true

  Maximum Length: 30

  The balance code of the subscription balance allowance grants.
• BalanceCodeMaxPrecision: integer (int32)
  Title: Maximum Precision

  Read Only: true

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

  Maximum Length: 30

  The balance code type for the subscription balance allowance grants.
• BalanceRegisterId: integer (int64)
  The balance register identifier of the subscription balance allowance grants.
• BalanceRegisterPeriodId: integer (int64)
  The balance register period identifier of the subscription balance allowance grants.
• BalanceRegisterPeriodNumber: string
  Title: Register Period Number

  Read Only: true

  Maximum Length: 120

  The balance register period number of the subscription balance register allowance grants.
• ChargeDefinitionName: string
  Title: Charge

  Read Only: true

  Maximum Length: 80

  The charge definition name of the subscription balance allowance grants.
• ConsumedAmount: number
  Title: Consumed Amount

  The consumed amount of the subscription balance allowance grants.
• ConsumedQuantity: number
  Title: Consumed Quantity

  The consumed quantity of the subscription balance allowance grants.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the subscription balance allowance grant was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code of the subscription balance allowance grants.
• EndDate: string (date)
  Title: End Date

  The date when the allowance grant ends.
• ExtendedPrecision: integer (int32)
  Title: Extended Precision

  Read Only: true

  The actual extended precision of the subscription balance allowance grants.
• GrantDate: string (date)
  Title: Grant Date

  The date when the allowance is granted.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

  The login of the user who last updated the subscription balance allowance grants.
• LeAllowanceCurrentDate: string (date)
  Title: Date

  Read Only: true

  The current legal entity date of the subscription balance allowance grants.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number updated after every update of a subscription balance allowance grants.
• PartyName: string
  Title: Customer

  Read Only: true

  Maximum Length: 360

  The party name of the subscription balance register allowance grants.
• PartyNumber: string
  Title: Party Number

  Read Only: true

  Maximum Length: 30

  The party number of the subscription balance register allowance grants.
• ProductClosedDate: string (date)
  Title: Product Close Date

  Read Only: true

  The date when the product closes for subscription balance register allowance grants.
• ProductEndDate: string (date)
  Title: Product End Date

  Read Only: true

  The product end date of the subscription balance register allowance grants.
• ProductName: string
  Title: Product Name

  Read Only: true

  Maximum Length: 300

  The product name of the subscription balance allowance grants.
• ProductNumber: string
  Title: Product Number

  Read Only: true

  Maximum Length: 300

  The product number of the subscription balance allowance grants.
• ProductStartDate: string (date)
  Title: Product Start Date

  Read Only: true

  The product start date of the subscription balance register allowance grants.
• Quantity: number
  Title: Quantity

  The quantity of the subscription balance allowance grants.
• QuantityUnitOfMeasure: string
  Title: UOM

  Maximum Length: 3

  The quantity unit of measure of the subscription balance allowance grants.
• RemainingAmount: number
  Title: Remaining Amount

  The remaining amount of the subscription balance allowance grants.
• RemainingQuantity: number
  Title: Remaining Quantity

  The remaining quantity of the subscription balance allowance grants.
• RolloverEndDate: string (date)
  Title: Rollover End Date

  The rollover end date of the subscription balance allowance grants.
• StartDate: string (date)
  Title: Start Date

  The start date of the subscription balance allowance grants.
• SubscriptionBalanceRegisterAdjustments: array Subscription Balance Register Adjustments
  Title: Subscription Balance Register Adjustments

  The subscription balance register adjustments resource is used to view the balance adjustments under an allowance grant.
• SubscriptionEndDate: string (date)
  Title: Subscription End Date

  Read Only: true

  The subscription end date of the subscription balance register allowance grants.
• SubscriptionNumber: string
  Title: Subscription Number

  Read Only: true

  Maximum Length: 120

  The subscription number of the subscription balance allowance grants.
• SubscriptionProductPuid: string
  Title: Subscription Product PUID

  Read Only: true

  Maximum Length: 120

  The subscription product PUID of the subscription balance allowance grants.
• SubscriptionStartDate: string (date)
  Title: Subscription Start Date

  Read Only: true

  The subscription start date of the subscription balance register allowance grants.
• TerminatedAmount: number
  Title: Terminated Amount

  The terminated amount of the subscription balance register allowance grants.
• TerminatedQuantity: number
  Title: Terminated Quantity

  The terminated quantity of the subscription balance register allowance grants.

{
    "type":"object",
    "properties":{
        "AllowanceEffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The date from when allowance is effective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AllowanceEffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The date till which allowance is effective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AllowanceGrantId":{
            "type":"integer",
            "description":"The balance register allowance grant identifier of the subscription balance register allowance grants.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "AllowanceGrantNumber":{
            "title":"Allowance Grant Number",
            "maxLength":120,
            "type":"string",
            "description":"The balance register allowance grant number of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceCodeMaxPrecision":{
            "title":"Maximum Precision",
            "type":"integer",
            "description":"The maximum precision of balance code for the subscription balance allowance grants.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "BalanceCodeType":{
            "title":"Balance Code Type",
            "maxLength":30,
            "type":"string",
            "description":"The balance code type for the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance allowance grants.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance allowance grants.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceRegisterPeriodNumber":{
            "title":"Register Period Number",
            "maxLength":120,
            "type":"string",
            "description":"The balance register period number of the subscription balance register allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ChargeDefinitionName":{
            "title":"Charge",
            "maxLength":80,
            "type":"string",
            "description":"The charge definition name of the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ConsumedAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The consumed amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ConsumedQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The consumed quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance allowance grant.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance allowance grant was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the allowance grant ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExtendedPrecision":{
            "title":"Extended Precision",
            "type":"integer",
            "description":"The actual extended precision of the subscription balance allowance grants.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":2
            },
            "x-queryable":true
        },
        "GrantDate":{
            "title":"Grant Date",
            "type":"string",
            "description":"The date when the allowance is granted.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance allowance grant was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription balance allowance grants.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LeAllowanceCurrentDate":{
            "title":"Date",
            "type":"string",
            "description":"The current legal entity date of the subscription balance allowance grants.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance allowance grants.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":9
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Customer",
            "maxLength":360,
            "type":"string",
            "description":"The party name of the subscription balance register allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the subscription balance register allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ProductClosedDate":{
            "title":"Product Close Date",
            "type":"string",
            "description":"The date when the product closes for subscription balance register allowance grants.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductEndDate":{
            "title":"Product End Date",
            "type":"string",
            "description":"The product end date of the subscription balance register allowance grants.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductName":{
            "title":"Product Name",
            "maxLength":300,
            "type":"string",
            "description":"The product name of the subscription balance allowance grants.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ProductNumber":{
            "title":"Product Number",
            "maxLength":300,
            "type":"string",
            "description":"The product number of the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ProductStartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The product start date of the subscription balance register allowance grants.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RemainingAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RemainingQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RolloverEndDate":{
            "title":"Rollover End Date",
            "type":"string",
            "description":"The rollover end date of the subscription balance allowance grants.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance allowance grants.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionBalanceRegisterAdjustments":{
            "title":"Subscription Balance Register Adjustments",
            "type":"array",
            "description":"The subscription balance register adjustments resource is used to view the balance adjustments under an allowance grant.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerAllowances-SubscriptionBalanceRegisterAdjustments-item-response"
            }
        },
        "SubscriptionEndDate":{
            "title":"Subscription End Date",
            "type":"string",
            "description":"The subscription end date of the subscription balance register allowance grants.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The subscription number of the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product PUID",
            "maxLength":120,
            "type":"string",
            "description":"The subscription product PUID of the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "SubscriptionStartDate":{
            "title":"Subscription Start Date",
            "type":"string",
            "description":"The subscription start date of the subscription balance register allowance grants.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerminatedAmount":{
            "title":"Terminated Amount",
            "type":"number",
            "description":"The terminated amount of the subscription balance register allowance grants.",
            "nullable":true,
            "x-queryable":true
        },
        "TerminatedQuantity":{
            "title":"Terminated Quantity",
            "type":"number",
            "description":"The terminated quantity of the subscription balance register allowance grants.",
            "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 : Subscription Balance Register Adjustments

Type: array

Title: Subscription Balance Register Adjustments

The subscription balance register adjustments resource is used to view the balance adjustments under an allowance grant.

Show Source

• Array of: object subscriptionBalanceRegisters-registerAllowances-SubscriptionBalanceRegisterAdjustments-item-response

{
    "title":"Subscription Balance Register Adjustments",
    "type":"array",
    "description":"The subscription balance register adjustments resource is used to view the balance adjustments under an allowance grant.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerAllowances-SubscriptionBalanceRegisterAdjustments-item-response"
    }
}

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."
        }
    }
}

Nested 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"
    }
}

Links

SubscriptionBalanceRegisterAdjustments

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

Parameters:

• AllowanceGrantNumber: $request.path.AllowanceGrantNumber
• BalanceRegisterNumber: $request.path.BalanceRegisterNumber

The subscription balance register adjustments resource is used to view the balance adjustments under an allowance grant.

Back to Top