Jump to

• Request
• Response

Get a subscription balance register commitment

get

/crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerCommitments/{BalanceCommitmentNumber}/child/SubscriptionBalanceRegisterCommitmentUsages/{BalanceCommitmentNumber2}

Request

Path Parameters

• BalanceCommitmentNumber(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=
• BalanceCommitmentNumber2(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-registerCommitments-SubscriptionBalanceRegisterCommitmentUsages-item-response

Type: object

Show Source

• ActualUsageAmount: number
  Title: Consumed Amount

  The consumed amount of the subscription balance commitments.
• ActualUsageQuantity: number
  Title: Consumed Quantity

  The consumed quantity of the subscription balance commitments.
• BalanceCode: string
  Title: Balance Code

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

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

  Maximum Length: 30

  The balance code type for the subscription balance register commitments.
• BalanceCommitmentId: integer (int64)
  The balance register commitment identifier of the subscription balance register commitments.
• BalanceCommitmentNumber: string
  Title: Commitment Period Number

  Maximum Length: 120

  The balance register commitment number of the subscription balance commitments.
• BalanceRegisterId: integer (int64)
  The balance register identifier of the subscription balance commitments.
• BalanceRegisterPeriodId: integer (int64)
  The balance register period identifier of the subscription balance commitments.
• BalanceRegisterPeriodNumber: string
  Title: Register Period Number

  Read Only: true

  Maximum Length: 120

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

  Read Only: true

  Maximum Length: 80

  The charge definition name of the subscription balance register commitments.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

  Maximum Length: 15

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

  The end date of the subscription balance commitments.
• ExtendedPrecision: integer (int32)
  Title: Extended Precision

  Read Only: true

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

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

  Maximum Length: 64

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

  Maximum Length: 32

  The login of the user who last updated the subscription balance commitments.
• LeCommitmentCurrentDate: string (date)
  Title: Date

  Read Only: true

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

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

  The object version number updated after every update of a subscription balance commitments.
• PartyName: string
  Title: Customer

  Read Only: true

  Maximum Length: 360

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  The product closed date of the subscription balance register commitments.
• ProductEndDate: string (date)
  Title: Product End Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 300

  The product name of the subscription balance register commitments.
• ProductNumber: string
  Title: Product Number

  Read Only: true

  Maximum Length: 300

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

  Read Only: true

  The product start date of the subscription balance register commitments.
• QuantityUnitOfMeasure: string
  Title: UOM

  Maximum Length: 3

  The quantity unit of measure of the subscription balance register commitments.
• StartDate: string (date)
  Title: Start Date

  The start date of the subscription balance register commitments.
• SubscriptionEndDate: string (date)
  Title: Subscription End Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 120

  The subscription number of the subscription balance register commitments.
• SubscriptionProductPuid: string
  Title: Subscription Product PUID

  Read Only: true

  Maximum Length: 120

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

  Read Only: true

  The subscription start date of the subscription balance register commitments.
• TrueupUsageFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether true-up for the usage is enabled.

{
    "type":"object",
    "properties":{
        "ActualUsageAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The consumed amount of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ActualUsageQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The consumed quantity of the subscription balance commitments.",
            "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 commitments.",
            "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 register commitments.",
            "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 register commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceCommitmentId":{
            "type":"integer",
            "description":"The balance register commitment identifier of the subscription balance register commitments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceCommitmentNumber":{
            "title":"Commitment Period Number",
            "maxLength":120,
            "type":"string",
            "description":"The balance register commitment number of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance commitments.",
            "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 commitments.",
            "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 commitments.",
            "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 register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance commitment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance commitment 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 commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the subscription balance commitments.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExtendedPrecision":{
            "title":"Extended Precision",
            "type":"integer",
            "description":"The actual extended precision of the subscription balance commitments.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":2
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance commitment 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 commitments.",
            "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 commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LeCommitmentCurrentDate":{
            "title":"Date",
            "type":"string",
            "description":"The current legal entity date of the subscription balance commitments.",
            "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 commitments.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "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 commitments.",
            "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 commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ProductClosedDate":{
            "title":"Product Close Date",
            "type":"string",
            "description":"The product closed date of the subscription balance register commitments.",
            "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 commitments.",
            "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 register commitments.",
            "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 register commitments.",
            "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 commitments.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance register commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance register commitments.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionEndDate":{
            "title":"Subscription End Date",
            "type":"string",
            "description":"The subscription end date of the subscription balance register commitments.",
            "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 register commitments.",
            "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 register commitments.",
            "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 commitments.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TrueupUsageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether true-up for the usage is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top