Get all bill lines
get
/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines
Request
Path Parameters
-
CoveredLevelPuid(required): string
The public unique identifier of the covered level.
-
SubscriptionProductPuid(required): string
The public unique identifier of the subscription product.
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 a subscription bill line with the specified Bill Line PUID.
Finder Variables:- BillLinePuid; string; The public unique identifier of the bill line.
- PrimaryKey: Finds a subscription bill line with the specified Bill Line ID.
Finder Variables:- BillLineId; integer; The unique identifier of the bill line.
- BillLinePuid: Finds a 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 for which the bill is generated.
- BillLineId; integer; The unique identifier of the bill line.
- BillLinePuid; string; The public unique identifier of the bill line.
- BillingPeriod; number; The period for which the bill is generated.
- 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 associated with the bill line.
- ChargePeriod; number; The usage period that was charged.
- ChargePeriodFactor; number; The change period factor associated with the bill line.
- ChargePuid; string; The public unique identifier of the charge.
- CoveredLevelId; integer; The unique identifier of the covered level.
- CreatedBy; string; The user who created the billing line.
- CreationDate; string; The date when the billing line was created.
- CreditMemoReasonCode; string; The code of the credit memo reason code.
- CustomerTrxTypeSequenceId; integer; Customer Transaction Type Sequence Id
- DateBilledFrom; string; The date from which the bill was generated.
- DateBilledTo; string; The date up to which the bill is generated.
- DateToInterface; string; The date to interface for the bill line.
- InterfacedFlag; boolean; Indicates whether the bill line is interfaced or not.
- InvoiceBillLineId; integer; The unique identifier of the invoice bill line.
- InvoiceDate; string; The date when the invoice was raised.
- InvoiceText; string; The text in the bill line invoice.
- LastUpdateDate; string; The date when the billing line was last updated.
- LastUpdateLogin; string; The login details of the user who last updated the billing line.
- LastUpdatedBy; string; The user who last updated the billing line.
- ListPrice; number; The list price of the product associated with the bill line.
- 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 error in pricing, if any.
- RecurringFlag; boolean; Indicates whether the 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 for which the transaction occurred.
- TransactionClass; string; The class of the transaction.
- TransactionClassMeaning; string; The meaning of transaction class lookup.
- TransactionDate; string; The date when the transaction occurred.
- TransactionNumber; string; The number of the transaction.
- TransactionTax; number; The tax levied on the transaction.
- TruedUpYn; string; Indicates if the bill line has a trueup period.
- TrxId; integer; The AR transaction ID.
- TrxLineId; integer; The AR transaction line ID.
- UsageAcquiredFlag; boolean; Indicates whether the usage has been acquired or not.
- UsageCaptureDate; string; The date when the usage was captured.
- 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 the usage line has been priced or not.
- UsageQuantity; number; The quantity of the usage.
-
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 : subscriptionProducts-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 : subscriptionProducts-coveredLevels-billLines-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount for which the bill is generated. -
billAdjustments: array
Bill Adjustments
Title:
Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity. -
BillingPeriod: number
Title:
Sequence
The period for which the bill is generated. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
BillLinePuid: string
Maximum Length:
120
The public unique identifier of the bill line. -
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 associated with the bill line. -
ChargePeriod: number
Title:
Period
The usage period that was charged. -
ChargePeriodFactor: number
The change period factor associated with the bill line.
-
ChargePuid: string
Read Only:
true
The public unique identifier of the charge. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the billing line. -
CreationDate: string
(date-time)
Read Only:
true
The date when the billing 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)
Customer Transaction Type Sequence Id
-
DateBilledFrom: string
(date)
Title:
Bill-from Date
The date from which the bill was generated. -
DateBilledTo: string
(date)
Title:
Bill-to Date
The date up to which the bill is generated. -
DateToInterface: string
(date)
Title:
Interface Date
The date to interface for the bill line. -
InterfacedFlag: boolean
Title:
Interfaced
Maximum Length:1
Default Value:false
Indicates whether the bill line is interfaced or not. -
InvoiceBillLineId: integer
(int64)
The unique identifier of the invoice bill line.
-
InvoiceDate: string
(date)
The date when the invoice was raised.
-
InvoiceText: string
Title:
Invoice Text
Maximum Length:240
The text in the bill line invoice. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the billing line was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the billing line. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the billing line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
The list price of the product associated with the bill line.
-
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 error in pricing, if any. -
RecurringFlag: boolean
Maximum Length:
1
Indicates whether the 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 for which the transaction occurred. -
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 when the transaction occurred. -
TransactionNumber: string
Title:
Invoice Number
Maximum Length:30
The number of the transaction. -
TransactionTax: number
Title:
Tax
The tax levied on the transaction. -
TransactionTypeName: string
The transaction type name of the subscription bill line.
-
TruedUpYn: string
Maximum Length:
3
Indicates if the bill line has a trueup period. -
TrxId: integer
(int64)
The AR transaction ID.
-
TrxLineId: integer
(int64)
The AR transaction line ID.
-
UsageAcquiredFlag: boolean
Maximum Length:
1
Indicates whether the usage has been acquired or not. -
UsageCaptureDate: string
(date)
The date when the usage was captured.
-
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 the usage line has been priced or not. -
UsageQuantity: number
Title:
Usage Quantity
The quantity of the usage.
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, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response
Type:
Show Source
object
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The basis on which the bill is adjusted. -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The name of the bill adjustment. -
AdjustmentReasonCode: string
Maximum Length:
30
The code of the adjustment reason. -
AdjustmentType: string
Title:
Type
Maximum Length:30
The type of the bill adjustment. -
AdjustmentValue: number
Title:
Value
The value by which the bill is adjusted. -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Indicates whether the adjustment is automatic or not. -
BasisEnableFlag: boolean
Indicates if the base has been enabled for the bill adjustment.
-
BillAdjustmentId: integer
(int64)
The unique identifier of the bill adjustment.
-
BillAdjustmentPuid: string
Maximum Length:
120
The public unique identifier of the bill adjustment. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
ChargeAdjustmentId: integer
(int64)
The unique identifier of the charge adjustment.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the bill adjustment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the bill adjustment was created. -
CurrencyCode: string
The current code used for the bill adjustment.
-
Effectivity: string
Maximum Length:
30
The effectivity of the bill adjustment. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the bill adjustment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the bill adjustment. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the bill adjustment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
PeriodFrom: number
The period from which the bill was adjusted.
-
PeriodUntil: number
The period until which the bill is adjusted.
-
Reason: string
Title:
Reason Details
Maximum Length:120
The reason why the bill is adjusted. -
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 of the bill adjustment. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
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.