Jump to

• Request
• Response

Get all subscription balance register allowance grants

get

/crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods/{BalanceRegisterPeriodNumber}/child/allowanceGrants

Request

Path Parameters

• 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=
• BalanceRegisterPeriodNumber(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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • AllowanceGrantAltKey Finds the subscription balance allowance grant with the specified alternative key.
    Finder Variables
    • AllowanceGrantNumber; string; The balance allowance grant number used to find balance allowance grant alternative key.
  • PrimaryKey Finds the subscription balance allowance grant with the specified primary key.
    Finder Variables
    • AllowanceGrantId; integer; The unique identifier of the subscription balance allowance grant.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AllowanceGrantId; integer; The balance register allowance grant identifier of the subscription balance register allowance grants.
  • AllowanceGrantNumber; string; The balance register allowance grant number of the subscription balance allowance grants.
  • Amount; number; The amount of the subscription balance allowance grants.
  • BalanceCode; string; The balance code of the subscription balance allowance grants.
  • BalanceRegisterId; integer; The balance register identifier of the subscription balance allowance grants.
  • BalanceRegisterPeriodId; integer; The balance register period identifier of the subscription balance allowance grants.
  • BalanceRegisterPeriodNumber; string; The balance register period number of the subscription balance register allowance grants.
  • ConsumedAmount; number; The consumed amount of the subscription balance allowance grants.
  • ConsumedQuantity; number; The consumed quantity of the subscription balance allowance grants.
  • CreatedBy; string; The user who created the subscription balance allowance grant.
  • CreationDate; string; The date when the subscription balance allowance grant was created.
  • CurrencyCode; string; The currency code of the subscription balance allowance grants.
  • EndDate; string; The date when the allowance grant ends.
  • GrantDate; string; The date when the allowance is granted.
  • LastUpdateDate; string; The date when the subscription balance allowance grant was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the subscription balance allowance grants.
  • LastUpdatedBy; string; The user who has last updated the subscription balance allowance grants.
  • ObjectVersionNumber; integer; The object version number updated after every update of a subscription balance allowance grants.
  • PartyName; string; The party name of the subscription balance register allowance grants.
  • PartyNumber; string; The party number of the subscription balance register allowance grants.
  • ProductEndDate; string; The product end date of the subscription balance register allowance grants.
  • ProductName; string; The product name of the subscription balance allowance grants.
  • ProductNumber; string; The product number of the subscription balance allowance grants.
  • ProductStartDate; string; The product start date of the subscription balance register allowance grants.
  • Quantity; number; The quantity of the subscription balance allowance grants.
  • QuantityUnitOfMeasure; string; The quantity unit of measure of the subscription balance allowance grants.
  • RemainingAmount; number; The remaining amount of the subscription balance allowance grants.
  • RemainingQuantity; number; The remaining quantity of the subscription balance allowance grants.
  • RolloverEndDate; string; The rollover end date of the subscription balance allowance grants.
  • StartDate; string; The start date of the subscription balance allowance grants.
  • SubscriptionEndDate; string; The subscription end date of the subscription balance register allowance grants.
  • SubscriptionNumber; string; The subscription number of the subscription balance allowance grants.
  • SubscriptionProductPuid; string; The subscription product PUID of the subscription balance allowance grants.
  • SubscriptionStartDate; string; The subscription start date of the subscription balance register allowance grants.
  • TerminatedAmount; number; The terminated amount of the subscription balance register allowance grants.
  • TerminatedQuantity; number; The terminated quantity of the subscription balance register allowance grants.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• 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.

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-registerPeriods-allowanceGrants

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-allowanceGrants-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object subscriptionBalanceRegisters-registerPeriods-allowanceGrants-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-allowanceGrants-item-response"
    }
}

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 : subscriptionBalanceRegisters-registerPeriods-allowanceGrants-item-response

Type: object

Show Source

• 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
  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.
• 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.
• 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.
• 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.
• 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.
• 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
  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.
• 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":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance allowance grants.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TerminatedQuantity":{
            "title":"Terminated Quantity",
            "type":"number",
            "description":"The terminated quantity of the subscription balance register allowance grants.",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "TerminatedAmount":{
            "title":"Terminated Amount",
            "type":"number",
            "description":"The terminated amount of the subscription balance register allowance grants.",
            "nullable":true,
            "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
        },
        "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
        },
        "Amount":{
            "type":"number",
            "description":"The amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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
        },
        "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
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the allowance grant ends.",
            "format":"date",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        }
    }
}

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