Create a bill line
post
/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/billLines
Request
Path Parameters
-
SubscriptionProductPuid(required): string
The public unique identifier of the subscription product.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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(required): number
Title:
Sequence
The period for which the bill is generated. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
BillLinePuid(required): 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.
-
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
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(required): string
(date)
Title:
Bill-from Date
The date from which the bill was generated. -
DateBilledTo(required): 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. -
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(required): 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 : schema
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.
-
CurrencyCode: string
The current code used for the bill adjustment.
-
Effectivity: string
Maximum Length:
30
The effectivity of the bill adjustment. -
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.
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.
Root Schema : subscriptionProducts-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-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.
Links
- billAdjustments
-
Parameters:
- BillLinePuid:
$request.path.BillLinePuid
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
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. - BillLinePuid:
Examples
The following example shows how to create a bill line by submitting a POST request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/300100182015426/child/billLines
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "BillLinePuid": "GP-5678-PRDT-1-BILL-309", "ChargeId": 300100177231506, "BillingPeriod": 0, "DateToInterface": "2019-06-04", "DateBilledFrom": "2019-01-01", "DateBilledTo": "2019-12-25", "Amount": 2600, "RecurringFlag": false, "UsageFlag": false, "UsagePricedFlag": true, "InterfacedFlag": false, "TransactionClass": "INV", "InvoiceText": "[$Item Name]: Activation Fee 2019-01-01-2019-12-25", "ChargePeriod": 0, "ListPrice": 3000 }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "BillLineId": 300100192686411, "BillLinePuid": "GP-5678-PRDT-1-BILL-309", "SubscriptionId": 300100181994494, "SubscriptionProductId": 300100192686405, "CoveredLevelId": null, "ChargeId": 300100177231506, "ChargePuid": null, "BillingPeriod": 0, "DateToInterface": "2019-06-04", "DateBilledFrom": "2019-01-01", "DateBilledTo": "2019-12-25", "Amount": 2600, "RecurringFlag": false, "UsageFlag": false, "UsageAcquiredFlag": null, "UsagePricedFlag": true, "InterfacedFlag": false, "TransactionClass": "INV", "TransactionDate": null, "TransactionNumber": null, "TransactionTax": null, "TransactionAmount": null, "InvoiceText": "[$Item Name]: Activation Fee 2019-01-01-2019-12-25", "InvoiceBillLineId": null, "UsageCaptureDate": null, "UsageQuantity": null, "ChargePeriod": 0, "PricingError": null, "ListPrice": 3000, "RevenueLineId": null, "CreatedBy": "SALES_ADMIN", "CreationDate": "2019-08-20T07:24:12+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateDate": "2019-08-20T07:24:12.100+00:00", "LastUpdateLogin": "9062D47DF31EDAF6E0533EFDF40A2696", "TransactionClassMeaning": "Invoice", "InvoiceDate": null, "NewCreditMemoPUID": null, "CreditMemoAmount": null, "CreditMemoFlag": null, "CreditMemoReason": null, "links": ... }