Jump to

• Request
• Response
• Examples

Get all covered levels

get

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels

Request

Path Parameters

• SubscriptionNumber(required): string
  The alternate identifier of the subscription.
• SubscriptionProductPuid(required): string
  The subscription product PUID.

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:
  
  

  • CoveredLevelPuidAltKey: Finds a covered level with the specified alternate key.
    Finder Variables:
    • CoveredLevelPuid; string; The alternate primary identifier of the covered level.
  • PrimaryKey: Finds a covered level with the specified covered level ID.
    Finder Variables:
    • CoveredLevelId; integer; The unique primary identifier of the covered level.
• 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:
  

  • AssetGroupId; integer; The unique identifier of the asset group.
  • AssetId; integer; The unique identifier of the asset.
  • AssetSerialNumber; string; The universal serial number associated with the asset.
  • CalculatedCreditAmount; number; The calculated credit amount of the child covered level.
  • CancelDescription; string; The cancel description associated with a child covered level.
  • CanceledAmount; number; The amount that was cancelled.
  • CloseDescription; string; The close description associated with a child covered level.
  • ClosedAmount; number; The amount when the covered level was closed.
  • CorpCurrencyCode; string; The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • CoveredLevelId; integer; The unique identifier of the covered level.
  • CoveredLevelPuid; string; The public unique identifier of the covered level.
  • CreatedBy; string; The user who created the record.
  • CreationDate; string; The date when the record was created.
  • CreditedAmount; number; The credited amount for the covered level.
  • CurcyConvRateType; string; The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • CurrencyCode; string; The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • CustomerAccountId; integer; The unique identifier of the customer account associated with child covered level.
  • EndDate; string; The end date for the covered level.
  • HierarchyTotal; number; The total when the covered level was closed.
  • InventoryItemId; integer; The unique identifier of the inventory item.
  • InvoiceText; string; The text to be included in the invoice.
  • InvoicedAmount; number; The invoiced amount.
  • ItemUnitOfMeasure; string; The unit of measure used by the item.
  • LastUpdateDate; string; The date when the record was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the record.
  • LastUpdatedBy; string; The user who last updated the record.
  • OverrideCreditAmount; number; The override credit amount of the child covered level.
  • ParentCoveredAssetId; integer; The unique identifier of the parent covered asset.
  • ParentCoveredLevelId; integer; The parent level for the level.
  • PartyId; integer; The unique identifier of the party associated with child covered level.
  • PartySiteId; integer; The unique identifier of the party site associated with child covered level.
  • PriceAsOf; string; The price of the covered level.
  • PriceListId; integer; The unique identifier of the price list.
  • PriceUnitOfMeasure; string; The unit of measure used by the item.
  • PriceUnitOfMeasureName; string; The name of the unit of measure.
  • PricingError; string; Any errors associated with the pricing.
  • ProductGroupId; integer; The unique identifier of the product group.
  • Quantity; number; The quantity for which the bill line was charged.
  • RenewalType; string; The type of renewal.
  • RenewedDate; string; The date when the covered level was renewed.
  • RevenueOption; string; Revenue Option
  • RollupTotal; number; The total when the covered level was closed.
  • SerialNumber; string; The serial number of the child covered level.
  • StartDate; string; The start date for the covered level.
  • Status; string; The status of the covered level.
  • StatusName; string; The description of the status.
  • SubscriptionId; integer; The unique identifier of the associated subscription.
  • SubscriptionProductId; integer; The unique identifier of the subscription product.
  • SuppressedCreditAmount; number; The suppressed amount for the credit.
  • SuspendCreditMethod; string; The suspend method for the credit after the covered level was closed.
  • TaxAmount; number; The amount of tax to be deducted.
  • TaxError; string; The tax error for the covered level.
  • TotalContractValue; number; The total contract value
  • Type; string; The type of the covered level.
• 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 : subscriptions-products-coveredLevels

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/subscriptions-products-coveredLevels-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object subscriptions-products-coveredLevels-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-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 : subscriptions-products-coveredLevels-item-response

Type: object

Show Source

• Address: string
  Title: Address

  The address of the party site associated with child covered level.
• AssetGroupId: integer (int64)
  The unique identifier of the asset group.
• AssetGroupName: string
  Title: Asset Group Name

  The name of the asset group.
• AssetGroupNumber: string
  Title: Asset Group Number

  The alternate identifier of an asset group.
• AssetId: integer (int64)
  The unique identifier of the asset.
• AssetName: string
  Title: Covered Level Asset Name

  The name of the asset.
• AssetSerialNumber: string
  Title: Covered Asset Serial Number

  The universal serial number associated with the asset.
• billLines: array Bill Lines
  Title: Bill Lines

  The bill lines resource is used to view, create, update, and delete the subscription bill line details.
• CalculatedCreditAmount: number
  Title: Calculated Credit Amount

  The calculated credit amount of the child covered level.
• CancelDescription: string
  Title: Cancellation Description

  Maximum Length: 2000

  The cancel description associated with a child covered level.
• CanceledAmount: number
  The amount that was cancelled.
• CanceledDate: string (date)
  Title: Canceled Date

  The date of cancellation.
• CancelReason: string
  Title: Cancellation Reason

  Maximum Length: 30

  The reason for cancellation.
• charges: array Charges
  Title: Charges

  The charges resource is used to view, create, update, and delete the charges for a subscription.
• childCoveredLevels: array Child Covered Levels
  Title: Child Covered Levels

  The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.
• ClosedAmount: number
  The amount when the covered level was closed.
• ClosedDate: string (date)
  Title: Covered Level Close Date

  The date when the covered level was closed.
• CloseDescription: string
  Title: Covered Level Close Description

  Maximum Length: 2000

  The close description associated with a child covered level.
• CloseReason: string
  Title: Covered Level Close Reason

  Maximum Length: 30

  The reason when the covered level was closed.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CoveredLevelId: integer (int64)
  The unique identifier of the covered level.
• CoveredLevelName: string
  Title: Covered Level Name

  Maximum Length: 300

  The name of the covered level.
• CoveredLevelParentPuid: string
  The covered parent for the parent.
• CoveredLevelPuid: string
  Maximum Length: 120

  The public unique identifier of the covered level.
• CoveredLevlName: string
  Title: Covered Level Name

  The name of the covered level associated with child covered level.
• CoveredLevlNumber: string
  Title: Covered Level Number

  The alternate identifier of the covered level associated with child covered level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• CreditedAmount: number
  The credited amount for the covered level.
• CurcyConvRateType: string
  Maximum Length: 30

  The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Maximum Length: 15

  The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CustomerAccountId: integer (int64)
  The unique identifier of the customer account associated with child covered level.
• CustomerName: string
  Title: Customer Account

  The name of the customer associated with child covered level.
• CustomerNumber: string
  Title: Customer Account Number

  The alternate unique identifier of the customer associated with child covered level.
• Description: string
  Title: Covered Level Description

  The description of the covered level.
• Duration: integer
  The duration for which the covered level is active.
• EndDate: string (date)
  Title: Covered Level End Date

  The end date for the covered level.
• ExplodeAssetHierarchy: string
  The explode hierarchy for the asset.
• GenerateBillingSchedule: string
  The schedule by the bill is generated.
• HierarchyTotal: number
  The total when the covered level was closed.
• InventoryItemId: integer (int64)
  The unique identifier of the inventory item.
• InvoicedAmount: number
  The invoiced amount.
• InvoiceText: string
  Maximum Length: 2000

  The text to be included in the invoice.
• ItemUnitOfMeasure: string
  Maximum Length: 15

  The unit of measure used by the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• LineNumber: string
  Title: Number

  Maximum Length: 300

  The line number.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OverrideCreditAmount: number
  Title: Override Credit Amount

  The override credit amount of the child covered level.
• ParentCoveredAssetId: integer (int64)
  The unique identifier of the parent covered asset.
• ParentCoveredLevelId: integer (int64)
  The parent level for the level.
• PartyId: integer (int64)
  The unique identifier of the party associated with child covered level.
• PartyName: string
  Title: Party Name

  The name of the party associated with child covered level.
• PartyNumber: string
  Title: Party Number

  The alternate identifier of the party associated with child covered level.
• PartySite: string
  Title: Party Site Number

  The name of the party site associated with child covered level.
• PartySiteId: integer (int64)
  The unique identifier of the party site associated with child covered level.
• Period: string
  Maximum Length: 80

  The period during which the covered level is used.
• PriceAsOf: string (date)
  The price of the covered level.
• PriceListId: integer (int64)
  The unique identifier of the price list.
• PriceUnitOfMeasure: string
  Maximum Length: 30

  The unit of measure used by the item.
• PriceUnitOfMeasureName: string
  Title: Pricing UOM

  The name of the unit of measure.
• PricingError: string
  Maximum Length: 1000

  Any errors associated with the pricing.
• ProductGroupId: integer (int64)
  The unique identifier of the product group.
• ProductGroupName: string
  Title: Product Group Name

  The name of the product group.
• ProductGroupNumber: string
  Title: Product Group Number

  The alternate identifier of a product group.
• ProductName: string
  Title: Product Name

  The name of the product.
• PutOnHoldFlag: boolean
  Indicates if the covered level has been put on hold.
• Quantity: number
  Title: Quantity

  Default Value: 1

  The quantity for which the bill line was charged.
• relationships: array Relationships
  Title: Relationships

  The relationships resource is used to view, create, update, and delete the subscription product relationships.
• RemoveHoldFlag: boolean
  Indicates if the covered level's hold has to be removed.
• RenewalType: string
  Title: Renewal Type

  Maximum Length: 30

  The type of renewal.
• RenewedDate: string (date)
  The date when the covered level was renewed.
• RepriceFlag: boolean
  Indicates whether the subscription child covered level should be repriced or not. If passed as 'true', the subscription child covered level will be repriced.
• ReturnCreditMethod: string
  Title: Close Credit Method

  Maximum Length: 230

  The return method for the credit after the covered level was closed.
• RevenueOption: string
  Title: Revenue Accounting Option

  Maximum Length: 30

  Revenue Option
• RollupTotal: number
  The total when the covered level was closed.
• SerialNumber: string
  Title: Covered Asset Serial Number

  Read Only: true

  Maximum Length: 80

  The serial number of the child covered level.
• SourceKey: string
  Maximum Length: 120

  The source key of the child covered level.
• SourceLineKey: string
  Maximum Length: 120

  The source line key of the child covered level.
• SourceLineNumber: string
  Maximum Length: 120

  The source line number of the child covered level.
• SourceNumber: string
  Maximum Length: 120

  The source number of the child covered level.
• SourceSystem: string
  Maximum Length: 30

  The source system of the child covered level.
• StartDate: string (date)
  Title: Covered Level Start Date

  The start date for the covered level.
• Status: string
  Title: Covered Level Status

  Maximum Length: 30

  The status of the covered level.
• StatusName: string
  Title: Status

  The description of the status.
• SubscriptionId: integer (int64)
  The unique identifier of the associated subscription.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.
• SuppressedCreditAmount: number
  The suppressed amount for the credit.
• SuspendCreditMethod: string
  Maximum Length: 30

  The suspend method for the credit after the covered level was closed.
• SuspendedDate: string (date)
  Title: Covered Level Suspend Date

  The date when the covered level was suspended.
• SuspendReason: string
  Title: Covered Level Suspend Reason

  Maximum Length: 30

  The reason when the covered level was suspended.
• TaxAmount: number
  The amount of tax to be deducted.
• TaxError: string
  Maximum Length: 4000

  The tax error for the covered level.
• TotalContractValue: number
  Title: Covered Level Contract Value

  The total contract value
• Type: string
  Title: Type

  Maximum Length: 30

  The type of the covered level.
• TypeName: string
  Title: Covered Level Type

  The type name associated with the covered level.
• UnitPrice: number
  Title: Unit Price

  The unit price of the covered level associated with child covered level.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The cancel description associated with a child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group Name",
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RollupTotal":{
            "type":"number",
            "description":"The total when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentCoveredAssetId":{
            "type":"integer",
            "description":"The unique identifier of the parent covered asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "relationships":{
            "title":"Relationships",
            "type":"array",
            "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-relationships-item-response"
            }
        },
        "TaxAmount":{
            "type":"number",
            "description":"The amount of tax to be deducted.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The source key of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason when the covered level was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The covered parent for the parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The source number of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the party site associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date of cancellation.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"The explode hierarchy for the asset.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Covered Level Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetGroupNumber":{
            "title":"Asset Group Number",
            "type":"string",
            "description":"The alternate identifier of an asset group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreditedAmount":{
            "type":"number",
            "description":"The credited amount for the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The description of the status.",
            "nullable":true,
            "x-queryable":true
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-item-response"
            }
        },
        "SuppressedCreditAmount":{
            "type":"number",
            "description":"The suppressed amount for the credit.",
            "nullable":true,
            "x-queryable":true
        },
        "childCoveredLevels":{
            "title":"Child Covered Levels",
            "type":"array",
            "description":"The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-childCoveredLevels-item-response"
            }
        },
        "PriceListId":{
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InvoicedAmount":{
            "type":"number",
            "description":"The invoiced amount.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendedDate":{
            "title":"Covered Level Suspend Date",
            "type":"string",
            "description":"The date when the covered level was suspended.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetGroupName":{
            "title":"Asset Group Name",
            "type":"string",
            "description":"The name of the asset group.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Covered Level Description",
            "type":"string",
            "description":"The description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "type":"number",
            "description":"The amount that was cancelled.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Number",
            "maxLength":"300",
            "type":"string",
            "description":"The line number.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the associated subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CoveredLevelPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the covered level.",
            "nullable":false,
            "x-queryable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":"30",
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "billLines":{
            "title":"Bill Lines",
            "type":"array",
            "description":"The bill lines resource is used to view, create, update, and delete the subscription bill line details.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-item-response"
            }
        },
        "TotalContractValue":{
            "title":"Covered Level Contract Value",
            "type":"number",
            "description":"The total contract value",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason when the covered level was suspended.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HierarchyTotal":{
            "type":"number",
            "description":"The total when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The end date for the covered level.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedAmount":{
            "type":"number",
            "description":"The amount when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the covered level.",
            "nullable":false,
            "x-queryable":true
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"The schedule by the bill is generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Covered Level Close Date",
            "type":"string",
            "description":"The date when the covered level was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CloseDescription":{
            "title":"Covered Level Close Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The close description associated with a child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":"30",
            "type":"string",
            "description":"The source system of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The type name associated with the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ParentCoveredLevelId":{
            "type":"integer",
            "description":"The parent level for the level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SuspendCreditMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"The suspend method for the credit after the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The start date for the covered level.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerNumber":{
            "title":"Customer Account Number",
            "type":"string",
            "description":"The alternate unique identifier of the customer associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AssetGroupId":{
            "type":"integer",
            "description":"The unique identifier of the asset group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemUnitOfMeasure":{
            "maxLength":"15",
            "type":"string",
            "description":"The unit of measure used by the item.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelName":{
            "title":"Covered Level Name",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "Period":{
            "maxLength":"80",
            "type":"string",
            "description":"The period during which the covered level is used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration for which the covered level is active.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of renewal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssetName":{
            "title":"Covered Level Asset Name",
            "type":"string",
            "description":"The name of the asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AssetSerialNumber":{
            "title":"Covered Asset Serial Number",
            "type":"string",
            "description":"The universal serial number associated with the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason for cancellation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SerialNumber":{
            "title":"Covered Asset Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"The serial number of the child covered level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReturnCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":"230",
            "type":"string",
            "description":"The return method for the credit after the covered level was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceLineNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The source line number of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "type":"string",
            "description":"The alternate identifier of a product group.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceAsOf":{
            "type":"string",
            "description":"The price of the covered level.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartySite":{
            "title":"Party Site Number",
            "type":"string",
            "description":"The name of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":"2000",
            "type":"string",
            "description":"The text to be included in the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaxError":{
            "maxLength":"4000",
            "type":"string",
            "description":"The tax error for the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLineKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The source line key of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RepriceFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription child covered level should be repriced or not. If passed as 'true', the subscription child covered level will be repriced.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewedDate":{
            "type":"string",
            "description":"The date when the covered level was renewed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "PriceUnitOfMeasure":{
            "maxLength":"30",
            "type":"string",
            "description":"The unit of measure used by the item.",
            "nullable":true,
            "x-queryable":true
        },
        "PutOnHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level has been put on hold.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The alternate identifier of the party associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level's hold has to be removed.",
            "nullable":true,
            "x-queryable":false
        },
        "PricingError":{
            "maxLength":"1000",
            "type":"string",
            "description":"Any errors associated with the pricing.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Bill Lines

Type: array

Title: Bill Lines

The bill lines resource is used to view, create, update, and delete the subscription bill line details.

Show Source

• Array of: object subscriptions-products-coveredLevels-billLines-item-response

{
    "title":"Bill Lines",
    "type":"array",
    "description":"The bill lines resource is used to view, create, update, and delete the subscription bill line details.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-item-response"
    }
}

Nested Schema : Charges

Type: array

Title: Charges

The charges resource is used to view, create, update, and delete the charges for a subscription.

Show Source

• Array of: object subscriptions-products-coveredLevels-charges-item-response

{
    "title":"Charges",
    "type":"array",
    "description":"The charges resource is used to view, create, update, and delete the charges for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-item-response"
    }
}

Nested Schema : Child Covered Levels

Type: array

Title: Child Covered Levels

The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.

Show Source

• Array of: object subscriptions-products-coveredLevels-childCoveredLevels-item-response

{
    "title":"Child Covered Levels",
    "type":"array",
    "description":"The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-childCoveredLevels-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 : Relationships

Type: array

Title: Relationships

The relationships resource is used to view, create, update, and delete the subscription product relationships.

Show Source

• Array of: object subscriptions-products-coveredLevels-relationships-item-response

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, update, and delete the subscription product relationships.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-relationships-item-response"
    }
}

Nested Schema : subscriptions-products-coveredLevels-billLines-item-response

Type: object

Show Source

• Amount: number
  Title: Amount

  The amount of the bill.
• billAdjustments: array Bill Adjustments
  Title: Bill Adjustments

  The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details.
• BillingPeriod: number
  Title: Sequence

  The billing period.
• BillLineId: integer (int64)
  The unique identifier of the bill line.
• BillLinePuid: string
  Maximum Length: 120

  The bill line PUID.
• BusinessUnitId: integer
  The ID of the business unit associated with the bill line.
• ChargeDefinition: string
  Maximum Length: 30

  The definition that indicates the purpose of the charge.
• ChargeId: integer (int64)
  The unique identifier of the charge.
• ChargeName: string
  Title: Charge Name

  Maximum Length: 120

  The name of the charge.
• ChargePeriod: number
  Title: Period

  The charge period.
• ChargePeriodFactor: number
  The change period factor associated with the bill line.
• ChargePuid: string
  Read Only: true

  The charge PUID.
• CoveredLevelId: integer (int64)
  The unique identifier of the coverage level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the bill line.
• CreationDate: string (date-time)
  Read Only: true

  The date when the bill line was created.
• CreditMemoAmount: number
  The amount for the credit memo.
• CreditMemoFlag: string
  Indicates if there is a credit memo associated with the bill line.
• CreditMemoReason: string
  The reason to raise the credit memo.
• CreditMemoReasonCode: string
  Maximum Length: 30

  The code of the credit memo reason code.
• CustomerTrxTypeSequenceId: integer (int64)
  The unique identifier of the customer transaction type sequence.
• DateBilledFrom: string (date)
  Title: Bill-from Date

  The date from which the billing is done.
• DateBilledTo: string (date)
  Title: Bill-to Date

  The date to which the billing is done.
• DateToInterface: string (date)
  Title: Interface Date

  The date to interface.
• InterfacedFlag: boolean
  Title: Interfaced

  Maximum Length: 1

  Default Value: false

  Indicates whether the bill line is interfaced or not.
• InvoiceBillLineId: integer (int64)
  The invoice bill line ID.
• InvoiceDate: string (date)
  The date when the invoice was raised.
• InvoiceText: string
  Title: Invoice Text

  Maximum Length: 240

  The invoice text of the transaction.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the bill line was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the bill line.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the bill line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListPrice: number
  The list price.
• MilestoneEventId: integer (int64)
  The ID of the milestone event associated with the bill line.
• MilestoneEventName: string
  The name of the milestone event associated with the bill line.
• NewCreditMemoPUID: string
  The unique public identifier of the new credit memo.
• PricedQuantity: number
  The quantity for which the bill line was charged.
• PricingError: string
  Maximum Length: 1000

  The pricing error.
• RecurringFlag: boolean
  Maximum Length: 1

  Indicates whether this line is recurring or not.
• RetrieveInvoiceFlag: boolean
  Title: Retrieve Invoice from Receivables

  Maximum Length: 1

  Retrieve Invoice Flag
• RevenueLineId: integer (int64)
  The unique identifier of the revenue line.
• RevenueOption: string
  Title: Revenue Accounting Option

  Maximum Length: 30

  Revenue Option
• RevenuePeriod: string
  Title: Revenue Effectivity Periods

  Maximum Length: 30

  Revenue Period
• SentDate: string (date)
  Title: Sent Date

  The date invoice information is sent to receivables.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.
• SummarizedBillLineId: integer
  Title: Summarized Bill Line ID

  Summarized Bill Line ID
• TransactionAmount: number
  Title: Invoice Amount

  The amount of the transaction.
• TransactionClass: string
  Title: Transaction Class

  Maximum Length: 30

  The class of the transaction.
• TransactionClassMeaning: string
  Title: Class

  The meaning of transaction class lookup.
• TransactionDate: string (date)
  Title: Invoice Date

  The date of the transaction.
• TransactionNumber: string
  Title: Invoice Number

  Maximum Length: 30

  The alternate identifier of the transaction.
• TransactionTax: number
  Title: Tax

  The tax related to the transaction.
• TransactionTypeName: string
  The transaction type name of the subscription bill line.
• TruedUpYn: string
  Maximum Length: 3

  Indicates whether the bill line has a true up period.
• TrxId: integer (int64)
  The transaction identifier associated with the billing.
• TrxLineId: integer (int64)
  The unique identifier of the transaction line.
• UsageAcquiredFlag: boolean
  Maximum Length: 1

  Indicates whether the usage has been acquired or not.
• UsageCaptureDate: string (date)
  The usage capture date.
• UsageChargeType: string
  Title: Usage Charge Type

  Maximum Length: 30

  The type of usage charge.
• UsageChargeTypeName: string
  The name of the usage charge type.
• UsageFlag: boolean
  Maximum Length: 1

  Indicates whether the line is a usage line or not.
• UsagePricedFlag: boolean
  Maximum Length: 1

  Indicates whether usage line has been priced or not.
• UsageQuantity: number
  Title: Usage Quantity

  The usage quantity.

{
    "type":"object",
    "properties":{
        "TrxId":{
            "type":"integer",
            "description":"The transaction identifier associated with the billing.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the bill line was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTypeName":{
            "type":"string",
            "description":"The transaction type name of the subscription bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargePuid":{
            "type":"string",
            "description":"The charge PUID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeDefinition":{
            "maxLength":"30",
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "SentDate":{
            "title":"Sent Date",
            "type":"string",
            "description":"The date invoice information is sent to receivables.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePricedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether usage line has been priced or not.",
            "nullable":true,
            "x-queryable":true
        },
        "ListPrice":{
            "type":"number",
            "description":"The list price.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionTax":{
            "title":"Tax",
            "type":"number",
            "description":"The tax related to the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueLineId":{
            "type":"integer",
            "description":"The unique identifier of the revenue line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreditMemoReason":{
            "type":"string",
            "description":"The reason to raise the credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillLinePuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The bill line PUID.",
            "nullable":false,
            "x-queryable":true
        },
        "UsageFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the line is a usage line or not.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the bill line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageChargeTypeName":{
            "type":"string",
            "description":"The name of the usage charge type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "billAdjustments":{
            "title":"Bill Adjustments",
            "type":"array",
            "description":"The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-billAdjustments-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the bill line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingPeriod":{
            "title":"Sequence",
            "type":"number",
            "description":"The billing period.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The ID of the business unit associated with the bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":"120",
            "type":"string",
            "description":"The name of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "RetrieveInvoiceFlag":{
            "title":"Retrieve Invoice from Receivables",
            "maxLength":"1",
            "type":"boolean",
            "description":"Retrieve Invoice Flag",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneEventId":{
            "type":"integer",
            "description":"The ID of the milestone event associated with the bill line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TrxLineId":{
            "type":"integer",
            "description":"The unique identifier of the transaction line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SummarizedBillLineId":{
            "title":"Summarized Bill Line ID",
            "type":"integer",
            "description":"Summarized Bill Line ID",
            "nullable":true,
            "x-queryable":true
        },
        "UsageCaptureDate":{
            "type":"string",
            "description":"The usage capture date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RevenuePeriod":{
            "title":"Revenue Effectivity Periods",
            "maxLength":"30",
            "type":"string",
            "description":"Revenue Period",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the bill line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditMemoFlag":{
            "type":"string",
            "description":"Indicates if there is a credit memo associated with the bill line.",
            "nullable":true,
            "x-queryable":false
        },
        "DateToInterface":{
            "title":"Interface Date",
            "type":"string",
            "description":"The date to interface.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "UsageChargeType":{
            "title":"Usage Charge Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of usage charge.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionNumber":{
            "title":"Invoice Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "NewCreditMemoPUID":{
            "type":"string",
            "description":"The unique public identifier of the new credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargePeriodFactor":{
            "type":"number",
            "description":"The change period factor associated with the bill line.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerTrxTypeSequenceId":{
            "type":"integer",
            "description":"The unique identifier of the customer transaction type sequence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TruedUpYn":{
            "maxLength":"3",
            "type":"string",
            "description":"Indicates whether the bill line has a true up period.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditMemoReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of the credit memo reason code.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceText":{
            "title":"Invoice Text",
            "maxLength":"240",
            "type":"string",
            "description":"The invoice text of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditMemoAmount":{
            "type":"number",
            "description":"The amount for the credit memo.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionClass":{
            "title":"Transaction Class",
            "maxLength":"30",
            "type":"string",
            "description":"The class of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":"30",
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvoiceDate":{
            "type":"string",
            "description":"The date when the invoice was raised.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePeriod":{
            "title":"Period",
            "type":"number",
            "description":"The charge period.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date of the transaction.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceBillLineId":{
            "type":"integer",
            "description":"The invoice bill line ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UsageAcquiredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the usage has been acquired or not.",
            "nullable":true,
            "x-queryable":true
        },
        "InterfacedFlag":{
            "title":"Interfaced",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the bill line is interfaced or not.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount of the bill.",
            "nullable":true,
            "x-queryable":true
        },
        "DateBilledTo":{
            "title":"Bill-to Date",
            "type":"string",
            "description":"The date to which the billing is done.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "UsageQuantity":{
            "title":"Usage Quantity",
            "type":"number",
            "description":"The usage quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the coverage level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PricedQuantity":{
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneEventName":{
            "type":"string",
            "description":"The name of the milestone event associated with the bill line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionAmount":{
            "title":"Invoice Amount",
            "type":"number",
            "description":"The amount of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurringFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this line is recurring or not.",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The unique identifier of the bill line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DateBilledFrom":{
            "title":"Bill-from Date",
            "type":"string",
            "description":"The date from which the billing is done.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionClassMeaning":{
            "title":"Class",
            "type":"string",
            "description":"The meaning of transaction class lookup.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The unique identifier of the charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PricingError":{
            "maxLength":"1000",
            "type":"string",
            "description":"The pricing error.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the bill line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Bill Adjustments

Type: array

Title: Bill Adjustments

The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details.

Show Source

• Array of: object subscriptions-products-coveredLevels-billLines-billAdjustments-item-response

{
    "title":"Bill Adjustments",
    "type":"array",
    "description":"The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-billLines-billAdjustments-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 : subscriptions-products-coveredLevels-billLines-billAdjustments-item-response

Type: object

Show Source

• AdjustmentBasis: string
  Title: Basis

  Maximum Length: 30

  The adjustment basis
• AdjustmentName: string
  Title: Adjustment

  Maximum Length: 120

  The adjustment name
• AdjustmentReasonCode: string
  Maximum Length: 30

  The code of the adjustment reason.
• AdjustmentType: string
  Title: Type

  Maximum Length: 30

  The adjustment type
• AdjustmentValue: number
  Title: Value

  The adjustment value
• AutoAdjustmentFlag: boolean
  Maximum Length: 3

  Flag indicating whether the adjustment is automatic or not
• BasisEnableFlag: boolean
  Indicates if the basis has been enabled for the bill.
• BillAdjustmentId: integer (int64)
  The bill adjustment ID
• BillAdjustmentPuid: string
  Maximum Length: 120

  The bill adjustment PUID
• BillLineId: integer (int64)
  The bill line ID
• ChargeAdjustmentId: integer (int64)
  The charge adjustment ID
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The created by
• CreationDate: string (date-time)
  Read Only: true

  The creation date
• CurrencyCode: string
  The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• Effectivity: string
  Maximum Length: 30

  The adjustment effectivity
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The last updated by
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfPeriods: number
  The number of periods
• PeriodFrom: number
  The period from
• PeriodUntil: number
  The period until
• Reason: string
  Title: Reason Details

  Maximum Length: 120

  The adjustment reason
• RevenueAdjustmentFromDate: string (date)
  Title: Revenue Effective Start Date

  Revenue Adjustment From Date
• RevenueAdjustmentToDate: string (date)
  Title: Revenue Effective End Date

  Revenue Adjustment To Date
• RevenueOption: string
  Title: Revenue Accounting Option

  Maximum Length: 30

  Revenue Option
• RevenuePeriod: string
  Title: Revenue Effectivity Periods

  Maximum Length: 30

  Revenue Period
• SequenceNumber: number
  Title: Sequence

  The sequence number
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":"3",
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":"30",
            "type":"string",
            "description":"The adjustment basis",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenueAdjustmentToDate":{
            "title":"Revenue Effective End Date",
            "type":"string",
            "description":"Revenue Adjustment To Date",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Details",
            "maxLength":"120",
            "type":"string",
            "description":"The adjustment reason",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"The sequence number",
            "nullable":false,
            "x-queryable":true
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true,
            "x-queryable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":"30",
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillAdjustmentPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The bill adjustment PUID",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillAdjustmentId":{
            "type":"integer",
            "description":"The bill adjustment ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RevenueAdjustmentFromDate":{
            "title":"Revenue Effective Start Date",
            "type":"string",
            "description":"Revenue Adjustment From Date",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AdjustmentReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-queryable":true
        },
        "Effectivity":{
            "maxLength":"30",
            "type":"string",
            "description":"The adjustment effectivity",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The adjustment type",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":false,
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RevenuePeriod":{
            "title":"Revenue Effectivity Periods",
            "maxLength":"30",
            "type":"string",
            "description":"Revenue Period",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":"120",
            "type":"string",
            "description":"The adjustment name",
            "nullable":true,
            "x-queryable":true
        },
        "BasisEnableFlag":{
            "type":"boolean",
            "description":"Indicates if the basis has been enabled for the bill.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The last update login",
            "nullable":true,
            "readOnly":true,
            "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."
        }
    }
}

Nested Schema : subscriptions-products-coveredLevels-charges-item-response

Type: object

Show Source

• adjustments: array Adjustments
  Title: Adjustments

  The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.
• AggregationMethod: string
  Maximum Length: 30

  The aggregation method used for the charges.
• Allowance: number
  Title: Allowance

  The allowance
• AssetMeterYn: boolean
  Maximum Length: 1

  The flag whether it is an asset meter or not.
• BillingFreq: string
  Maximum Length: 30

  Billing Frequency
• BillingFreqName: string
  Title: Billing Frequency

  Maximum Length: 255

  Billing Frequency Name
• BillLineId: integer (int64)
  The bill line ID
• BlockSize: number
  Title: Block Size

  The block size
• ChargeDefinition: string
  Title: Charge Name

  Maximum Length: 30

  The definition that indicates the purpose of the charge.
• ChargeDefinitionName: string
  The charge definition name
• ChargeId: integer (int64)
  The charge ID
• chargeMilestoneEvents: array Charge Milestone Events
  Title: Charge Milestone Events

  The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.
• ChargeName: string
  Title: Charge Name

  Maximum Length: 120

  The charge name
• ChargePeriodCode: string
  Maximum Length: 30

  The code of the charge period associated with the charge.
• ChargePuid: string
  Maximum Length: 120

  The charge PUID
• chargeTiers: array Charge Tiers
  Title: Charge Tiers

  The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.
• CoveredLevelId: integer (int64)
  The unique identifier of the covered level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The created by
• CreationDate: string (date-time)
  Read Only: true

  The creation date
• EnableProration: string
  Maximum Length: 1

  Indicates whether proration is enabled or not.
• EstimatedAmount: number
  Title: Estimated Amount

  The estimated amount of the charges.
• EstimatedMethodName: string
  Title: Estimation Method

  The method used to estimate the amount.
• EstimatedQuantity: number
  Title: Estimated Quantity

  The estimated quantity for the charge.
• EstimationMethod: string
  Title: Estimation Method

  Maximum Length: 30

  The method used to estimate the amount.
• ExternalKey: string
  Maximum Length: 120

  The external key
• ExternalParentKey: string
  Maximum Length: 120

  The external parent key
• InitialMeterReadingId: integer (int64)
  The initial meter reading identifier value.
• InvoicingRuleId: integer (int64)
  The ID of the invoice rule.
• InvoicingRuleName: string
  Title: Invoicing Rule

  The name of the invoice rule.
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The last updated by
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeterDefinitionId: integer (int64)
  The unique identifier of the meter definition associated with the charges.
• MeterId: integer (int64)
  The unique identifier of the meter associated with the charges.
• MilestoneBillingFlag: boolean
  Indicates whether the billing is impacted by milestone events or not.
• MilestoneRevenueFlag: boolean
  Indicates whether the revenue is impacted by milestone events or not.
• MilestoneTemplateId: integer (int64)
  The ID of the milestone event associated with a charge.
• MilestoneTemplateName: string
  Maximum Length: 120

  The name of the milestone template associated with a charge.
• MinimumAmount: number
  Title: Minimum Amount

  The minimum amount to be charged.
• MinimumQuantity: number
  Title: Minimum Quantity

  The minimum quantity that is allowed.
• PeriodicBillingFlag: boolean
  Maximum Length: 1

  Indicates whether periodic billing is allowed or not.
• PeriodicRevenueFlag: boolean
  Title: Enable Periodic Revenue Recognition

  Maximum Length: 1

  Indicates the periodic revenue recognition of one-time charges.
• PrePaymentNumber: integer (int64)
  Title: Prepayment Number

  The prepayment number
• PricePeriodicity: string
  Title: Periodicity

  Maximum Length: 30

  The price periodicity
• PricePeriodicityName: string
  The price periodicity name
• PriceType: string
  Maximum Length: 30

  The price type
• QuotedTcv: number
  The quoted TCV of the charge.
• RecurringPricePeriodicityCode: string
  Maximum Length: 30

  The recurring price periodicity code of the charge.
• RollupFlag: boolean
  Maximum Length: 1

  Indicates if the charges are rolled up.
• SequenceNumber: integer (int32)
  The sequence number
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID
• TieredFlag: boolean
  Maximum Length: 3

  The flag indicating whether the charge has tiers
• TierType: string
  Title: Tier Type

  Maximum Length: 30

  The tier type
• TrueUpPeriod: string
  Title: True Up Period

  Maximum Length: 30

  Default Value: ORA_OSS_USAGE_BILLING_PERIOD

  The identifier of the true up period.
• TrueUpPeriodName: string
  Title: True Up Period

  The name of the true up period.
• UnitListPrice: number
  Title: List Price

  The unit list price
• UsagePriceLockFlag: boolean
  Maximum Length: 3

  Flag indicating whether the usage price is locked or not
• UsageUnitOfMeasure: string
  Maximum Length: 3

  The usage unit of measure of the charge.

{
    "type":"object",
    "properties":{
        "AggregationMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"The aggregation method used for the charges.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The charge PUID",
            "nullable":true,
            "x-queryable":true
        },
        "chargeMilestoneEvents":{
            "title":"Charge Milestone Events",
            "type":"array",
            "description":"The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-response"
            }
        },
        "adjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-adjustments-item-response"
            }
        },
        "ChargeDefinition":{
            "title":"Charge Name",
            "maxLength":"30",
            "type":"string",
            "description":"The definition that indicates the purpose of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetMeterYn":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The flag whether it is an asset meter or not.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedAmount":{
            "title":"Estimated Amount",
            "type":"number",
            "description":"The estimated amount of the charges.",
            "nullable":true,
            "x-queryable":true
        },
        "PricePeriodicityName":{
            "type":"string",
            "description":"The price periodicity name",
            "nullable":true,
            "x-queryable":true
        },
        "PrePaymentNumber":{
            "title":"Prepayment Number",
            "type":"integer",
            "description":"The prepayment number",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillingFreq":{
            "maxLength":"30",
            "type":"string",
            "description":"Billing Frequency",
            "nullable":true,
            "x-queryable":true
        },
        "MeterDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of the meter definition associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EstimationMethod":{
            "title":"Estimation Method",
            "maxLength":"30",
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodicBillingFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether periodic billing is allowed or not.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneBillingFlag":{
            "type":"boolean",
            "description":"Indicates whether the billing is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "ExternalParentKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The external parent key",
            "nullable":true,
            "x-queryable":true
        },
        "UnitListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The unit list price",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "InitialMeterReadingId":{
            "type":"integer",
            "description":"The initial meter reading identifier value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedQuantity":{
            "title":"Estimated Quantity",
            "type":"number",
            "description":"The estimated quantity for the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":"120",
            "type":"string",
            "description":"The charge name",
            "nullable":true,
            "x-queryable":true
        },
        "RecurringPricePeriodicityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The recurring price periodicity code of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "QuotedTcv":{
            "type":"number",
            "description":"The quoted TCV of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "TieredFlag":{
            "maxLength":"3",
            "type":"boolean",
            "description":"The flag indicating whether the charge has tiers",
            "nullable":true,
            "x-queryable":true
        },
        "UsagePriceLockFlag":{
            "maxLength":"3",
            "type":"boolean",
            "description":"Flag indicating whether the usage price is locked or not",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodicRevenueFlag":{
            "title":"Enable Periodic Revenue Recognition",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the periodic revenue recognition of one-time charges.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneRevenueFlag":{
            "type":"boolean",
            "description":"Indicates whether the revenue is impacted by milestone events or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "chargeTiers":{
            "title":"Charge Tiers",
            "type":"array",
            "description":"The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.",
            "items":{
                "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-chargeTiers-item-response"
            }
        },
        "MinimumAmount":{
            "title":"Minimum Amount",
            "type":"number",
            "description":"The minimum amount to be charged.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceType":{
            "maxLength":"30",
            "type":"string",
            "description":"The price type",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The last update login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the charges are rolled up.",
            "nullable":true,
            "x-queryable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":"30",
            "type":"string",
            "description":"The tier type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "type":"string",
            "description":"The name of the invoice rule.",
            "nullable":true,
            "x-queryable":false
        },
        "MeterId":{
            "type":"integer",
            "description":"The unique identifier of the meter associated with the charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChargeDefinitionName":{
            "type":"string",
            "description":"The charge definition name",
            "nullable":true,
            "x-queryable":true
        },
        "UsageUnitOfMeasure":{
            "maxLength":"3",
            "type":"string",
            "description":"The usage unit of measure of the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EnableProration":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether proration is enabled or not.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueUpPeriodName":{
            "title":"True Up Period",
            "type":"string",
            "description":"The name of the true up period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The external key",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePeriodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of the charge period associated with the charge.",
            "nullable":true,
            "x-queryable":true
        },
        "Allowance":{
            "title":"Allowance",
            "type":"number",
            "description":"The allowance",
            "nullable":true,
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "type":"integer",
            "description":"The ID of the invoice rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MilestoneTemplateName":{
            "maxLength":"120",
            "type":"string",
            "description":"The name of the milestone template associated with a charge.",
            "nullable":true,
            "x-queryable":false
        },
        "MilestoneTemplateId":{
            "type":"integer",
            "description":"The ID of the milestone event associated with a charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillingFreqName":{
            "title":"Billing Frequency",
            "maxLength":"255",
            "type":"string",
            "description":"Billing Frequency Name",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MinimumQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"The minimum quantity that is allowed.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedMethodName":{
            "title":"Estimation Method",
            "type":"string",
            "description":"The method used to estimate the amount.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PricePeriodicity":{
            "title":"Periodicity",
            "maxLength":"30",
            "type":"string",
            "description":"The price periodicity",
            "nullable":true,
            "x-queryable":true
        },
        "TrueUpPeriod":{
            "title":"True Up Period",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier of the true up period.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_BILLING_PERIOD",
            "x-queryable":true
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Adjustments

Type: array

Title: Adjustments

The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.

Show Source

• Array of: object subscriptions-products-coveredLevels-charges-adjustments-item-response

{
    "title":"Adjustments",
    "type":"array",
    "description":"The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-adjustments-item-response"
    }
}

Nested Schema : Charge Milestone Events

Type: array

Title: Charge Milestone Events

The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.

Show Source

• Array of: object subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-response

{
    "title":"Charge Milestone Events",
    "type":"array",
    "description":"The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-response"
    }
}

Nested Schema : Charge Tiers

Type: array

Title: Charge Tiers

The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.

Show Source

• Array of: object subscriptions-products-coveredLevels-charges-chargeTiers-item-response

{
    "title":"Charge Tiers",
    "type":"array",
    "description":"The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.",
    "items":{
        "$ref":"#/components/schemas/subscriptions-products-coveredLevels-charges-chargeTiers-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 : subscriptions-products-coveredLevels-charges-adjustments-item-response

Type: object

Show Source

• AdjustmentBasis: string
  Title: Basis

  Maximum Length: 30

  The adjustment basis
• AdjustmentName: string
  Title: Adjustment

  Maximum Length: 120

  The adjustment name
• AdjustmentReasonCode: string
  Title: Reason

  Maximum Length: 30

  The code of the adjustment reason.
• AdjustmentReasonMeaning: string
  Title: Reason

  The translated adjustment reason.
• AdjustmentType: string
  Title: Type

  Maximum Length: 30

  The adjustment type
• AdjustmentValue: number
  Title: Value

  The adjustment value
• AutoAdjustmentFlag: boolean
  Maximum Length: 3

  Flag indicating whether the adjustment is automatic or not
• ChargeAdjustmentId: integer (int64)
  The charge adjustment ID
• ChargeAdjustmentPuid: string
  Maximum Length: 120

  The charge adjustment PUID
• ChargeId: integer (int64)
  The charge ID
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The created by
• CreationDate: string (date-time)
  Read Only: true

  The creation date
• Effectivity: string
  Title: Effectivity

  Maximum Length: 30

  The adjustment effectivity
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The last updated by
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfPeriods: number
  The number of periods
• ObjectVersionNumber: integer (int32)
  Object version number
• PeriodFrom: number
  The period from
• PeriodUntil: number
  The period until
• Reason: string
  Title: Reason Description

  Maximum Length: 120

  The adjustment reason
• SequenceNumber: integer (int32)
  Title: Sequence

  The sequence number
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAdjustmentFlag":{
            "maxLength":"3",
            "type":"boolean",
            "description":"Flag indicating whether the adjustment is automatic or not",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentBasis":{
            "title":"Basis",
            "maxLength":"30",
            "type":"string",
            "description":"The adjustment basis",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason Description",
            "maxLength":"120",
            "type":"string",
            "description":"The adjustment reason",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "NumberOfPeriods":{
            "type":"number",
            "description":"The number of periods",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PeriodUntil":{
            "type":"number",
            "description":"The period until",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodFrom":{
            "type":"number",
            "description":"The period from",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAdjustmentPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The charge adjustment PUID",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeAdjustmentId":{
            "type":"integer",
            "description":"The charge adjustment ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the adjustment reason.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Effectivity":{
            "title":"Effectivity",
            "maxLength":"30",
            "type":"string",
            "description":"The adjustment effectivity",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The adjustment type",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentValue":{
            "title":"Value",
            "type":"number",
            "description":"The adjustment value",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AdjustmentReasonMeaning":{
            "title":"Reason",
            "type":"string",
            "description":"The translated adjustment reason.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AdjustmentName":{
            "title":"Adjustment",
            "maxLength":"120",
            "type":"string",
            "description":"The adjustment name",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The last update login",
            "nullable":true,
            "readOnly":true,
            "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 : subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-response

Type: object

Show Source

• BillingOffset: number
  The billing offset associated with a milestone event.
• BillLineId: integer (int64)
  The bill line ID associated with the milestone event.
• ChargeId: integer (int64)
  The charge ID with which the milestone event is associated.
• ChargePuid: string
  Maximum Length: 120

  Default Value: Charges.ChargePuid

  The PUID of the charge to which the milestone event is associated.
• CompletionDate: string (date)
  The completion date of the milestone event.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The login which created the milestone event.
• CreationDate: string (date-time)
  Read Only: true

  The date on which the milestone event was created.
• EventId: integer (int64)
  The ID of the milestone event.
• EventSource: string
  Maximum Length: 30

  The source of the milestone event.
• EventSourceReference: string
  Maximum Length: 120

  The source reference of the milestone event.
• EventType: string
  Maximum Length: 30

  The type of the milestone event.
• ExpectedCompletionDate: string (date)
  The expected completion date of a milestone event.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date of which the milestone event was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the milestone event the last.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login which updated the milestone event the last.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MilestoneComment: string
  Maximum Length: 300

  The milestone event comment.
• MilestoneName: string
  Maximum Length: 30

  The name of the milestone event.
• MilestonePuid: string
  Maximum Length: 120

  The milestone event PUID.
• ObjectVersionNumber: integer (int32)
  The object version number of the milestone event.
• Percentage: number
  The percentage associated with a milestone event.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the milestone event the last.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date on which the milestone event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingOffset":{
            "type":"number",
            "description":"The billing offset associated with a milestone event.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargePuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The PUID of the charge to which the milestone event is associated.",
            "nullable":true,
            "default":"Charges.ChargePuid",
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The login which created the milestone event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedCompletionDate":{
            "type":"string",
            "description":"The expected completion date of a milestone event.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EventType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "Percentage":{
            "type":"number",
            "description":"The percentage associated with a milestone event.",
            "nullable":false,
            "x-hints":{
                "precision":"5",
                "scale":"2"
            },
            "x-queryable":true
        },
        "MilestoneName":{
            "maxLength":"30",
            "type":"string",
            "description":"The name of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "MilestoneComment":{
            "maxLength":"300",
            "type":"string",
            "description":"The milestone event comment.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestonePuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The milestone event PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "EventSource":{
            "maxLength":"30",
            "type":"string",
            "description":"The source of the milestone event.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the milestone event.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"The ID of the milestone event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EventSourceReference":{
            "maxLength":"120",
            "type":"string",
            "description":"The source reference of the milestone event.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BillLineId":{
            "type":"integer",
            "description":"The bill line ID associated with the milestone event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID with which the milestone event is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CompletionDate":{
            "type":"string",
            "description":"The completion date of the milestone event.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BillingOffset"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date of which the milestone event was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login which updated the milestone event the last.",
            "nullable":true,
            "readOnly":true,
            "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 : subscriptions-products-coveredLevels-charges-chargeTiers-item-response

Type: object

Show Source

• AdditionalNumberFive: number
  Title: Additional Number Five

  The additional number five
• AdditionalNumberFour: number
  Title: Additional Number Four

  The additional number four
• AdditionalNumberOne: number
  Title: Additional Number One

  The additional number one
• AdditionalNumberSix: number
  Title: Additional Number Six

  The additional number six
• AdditionalNumberThree: number
  Title: Additional Number Three

  The additional number three
• AdditionalNumberTwo: number
  Title: Additional Number Two

  The additional number two
• AdditionalTextOne: string
  Title: Additional Text One

  Maximum Length: 4000

  The additional text one
• AdditionalTextTwo: string
  Title: Additional Text Two

  Maximum Length: 4000

  The additional text two
• AdditionalTimestampOne: string (date-time)
  Title: Additional Time-stamp One

  The additional timestamp one
• AdditionalTimestampThree: string (date-time)
  Title: Additional Time-stamp Three

  The additional timestamp three
• AdditionalTimestampTwo: string (date-time)
  Title: Additional Time-stamp Two

  The additional timestamp two
• AddtionalTextThree: string
  Title: Additional Text Three

  Maximum Length: 4000

  The additional text three
• BlockSize: number
  Title: Block Size

  The block size
• ChargeId: integer (int64)
  The charge ID
• ChargeTierId: integer (int64)
  The charge tier ID
• ChargeTierPuid: string
  Maximum Length: 120

  The charge tier PUID
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The created by
• CreationDate: string (date-time)
  Read Only: true

  The creation date
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The last updated by
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListPrice: number
  Title: List Price

  The list price
• PriceFormat: string
  Title: Price Format

  Maximum Length: 30

  The price format
• SequenceNumber: number
  The sequence number
• SubscriptionId: integer (int64)
  The subscription ID
• SubscriptionProductId: integer (int64)
  The subscription product ID
• TierFrom: number
  Title: Tier From

  The tier from
• TierTo: number
  Title: Tier To

  The tier to

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The creation date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalTimestampTwo":{
            "title":"Additional Time-stamp Two",
            "type":"string",
            "description":"The additional timestamp two",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeTierPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The charge tier PUID",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberThree":{
            "title":"Additional Number Three",
            "type":"number",
            "description":"The additional number three",
            "nullable":true,
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The list price",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberFive":{
            "title":"Additional Number Five",
            "type":"number",
            "description":"The additional number five",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The subscription ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TierTo":{
            "title":"Tier To",
            "type":"number",
            "description":"The tier to",
            "nullable":true,
            "x-queryable":true
        },
        "AddtionalTextThree":{
            "title":"Additional Text Three",
            "maxLength":"4000",
            "type":"string",
            "description":"The additional text three",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"The sequence number",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TierFrom":{
            "title":"Tier From",
            "type":"number",
            "description":"The tier from",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalNumberTwo":{
            "title":"Additional Number Two",
            "type":"number",
            "description":"The additional number two",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The last updated by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeTierId":{
            "type":"integer",
            "description":"The charge tier ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The created by",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalNumberFour":{
            "title":"Additional Number Four",
            "type":"number",
            "description":"The additional number four",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampOne":{
            "title":"Additional Time-stamp One",
            "type":"string",
            "description":"The additional timestamp one",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PriceFormat":{
            "title":"Price Format",
            "maxLength":"30",
            "type":"string",
            "description":"The price format",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalTextOne":{
            "title":"Additional Text One",
            "maxLength":"4000",
            "type":"string",
            "description":"The additional text one",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberSix":{
            "title":"Additional Number Six",
            "type":"number",
            "description":"The additional number six",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalNumberOne":{
            "title":"Additional Number One",
            "type":"number",
            "description":"The additional number one",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTextTwo":{
            "title":"Additional Text Two",
            "maxLength":"4000",
            "type":"string",
            "description":"The additional text two",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalTimestampThree":{
            "title":"Additional Time-stamp Three",
            "type":"string",
            "description":"The additional timestamp three",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"The charge ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BlockSize":{
            "title":"Block Size",
            "type":"number",
            "description":"The block size",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The last update login",
            "nullable":true,
            "readOnly":true,
            "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 : subscriptions-products-coveredLevels-childCoveredLevels-item-response

Type: object

Show Source

• Address: string
  Title: Address

  The address of the party site associated with child covered level.
• AssetGroupId: integer (int64)
  The unique identifier of the asset group.
• AssetGroupName: string
  Title: Asset Group Name

  The name of the asset group.
• AssetGroupNumber: string
  Title: Asset Group Number

  The alternate identifier of an asset group.
• AssetId: integer (int64)
  The unique identifier of the asset.
• AssetName: string
  Title: Covered Level Asset Name

  The name of the asset.
• AssetSerialNumber: string
  Title: Covered Asset Serial Number

  The universal serial number associated with the asset.
• CalculatedCreditAmount: number
  Title: Calculated Credit Amount

  The calculated credit amount of the child covered level.
• CancelDescription: string
  Title: Cancellation Description

  Maximum Length: 2000

  The cancel description associated with a child covered level.
• CanceledAmount: number
  The amount that was cancelled.
• CanceledDate: string (date)
  Title: Canceled Date

  The date of cancellation.
• CancelReason: string
  Title: Cancellation Reason

  Maximum Length: 30

  The reason for cancellation.
• ClosedAmount: number
  The amount when the covered level was closed.
• ClosedDate: string (date)
  Title: Covered Level Close Date

  The date when the covered level was closed.
• CloseDescription: string
  Title: Covered Level Close Description

  Maximum Length: 2000

  The close description associated with a child covered level.
• CloseReason: string
  Title: Covered Level Close Reason

  Maximum Length: 30

  The reason when the covered level was closed.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CoveredLevelId: integer (int64)
  The unique identifier of the covered level.
• CoveredLevelName: string
  Title: Covered Level Name

  Maximum Length: 300

  The name of the covered level.
• CoveredLevelParentPuid: string
  The covered parent for the parent.
• CoveredLevelPuid: string
  Maximum Length: 120

  The public unique identifier of the covered level.
• CoveredLevlName: string
  Title: Covered Level Name

  The name of the covered level associated with child covered level.
• CoveredLevlNumber: string
  Title: Covered Level Number

  The alternate identifier of the covered level associated with child covered level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• CreditedAmount: number
  The credited amount for the covered level.
• CurcyConvRateType: string
  Maximum Length: 30

  The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Maximum Length: 15

  The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CustomerAccountId: integer (int64)
  The unique identifier of the customer account associated with child covered level.
• CustomerName: string
  Title: Customer Account

  The name of the customer associated with child covered level.
• CustomerNumber: string
  Title: Customer Account Number

  The alternate unique identifier of the customer associated with child covered level.
• Description: string
  Title: Covered Level Description

  The description of the covered level.
• Duration: integer
  The duration for which the covered level is active.
• EndDate: string (date)
  Title: Covered Level End Date

  The end date for the covered level.
• ExplodeAssetHierarchy: string
  The explode hierarchy for the asset.
• GenerateBillingSchedule: string
  The schedule by the bill is generated.
• HierarchyTotal: number
  The total when the covered level was closed.
• InventoryItemId: integer (int64)
  The unique identifier of the inventory item.
• InvoicedAmount: number
  The invoiced amount.
• InvoiceText: string
  Maximum Length: 2000

  The text to be included in the invoice.
• ItemUnitOfMeasure: string
  Maximum Length: 15

  The unit of measure used by the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• LineNumber: string
  Title: Number

  Maximum Length: 300

  The line number.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OverrideCreditAmount: number
  Title: Override Credit Amount

  The override credit amount of the child covered level.
• ParentCoveredAssetId: integer (int64)
  The unique identifier of the parent covered asset.
• ParentCoveredLevelId: integer (int64)
  The parent level for the level.
• PartyId: integer (int64)
  The unique identifier of the party associated with child covered level.
• PartyName: string
  Title: Party Name

  The name of the party associated with child covered level.
• PartyNumber: string
  Title: Party Number

  The alternate identifier of the party associated with child covered level.
• PartySite: string
  Title: Party Site Number

  The name of the party site associated with child covered level.
• PartySiteId: integer (int64)
  The unique identifier of the party site associated with child covered level.
• Period: string
  Maximum Length: 80

  The period during which the covered level is used.
• PriceAsOf: string (date)
  The price of the covered level.
• PriceListId: integer (int64)
  The unique identifier of the price list.
• PriceUnitOfMeasure: string
  Maximum Length: 30

  The unit of measure used by the item.
• PriceUnitOfMeasureName: string
  Title: Pricing UOM

  The name of the unit of measure.
• PricingError: string
  Maximum Length: 1000

  Any errors associated with the pricing.
• ProductGroupId: integer (int64)
  The unique identifier of the product group.
• ProductGroupName: string
  Title: Product Group Name

  The name of the product group.
• ProductGroupNumber: string
  Title: Product Group Number

  The alternate identifier of a product group.
• ProductName: string
  Title: Product Name

  The name of the product.
• PutOnHoldFlag: boolean
  Indicates if the covered level has been put on hold.
• Quantity: number
  Title: Quantity

  Default Value: 1

  The quantity for which the bill line was charged.
• RemoveHoldFlag: boolean
  Indicates if the covered level's hold has to be removed.
• RenewalType: string
  Title: Renewal Type

  Maximum Length: 30

  The type of renewal.
• RenewedDate: string (date)
  The date when the covered level was renewed.
• RepriceFlag: boolean
  Indicates whether the subscription child covered level should be repriced or not. If passed as 'true', the subscription child covered level will be repriced.
• ReturnCreditMethod: string
  Title: Close Credit Method

  Maximum Length: 230

  The return method for the credit after the covered level was closed.
• RevenueOption: string
  Title: Revenue Accounting Option

  Maximum Length: 30

  Revenue Option
• RollupTotal: number
  The total when the covered level was closed.
• SerialNumber: string
  Title: Covered Asset Serial Number

  Read Only: true

  Maximum Length: 80

  The serial number of the child covered level.
• SourceKey: string
  Maximum Length: 120

  The source key of the child covered level.
• SourceLineKey: string
  Maximum Length: 120

  The source line key of the child covered level.
• SourceLineNumber: string
  Maximum Length: 120

  The source line number of the child covered level.
• SourceNumber: string
  Maximum Length: 120

  The source number of the child covered level.
• SourceSystem: string
  Maximum Length: 30

  The source system of the child covered level.
• StartDate: string (date)
  Title: Covered Level Start Date

  The start date for the covered level.
• Status: string
  Title: Covered Level Status

  Maximum Length: 30

  The status of the covered level.
• StatusName: string
  Title: Status

  The description of the status.
• SubscriptionId: integer (int64)
  The unique identifier of the associated subscription.
• SubscriptionProductId: integer (int64)
  The unique identifier of the subscription product.
• SuppressedCreditAmount: number
  The suppressed amount for the credit.
• SuspendCreditMethod: string
  Maximum Length: 30

  The suspend method for the credit after the covered level was closed.
• SuspendedDate: string (date)
  Title: Covered Level Suspend Date

  The date when the covered level was suspended.
• SuspendReason: string
  Title: Covered Level Suspend Reason

  Maximum Length: 30

  The reason when the covered level was suspended.
• TaxAmount: number
  The amount of tax to be deducted.
• TaxError: string
  Maximum Length: 4000

  The tax error for the covered level.
• TotalContractValue: number
  Title: Covered Level Contract Value

  The total contract value
• Type: string
  Title: Type

  Maximum Length: 30

  The type of the covered level.
• TypeName: string
  Title: Covered Level Type

  The type name associated with the covered level.
• UnitPrice: number
  Title: Unit Price

  The unit price of the covered level associated with child covered level.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeName":{
            "title":"Covered Level Type",
            "type":"string",
            "description":"The type name associated with the covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CalculatedCreditAmount":{
            "title":"Calculated Credit Amount",
            "type":"number",
            "description":"The calculated credit amount of the child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductName":{
            "title":"Product Name",
            "type":"string",
            "description":"The name of the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Address":{
            "title":"Address",
            "type":"string",
            "description":"The address of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentCoveredLevelId":{
            "type":"integer",
            "description":"The parent level for the level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "type":"string",
            "description":"The name of the party associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CancelDescription":{
            "title":"Cancellation Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The cancel description associated with a child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group Name",
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RollupTotal":{
            "type":"number",
            "description":"The total when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendCreditMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"The suspend method for the credit after the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Covered Level Start Date",
            "type":"string",
            "description":"The start date for the covered level.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentCoveredAssetId":{
            "type":"integer",
            "description":"The unique identifier of the parent covered asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaxAmount":{
            "type":"number",
            "description":"The amount of tax to be deducted.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The source key of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CloseReason":{
            "title":"Covered Level Close Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason when the covered level was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerNumber":{
            "title":"Customer Account Number",
            "type":"string",
            "description":"The alternate unique identifier of the customer associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CoveredLevelParentPuid":{
            "type":"string",
            "description":"The covered parent for the parent.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The source number of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the party site associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CanceledDate":{
            "title":"Canceled Date",
            "type":"string",
            "description":"The date of cancellation.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExplodeAssetHierarchy":{
            "type":"string",
            "description":"The explode hierarchy for the asset.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetGroupId":{
            "type":"integer",
            "description":"The unique identifier of the asset group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemUnitOfMeasure":{
            "maxLength":"15",
            "type":"string",
            "description":"The unit of measure used by the item.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Covered Level Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoveredLevelName":{
            "title":"Covered Level Name",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetGroupNumber":{
            "title":"Asset Group Number",
            "type":"string",
            "description":"The alternate identifier of an asset group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreditedAmount":{
            "type":"number",
            "description":"The credited amount for the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "Period":{
            "maxLength":"80",
            "type":"string",
            "description":"The period during which the covered level is used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Duration":{
            "type":"integer",
            "description":"The duration for which the covered level is active.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusName":{
            "title":"Status",
            "type":"string",
            "description":"The description of the status.",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalType":{
            "title":"Renewal Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of renewal.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssetName":{
            "title":"Covered Level Asset Name",
            "type":"string",
            "description":"The name of the asset.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AssetSerialNumber":{
            "title":"Covered Asset Serial Number",
            "type":"string",
            "description":"The universal serial number associated with the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelReason":{
            "title":"Cancellation Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason for cancellation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SuppressedCreditAmount":{
            "type":"number",
            "description":"The suppressed amount for the credit.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Covered Asset Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"The serial number of the child covered level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceUnitOfMeasureName":{
            "title":"Pricing UOM",
            "type":"string",
            "description":"The name of the unit of measure.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PriceListId":{
            "type":"integer",
            "description":"The unique identifier of the price list.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReturnCreditMethod":{
            "title":"Close Credit Method",
            "maxLength":"230",
            "type":"string",
            "description":"The return method for the credit after the covered level was closed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InvoicedAmount":{
            "type":"number",
            "description":"The invoiced amount.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendedDate":{
            "title":"Covered Level Suspend Date",
            "type":"string",
            "description":"The date when the covered level was suspended.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLineNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The source line number of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredLevlNumber":{
            "title":"Covered Level Number",
            "type":"string",
            "description":"The alternate identifier of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "type":"string",
            "description":"The alternate identifier of a product group.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetGroupName":{
            "title":"Asset Group Name",
            "type":"string",
            "description":"The name of the asset group.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Covered Level Description",
            "type":"string",
            "description":"The description of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CanceledAmount":{
            "type":"number",
            "description":"The amount that was cancelled.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceAsOf":{
            "type":"string",
            "description":"The price of the covered level.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Number",
            "maxLength":"300",
            "type":"string",
            "description":"The line number.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySite":{
            "title":"Party Site Number",
            "type":"string",
            "description":"The name of the party site associated with child covered level.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InvoiceText":{
            "maxLength":"2000",
            "type":"string",
            "description":"The text to be included in the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the associated subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CoveredLevelPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the covered level.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RevenueOption":{
            "title":"Revenue Accounting Option",
            "maxLength":"30",
            "type":"string",
            "description":"Revenue Option",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TaxError":{
            "maxLength":"4000",
            "type":"string",
            "description":"The tax error for the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Customer Account",
            "type":"string",
            "description":"The name of the customer associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceLineKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The source line key of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RepriceFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription child covered level should be repriced or not. If passed as 'true', the subscription child covered level will be repriced.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewedDate":{
            "type":"string",
            "description":"The date when the covered level was renewed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TotalContractValue":{
            "title":"Covered Level Contract Value",
            "type":"number",
            "description":"The total contract value",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendReason":{
            "title":"Covered Level Suspend Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason when the covered level was suspended.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity for which the bill line was charged.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PriceUnitOfMeasure":{
            "maxLength":"30",
            "type":"string",
            "description":"The unit of measure used by the item.",
            "nullable":true,
            "x-queryable":true
        },
        "HierarchyTotal":{
            "type":"number",
            "description":"The total when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Covered Level End Date",
            "type":"string",
            "description":"The end date for the covered level.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClosedAmount":{
            "type":"number",
            "description":"The amount when the covered level was closed.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevlName":{
            "title":"Covered Level Name",
            "type":"string",
            "description":"The name of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideCreditAmount":{
            "title":"Override Credit Amount",
            "type":"number",
            "description":"The override credit amount of the child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the covered level.",
            "nullable":false,
            "x-queryable":true
        },
        "PutOnHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level has been put on hold.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The alternate identifier of the party associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"The unit price of the covered level associated with child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "GenerateBillingSchedule":{
            "type":"string",
            "description":"The schedule by the bill is generated.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party associated with child covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RemoveHoldFlag":{
            "type":"boolean",
            "description":"Indicates if the covered level's hold has to be removed.",
            "nullable":true,
            "x-queryable":false
        },
        "ClosedDate":{
            "title":"Covered Level Close Date",
            "type":"string",
            "description":"The date when the covered level was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PricingError":{
            "maxLength":"1000",
            "type":"string",
            "description":"Any errors associated with the pricing.",
            "nullable":true,
            "x-queryable":true
        },
        "CloseDescription":{
            "title":"Covered Level Close Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The close description associated with a child covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":"30",
            "type":"string",
            "description":"The source system of the child covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 : subscriptions-products-coveredLevels-relationships-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

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

  The object version number.
• OperationLinksPuid: string
  Maximum Length: 120

  The operation links PUID.
• RelationshipTypeCode: string
  Maximum Length: 30

  The relationship type code.
• SourceAssetKey: string
  Maximum Length: 120

  The source asset key.
• SourceProdAssociationId: integer (int64)
  The unique identifier of the source product association.
• SourceProdAssociationPuid: string
  Maximum Length: 120

  The source product association PUID.
• SourceProductPuid: string
  Maximum Length: 120

  The source product PUID.
• SourceRootAssetKey: string
  Maximum Length: 120

  The source root asset key.
• TargetProdAssociationId: integer (int64)
  The unique identifier of the target product association.
• TargetProdAssociationPuid: string
  Maximum Length: 120

  The target product association PUID.
• TargetProductPuid: string
  Maximum Length: 120

  The target product PUID.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceProdAssociationId":{
            "type":"integer",
            "description":"The unique identifier of the source product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TargetProdAssociationId":{
            "type":"integer",
            "description":"The unique identifier of the target product association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceAssetKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The source asset key.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProductPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The source product PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The relationship type code.",
            "nullable":false,
            "x-queryable":true
        },
        "OperationLinksPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The operation links PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceRootAssetKey":{
            "maxLength":"120",
            "type":"string",
            "description":"The source root asset key.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceProdAssociationPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The source product association PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProductPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The target product PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetProdAssociationPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The target product association PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "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"
    }
}

Back to Top

Examples

The following example shows how to get all covered levels by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/GP-5678/child/products/GP-5678-PRDT-7/child/coveredLevels

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "items": [
        {
            "CoveredLevelId": 300100177231548,
            "CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1",
            "SubscriptionProductId": 300100177231547,
            "SubscriptionId": 300100177254423,
            "LineNumber": "1",
            "InventoryItemId": 300100118490672,
            "AssetId": 300100118585763,
            "AssetName": "zOKC_Auto_Asset1",
            "AssetSerialNumber": null,
            "ProductName": "ZOKC_Item_001",
            "Description": "Item",
            "Type": "ORA_ASSET",
            "TypeName": "Asset",
            "Quantity": 1,
            "ItemUnitOfMeasure": "Ea",
            "TotalContractValue": 12361.29,
            "GenerateBillingSchedule": null,
            "EndDate": "2019-12-25",
            "StartDate": "2019-01-01",
            "Duration": 359,
            "Period": "DY",
            "Status": "ORA_DRAFT",
            "StatusName": "Draft",
            "PriceAsOf": "2019-01-01",
            "PriceUnitOfMeasure": "0zE",
            "PriceUnitOfMeasureName": "YEAR",
            "PriceListId": 300100071623855,
            "PricingError": null,
            "TaxAmount": 2472.26,
            "InvoiceText": null,
            "CancelReason": null,
            "CanceledDate": null,
            "CanceledAmount": null,
            "ClosedDate": null,
            "CloseReason": null,
            "ClosedAmount": null,
            "ReturnCreditMethod": null,
            "SuppressedCreditAmount": null,
            "InvoicedAmount": null,
            "CreditedAmount": null,
            "RenewedDate": null,
            "RenewalType": null,
            "TaxError": null,
            "CreatedBy": "CONMGR",
            "CreationDate": "2019-06-04T17:55:14.831+00:00",
            "LastUpdatedBy": "CONMGR",
            "LastUpdateDate": "2019-06-04T17:56:01.036+00:00",
            "LastUpdateLogin": "8A568A7FD0B9BE1EE05323EAF40A0287",
            "CurrencyCode": null,
            "CorpCurrencyCode": null,
            "CurcyConvRateType": null,
            "PutOnHoldFlag": null,
            "RemoveHoldFlag": null,
            ...
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    ...
}

Back to Top