Get all subscription bill lines
get
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines
Request
Path Parameters
-
CoveredLevelPuid(required): string
The covered level PUID
-
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:- BillLinePuid: Finds the subscription bill line with the specified bill line PUID.
Finder Variables:- BillLinePuid; string; The unique public identifier of the specified bill line.
- PrimaryKey: Finds the subscription bill line with the specified bill line ID.
Finder Variables:- BillLineId; integer; The unique primary identifier of the specified bill line.
- BillLinePuid: Finds the subscription bill line with the specified bill line PUID.
-
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:- Amount; number; The amount of the bill.
- BillLineId; integer; The unique identifier of the bill line.
- BillLinePuid; string; The bill line PUID.
- BillingPeriod; number; The billing period.
- ChargeDefinition; string; The definition that indicates the purpose of the charge.
- ChargeId; integer; The unique identifier of the charge.
- ChargeName; string; The name of the charge.
- ChargePeriod; number; The charge period.
- ChargePeriodFactor; number; The change period factor associated with the bill line.
- ChargePuid; string; The charge PUID.
- CoveredLevelId; integer; The unique identifier of the coverage level.
- CreatedBy; string; The user who created the bill line.
- CreationDate; string; The date when the bill line was created.
- CreditMemoReasonCode; string; The code of the credit memo reason code.
- CustomerTrxTypeSequenceId; integer; The unique identifier of the customer transaction type sequence.
- DateBilledFrom; string; The date from which the billing is done.
- DateBilledTo; string; The date to which the billing is done.
- DateToInterface; string; The date to interface.
- InterfacedFlag; boolean; Indicates whether the bill line is interfaced or not.
- InvoiceBillLineId; integer; The invoice bill line ID.
- InvoiceDate; string; The date when the invoice was raised.
- InvoiceText; string; The invoice text of the transaction.
- LastUpdateDate; string; The date when the bill line was last updated.
- LastUpdateLogin; string; The login of the user who last updated the bill line.
- LastUpdatedBy; string; The user who last updated the bill line.
- ListPrice; number; The list price.
- MilestoneEventId; integer; The ID of the milestone event associated with the bill line.
- PricedQuantity; number; The quantity for which the bill line was charged.
- PricingError; string; The pricing error.
- RecurringFlag; boolean; Indicates whether this line is recurring or not.
- RetrieveInvoiceFlag; boolean; Retrieve Invoice Flag
- RevenueLineId; integer; The unique identifier of the revenue line.
- RevenueOption; string; Revenue Option
- RevenuePeriod; string; Revenue Period
- SentDate; string; The date invoice information is sent to receivables.
- SubscriptionId; integer; The unique identifier of the subscription.
- SubscriptionProductId; integer; The unique identifier of the subscription product.
- SummarizedBillLineId; integer; Summarized Bill Line ID
- TransactionAmount; number; The amount of the transaction.
- TransactionClass; string; The class of the transaction.
- TransactionClassMeaning; string; The meaning of transaction class lookup.
- TransactionDate; string; The date of the transaction.
- TransactionNumber; string; The alternate identifier of the transaction.
- TransactionTax; number; The tax related to the transaction.
- TruedUpYn; string; Indicates whether the bill line has a true up period.
- TrxId; integer; The transaction identifier associated with the billing.
- TrxLineId; integer; The unique identifier of the transaction line.
- UsageAcquiredFlag; boolean; Indicates whether the usage has been acquired or not.
- UsageCaptureDate; string; The usage capture date.
- UsageChargeType; string; The type of usage charge.
- UsageChargeTypeName; string; The name of the usage charge type.
- UsageFlag; boolean; Indicates whether the line is a usage line or not.
- UsagePricedFlag; boolean; Indicates whether usage line has been priced or not.
- UsageQuantity; number; The usage quantity.
-
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 TopResponse
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.
Root Schema : subscriptions-products-coveredLevels-billLines
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-coveredLevels-billLines-item-response
Type:
Show Source
object
-
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.
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-coveredLevels-billLines-billAdjustments-item-response
Type:
Show Source
object
-
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.